public enum AuthenticationStatus extends Enum<AuthenticationStatus>
HttpAuthenticationMechanism
to indicate the result (status)
of the authentication process.
For the result from HttpAuthenticationMechanism.validateRequest(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.security.enterprise.authentication.mechanism.http.HttpMessageContext)
an AuthenticationStatus must be transformed by the Jakarta EE server into the corresponding Jakarta Authentication AuthStatus
according to the following rules:
After the transformation as outlined above the transformed result has to be processed by the Jakarta EE server as specified by the Servlet Container Profile of the Jakarta Authentication spec.
Implementation note: while the Jakarta Authentication Servlet Container Profile is the authoritative
source on how to process the AuthStatus.SUCCESS
result and this specification puts no constraints
of any kind on that, the expectation is that Jakarta EE servers in practice will mainly look at the
result being AuthStatus.SUCCESS
or not AuthStatus.SUCCESS
. Simply said, if the result is
AuthStatus.SUCCESS
the authenticated identity (if any) must be set (established) for the current HTTP request,
otherwise not.
The return value of SecurityContext.authenticate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.security.enterprise.authentication.mechanism.http.AuthenticationParameters)
, which is also of type AuthenticationStatus, strongly relates to the outcome of the HttpAuthenticationMechanism#validateRequest
method as described above, but must be transformed by the Jakarta EE server from the corresponding outcome of the
HttpServletRequest.authenticate(javax.servlet.http.HttpServletResponse)
call as follows:
true
to AuthenticationStatus.SUCCESS
false
to [last status]
(see below) ServletException
or IOException
to AuthenticationStatus.SEND_FAILURE
When an HttpAuthenticationMechanism
was used [last status]
must be
the value returned by HttpAuthenticationMechanism#validateRequest
.
When a Jakarta Authentication ServerAuthModule (SAM) was used and an HttpAuthenticationMechanism
was not used Jakarta EE servers are encouraged, but not required, to set [last status]
to the value returned by ServerAuthModule#validateRequest
transformed as follows:
When a Jakarta EE Server proprietary identity store equivalent was used and an
HttpAuthenticationMechanism
was not used
Jakarta EE servers are encouraged, but not required, to set [last status]
to a value
that logically corresponds to the description of each enum constant of AuthenticationStatus. This outcome
should never be depended on by application code as being portable.
Application code calling SecurityContext#authenticate
is expected to act on all possible
values of AuthenticationStatus.
Enum Constant and Description |
---|
NOT_DONE
The authentication mechanism was called, but decided not to authenticate.
|
SEND_CONTINUE
The authentication mechanism was called and a multi-step authentication dialog with the caller
has been started (for instance, the caller has been redirected to a login page).
|
SEND_FAILURE
The authentication mechanism was called but the caller was not successfully authenticated and
therefore the caller principal will not be made available.
|
SUCCESS
The authentication mechanism was called and the caller was successfully authenticated.
|
Modifier and Type | Method and Description |
---|---|
static AuthenticationStatus |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static AuthenticationStatus[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final AuthenticationStatus NOT_DONE
public static final AuthenticationStatus SEND_CONTINUE
public static final AuthenticationStatus SUCCESS
public static final AuthenticationStatus SEND_FAILURE
Note that this status should be used to indicate a logical problem (such as a credential not matching or a caller ID that can not be found). Exceptions should be used for system level problems (such as a database connection timing out).
public static AuthenticationStatus[] values()
for (AuthenticationStatus c : AuthenticationStatus.values()) System.out.println(c);
public static AuthenticationStatus valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullComments to: es-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.