Package com.sun.identity.authentication.spi

Provides interfaces and classes for writing a supplemental authentication module to plug into OpenAM.

See: Description

Interface Summary

Interface	Description
AMAuthCallBack	The AMAuthCallBack interface should be implemented by external business logic code, in order to receive callbacks from the authentication framework when one of the following events happens : account lockout password change (via LDAP module) The event type and related information are passed through the method call AMAuthCallBack.authEventCallback(int, java.util.Map).
AMPostAuthProcessInterface	The AMPostAuthProcessInterface interface needs to be implemented by services and applications to do post authentication processing.
DSAMECallbackInterface	The DSAMECallbackInterface interface needs to be implemented by services and applications which want to define custom Callbacks.
UserIDGenerator	An application implements a UserIDGenerator interface and registers itself to the Core Authentication service so that authentication modules can retrieve a list of auto-generated user IDs.

Class Summary

Class	Description
AMAuthCallBackImpl	This class should be instantiated by components in the authentication framework when callbacks to an external application's logic are required.
AMLoginModule	An abstract class which implements JAAS LoginModule, it provides methods to access OpenAM services and the module xml configuration.
AMPostAuthProcess
DefaultUserIDGenerator	The class DefaultUserIDGenerator generates a set of user IDs based on the first name and last name of the user.
HttpCallback	HttpCallback class implements Callback and is used by the authentication module with HTTP protocol based handshaking negotiation.
PagePropertiesCallback	PagePropertiesCallback class implements Callback and used for exchanging all UI related attributes information such as template name, errorState to indicate whether a template is an error page, page header, image name , page timeout value, name of module.
RedirectCallback	This RedirectCallback class implements Callback and is used by the authentication module when redirect to a particulat URL is required with specific redirect data.
ReplayPasswd	This class is used to set the encrypted password as a session property.
WSSReplayPasswd	This class is used to set the encrypted password as a session property.
X509CertificateCallback	Underlying security services instantiate and pass an X509CertificateCallback to the invokeCallback method of a CallbackHandler to retrieve the contents of an X.509 Certificate.

Exception Summary

Exception	Description
AMAuthCallBackException	The AMAuthCallBackException is used to specify an exception related to an authentication framework callback.
AuthenticationException	AuthenticationException class is for handling Exception that is thrown when the user-entered tokens cause the authentication module to be authenticated to fail.
AuthErrorCodeException	This exception associates a LoginException with an error code from AMAuthErrorCode, which can later be used by AMLoginContext to handle the exception.
AuthLoginException	This class is for handling message localization in LoginException.
InvalidPasswordException	Exception that is thrown when the user-entered password token causes the authentication module to be authenticated to fail.
LoginTimeOutException	Exception that is thrown when the user-entered tokens cause the authentication module to be authenticated to fail.
MessageLoginException	Exception that is thrown when enter a Login Module error state which does not contain a error template.
ResetAuthChainException	This exception throws when reset auth chain exception occured
SetNextModuleException	This exception throws form Authentication Module and process by com.sun.identity.authentication.jaas.LoginContext#invoke() if there's a need to go back in authentcation chain on
UserNamePasswordValidationException	This class is for handling Exception that is thrown when the user name password validation plugin is failed or any invalid characters detected in user name.

Package com.sun.identity.authentication.spi Description

Provides interfaces and classes for writing a supplemental authentication module to plug into OpenAM. Using the interfaces and classes provided, a custom authentication module may be added to OpenAM's list of supported authentication modules/types.

Provides an interface for post authentication processing on successful, failed authentication or on a logout.

Provides an interface for UserID Generation for Membership/Self Registration auth module.

Provides an interface to receive notifications of a user status change after successful password reset or after account lockout (memory).