Uses of Class
org.forgerock.caf.authentication.api.AuthenticationException

Packages that use AuthenticationException

Package	Description
org.forgerock.caf.authentication.api
org.forgerock.caf.authentication.framework
org.forgerock.caf.authn.test.modules
org.forgerock.jaspi.modules.iwa
org.forgerock.jaspi.modules.openid
org.forgerock.jaspi.modules.session.jwt
org.forgerock.jaspi.modules.session.openam

Uses of AuthenticationException in org.forgerock.caf.authentication.api

Methods in org.forgerock.caf.authentication.api that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	AsyncServerAuthContext.cleanSubject(MessageContext context, Subject clientSubject) Removes any method specific principals and credentials from the client subject.
Promise<Void,AuthenticationException>	AsyncServerAuthModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Removes any method specific principals and credentials from the client subject.
Promise<Void,AuthenticationException>	AsyncServerAuthModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map<String,Object> options) Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module specific configuration properties.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AsyncServerAuthContext.secureResponse(MessageContext context, Subject serviceSubject) Secures the outgoing response message.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AsyncServerAuthModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Secures the outgoing response message.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AsyncServerAuthContext.validateRequest(MessageContext context, Subject clientSubject, Subject serviceSubject) Validates the incoming request message.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AsyncServerAuthModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Validates the incoming request message.

Uses of AuthenticationException in org.forgerock.caf.authentication.framework

Subclasses of AuthenticationException in org.forgerock.caf.authentication.framework

Modifier and Type	Class and Description
class	AuthenticationFailedException An authentication exception which signifies that authentication of the request has failed and an appropriate unauthorized response should be returned to the client.

Methods in org.forgerock.caf.authentication.framework that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	FallbackAuthContext.cleanSubject(MessageContext context, Subject clientSubject) Calls each AsyncServerAuthContext in parallel to clean the client subject and only return a successful promise if all complete successfully otherwise returns the first exception in a failed promise.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	FallbackAuthContext.secureResponse(MessageContext context, Subject serviceSubject) Secures the response message using the same AsyncServerAuthModule that authenticated the incoming request message.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	FallbackAuthContext.validateRequest(MessageContext context, Subject clientSubject, Subject serviceSubject) Authenticates the incoming request message by calling each AsyncServerAuthModule in order until an auth module returns an AuthStatus value other than SEND_FAILURE, or returns an AuthenticationException or the end of the module list is reached.

Methods in org.forgerock.caf.authentication.framework with parameters of type AuthenticationException

Modifier and Type	Method and Description
void	ResponseWriter.write(MessageContext context, AuthenticationException exception) Write the details of the exception out, and set the content type of the response.

Uses of AuthenticationException in org.forgerock.caf.authn.test.modules

Methods in org.forgerock.caf.authn.test.modules that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	SessionAuthModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	FailureAuditingAuthModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleUnsupportedMessageTypes.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleTwo.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleOne.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	AuditingSessionAuthModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	AuditingAuthModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) Does nothing.
Promise<Void,AuthenticationException>	SessionAuthModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	FailureAuditingAuthModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleUnsupportedMessageTypes.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleTwo.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	AuthModuleOne.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	AuditingSessionAuthModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<Void,AuthenticationException>	AuditingAuthModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map config) Does nothing.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	SessionAuthModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-SESSION-SECURE-RESPONSE request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	FailureAuditingAuthModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Attempts to add to the module audit info, which should not be added, and sets the session id to be audited, which should be ignored as this module is not a "Session" auth module.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleUnsupportedMessageTypes.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Returns SEND_SUCCESS.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleTwo.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-AUTH-MODULE-TWO-SECURE-RESPONSE request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleOne.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-AUTH-MODULE-ONE-SECURE-RESPONSE request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuditingSessionAuthModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Attempts to add to the module audit info, which should not be added, and sets the session id to be audited.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuditingAuthModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Attempts to add to the module audit info, which should not be added, and sets the session id to be audited, which should be ignored as this module is not a "Session" auth module.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	SessionAuthModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-SESSION-VALIDATE_REQUEST request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	FailureAuditingAuthModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Adds module audit info and sets the principal.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleUnsupportedMessageTypes.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Returns SUCCESS.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleTwo.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-AUTH-MODULE-TWO-VALIDATE-REQUEST request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuthModuleOne.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Return value is based on the presents and value of the X-JASPI-AUTH-MODULE-ONE-VALIDATE-REQUEST request header.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuditingSessionAuthModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Adds module audit info and sets the principal.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	AuditingAuthModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Adds module audit info and sets the principal.

Uses of AuthenticationException in org.forgerock.jaspi.modules.iwa

Methods in org.forgerock.jaspi.modules.iwa that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	IWAModule.cleanSubject(MessageInfoContext messageInfo, Subject subject) Removes any method specific principals and credentials from the client subject.
Promise<Void,AuthenticationException>	IWAModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map<String,Object> options) Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module specific configuration properties.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	IWAModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) Always returns AuthStatus.SEND_SUCCESS.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	IWAModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Validates the request by checking the Authorization header in the request for a IWA token and processes that for authentication.

Uses of AuthenticationException in org.forgerock.jaspi.modules.openid

Methods in org.forgerock.jaspi.modules.openid that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	OpenIdConnectModule.cleanSubject(MessageInfoContext messageInfo, Subject subject) Nothing to clean.
Promise<Void,AuthenticationException>	OpenIdConnectModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map<String,Object> config) Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module specific configuration properties.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	OpenIdConnectModule.secureResponse(MessageInfoContext messageInfo, Subject subject) Sends SEND_SUCCESS automatically.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	OpenIdConnectModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Attempts to retrieve the value of the specified OpenID Connect header from the messageInfo, then converts this to a Jwt and attempts to decrypt.

Uses of AuthenticationException in org.forgerock.jaspi.modules.session.jwt

Methods in org.forgerock.jaspi.modules.session.jwt that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	JwtSessionModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject)
Promise<Void,AuthenticationException>	JwtSessionModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map<String,Object> options)
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	JwtSessionModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject)
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	JwtSessionModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject)

Uses of AuthenticationException in org.forgerock.jaspi.modules.session.openam

Methods in org.forgerock.jaspi.modules.session.openam that return types with arguments of type AuthenticationException

Modifier and Type	Method and Description
Promise<Void,AuthenticationException>	OpenAMSessionModule.cleanSubject(MessageInfoContext messageInfo, Subject clientSubject) No state to clear out from the client subject.
Promise<Void,AuthenticationException>	OpenAMSessionModule.initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler callbackHandler, Map<String,Object> options) Will initialise the module with the specified configuration properties.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	OpenAMSessionModule.secureResponse(MessageInfoContext messageInfo, Subject serviceSubject) No action to perform on secure response.
Promise<javax.security.auth.message.AuthStatus,AuthenticationException>	OpenAMSessionModule.validateRequest(MessageInfoContext messageInfo, Subject clientSubject, Subject serviceSubject) Validates whether or not the request contains a valid OpenAM SSO Token Id.