Unless otherwise indicated, this type must be usable in all Jakarta EE containers, specifically the Jakarta Servlet and Jakarta Enterprise Beans containers.
| Modifier and Type | Method and Description |
|---|---|
| public AuthenticationStatus | Returns: The state of the authentication mechanism after being triggered by this callThe request, HttpServletResponse HttpServletRequest associated with the current web resource invocation.The response, AuthenticationParameters HttpServletResponse associated with the given HttpServletRequest.The parameters that are provided along with a programmatic authentication request, for instance the credentials.
collected by the application for continuing an authentication dialog. parameters)Signal to the container (programmatically trigger) that it should start or continue a web/HTTP based authentication dialog with the caller. |
| public Principal | Returns: Principal representing the name of the current authenticated user, or null if not authenticated.Retrieve the platform-specific |
| public < The actual type represented by the T extends Principal> SetpType argument | Returns: Set of Principals of the given type, or an empty set.Class object representing the type of Principal to return. pType)Retrieve all Principals of the given type from the authenticated caller's Subject, or an empty set if the current caller is not authenticated, or if the specified type isn't found in the Subject. |
| public boolean | Returns: true if the caller has access to the web resource using one of the given methods, false otherwise.the name of the web resource to test access for. This is a resource, String... URLPatternSpec that
identifies the application specific web resources to which the permission pertains. For a full specification of this
pattern see jakarta.security.jacc.WebResourcePermission#WebResourcePermission(String, String).one or more methods to check for whether the caller has access to the web resource using one of those methods. methods)Checks whether the caller has access to the provided "web resource" using the given methods, as specified by section 13.8 of the Servlet specification. |
| public boolean | Returns: true if the authenticated caller is in the given role, false if the caller is not authentication or
is not in the given role.a role)String specifying the name of the logical application roleChecks whether the authenticated caller is included in the specified logical application "role". |
| authenticate | back to summary |
|---|---|
| public AuthenticationStatus authenticate(HttpServletRequest request, HttpServletResponse response, AuthenticationParameters parameters) Signal to the container (programmatically trigger) that it should start or continue a web/HTTP based authentication dialog with the caller.
Programmatically triggering means that the container responds as if the caller had attempted to access a constrained resource
and acts by invoking a configured authentication mechanism (such as the
Whether the authentication dialog is to be started or continued depends on the (logical) state of the authentication dialog. If
such dialog is currently in progress, a call to this method will continue it. If such dialog is not in progress a new one will be
started. A new dialog can be forced to be started regardless of one being in progress or not by providing a value of
This method requires an
| |
| getCallerPrincipal | back to summary |
|---|---|
| public Principal getCallerPrincipal() Retrieve the platform-specific
| |
| getPrincipalsByType | back to summary |
|---|---|
| public <T extends Principal> Set Retrieve all Principals of the given type from the authenticated caller's Subject, or an empty set if the current caller is not authenticated, or if the specified type isn't found in the Subject. This can be used to retrieve application-specific Principals when the platform's representation of the caller uses a different principal type. The returned Set is not backed by the Subject's internal Principal Set. A new Set is created and returned for each method invocation. Modifications to the returned Set will not affect the internal Principal Set. | |
| hasAccessToWebResource | back to summary |
|---|---|
| public boolean hasAccessToWebResource(String resource, String... methods) Checks whether the caller has access to the provided "web resource" using the given methods, as specified by section 13.8 of the Servlet specification. A caller has access if the web resource is either not protected (constrained), or when it is protected by a role and the caller is in that role.
| |
| isCallerInRole | back to summary |
|---|---|
| public boolean isCallerInRole(String role) Checks whether the authenticated caller is included in the specified logical application "role".
If the caller is not authenticated, this always returns
This method can not be used to test for roles that are mapped to specific named Jakarta Servlets or
named Jakarta Enterprise Beans. For a Servlet an example of this would be the
Should code in either such Jakarta Servlet or Jakarta Enterprise Bean wish to take such mapped (aka referenced, linked)
roles into account, the facilities for that specific container should be used instead. For instance for Servlet that
would be
| |