javax.ws.rs.core

Interface SecurityContext

Contents

  • public interface SecurityContext
    An injectable interface that provides access to security related information.
    Since:
    1.0
    Author:
    Paul Sandoz, Marc Hadley
    See Also:
    Context

    • Field Detail

      • CLIENT_CERT_AUTH

        static final String CLIENT_CERT_AUTH
        String identifier for Client Certificate authentication. Value "CLIENT_CERT"
        See Also:
        Constant Field Values

      • DIGEST_AUTH

        static final String DIGEST_AUTH
        String identifier for Digest authentication. Value "DIGEST"
        See Also:
        Constant Field Values

    • Method Detail

      • getUserPrincipal

        Principal getUserPrincipal()
        Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.
        Returns:
        a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated
        Throws:
        IllegalStateException - if called outside the scope of a request

      • isUserInRole

        boolean isUserInRole(String role)
        Returns a boolean indicating whether the authenticated user is included in the specified logical "role". If the user has not been authenticated, the method returns false.
        Parameters:
        role - a String specifying the name of the role
        Returns:
        a boolean indicating whether the user making the request belongs to a given role; false if the user has not been authenticated
        Throws:
        IllegalStateException - if called outside the scope of a request

      • isSecure

        boolean isSecure()
        Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
        Returns:
        true if the request was made using a secure channel, false otherwise
        Throws:
        IllegalStateException - if called outside the scope of a request

      • getAuthenticationScheme

        String getAuthenticationScheme()
        Returns the string value of the authentication scheme used to protect the resource. If the resource is not authenticated, null is returned. Values are the same as the CGI variable AUTH_TYPE
        Returns:
        one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.
        Throws:
        IllegalStateException - if called outside the scope of a request

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/core/SecurityContext.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, SecurityContext (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.