org.forgerock.openam.authentication.modules.common

Class AuthLoginModule

java.lang.Object

org.forgerock.openam.authentication.modules.common.AuthLoginModule

Direct Known Subclasses:

JaspiAuthLoginModule

public abstract class AuthLoginModule
extends Object

Sub types of this class represent the actual Authentication Logic for the Authentication Module. Sub types have to implement the same method signatures of the AMLoginModule, but without extending the class itself, therefore enabling unit testing of the authetication logic. Add any required methods from the AMLoginModule that sub types of this class required to here and the AMLoginModuleBinder interface.

Constructor Summary

Constructors

Constructor and Description
AuthLoginModule()

Method Summary

Modifier and Type	Method and Description
String	getAuthenticatingUserName() See AMLoginModuleBinder.getAuthenticatingUserName().
CallbackHandler	getCallbackHandler() Returns the CallbackHandler object for the module.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Returns the HttpServletRequest object that initiated the call to this module.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Returns the HttpServletResponse object for the servlet request that initiated the call to this module.
abstract Principal	getPrincipal() Abstract method must be implemented by each login module to get the user Principal.
String	getRequestOrg() Returns the organization DN for this authentication session.
abstract void	init(Subject subject, Map sharedState, Map options) Initialize this AuthLoginModule.
abstract int	process(Callback[] callbacks, int state) Abstract method must be implemented by each login module to control the flow of the login process.
void	setAMLoginModule(AMLoginModuleBinder amLoginModuleBinder) Constructs an instance of the AuthLoginModule.
void	setAuthenticatingUserName(String userName) See AMLoginModuleBinder.setAuthenticatingUserName(String).
void	setUserSessionProperty(String name, String value) Sets a property in the user session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthLoginModule

public AuthLoginModule()

Method Detail

setAMLoginModule

public void setAMLoginModule(AMLoginModuleBinder amLoginModuleBinder)

Constructs an instance of the AuthLoginModule.

Parameters:

amLoginModuleBinder - An instance of the AMLoginModuleBinder.

init

public abstract void init(Subject subject,
                          Map sharedState,
                          Map options)

Initialize this AuthLoginModule.

This is an abstract method, must be implemented by user's Login Module to initialize this AuthLoginModule with the relevant information. If this AuthLoginModule does not understand any of the data stored in sharedState or options parameters, they can be ignored.

Parameters:

subject - The Subject to be authenticated.

sharedState - The state shared with other configured LoginModules.

options - The options specified in the login Configuration for this particular AuthLoginModule. It contains all the global and organization attribute configuration for this module. The key of the map is the attribute name (e.g. iplanet-am-auth-ldap-server) as String, the value is the value of the corresponding attribute as Set.

process

public abstract int process(Callback[] callbacks,
                            int state)
                     throws LoginException

Abstract method must be implemented by each login module to control the flow of the login process.

This method takes an array of submitted Callback, process them and decide the order of next state to go. Return -1 if the login is successful, return 0 if the AuthLoginModule should be ignored.

Parameters:

callbacks - The array of Callbacks for this Login state.

state - The order of state. State order starts with 1.

Returns:

order of next state. Return -1 if authentication is successful, return 0 if the AuthLoginModule should be ignored.

Throws:

LoginException - If the login process fails.

getPrincipal

public abstract Principal getPrincipal()

Abstract method must be implemented by each login module to get the user Principal.

Returns:

The Principal.

getCallbackHandler

public CallbackHandler getCallbackHandler()

Returns the CallbackHandler object for the module.

Returns:

CallbackHandler for this request, returns null if the CallbackHandler object could not be obtained.

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Returns the HttpServletRequest object that initiated the call to this module.

Returns:

HttpServletRequest for this request, returns null if the HttpServletRequest object could not be obtained.

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Returns the HttpServletResponse object for the servlet request that initiated the call to this module. The servlet response object will be the response to the HttpServletRequest received by the authentication module.

Returns:

HttpServletResponse for this request, returns null if the HttpServletResponse object could not be obtained.

getRequestOrg

public String getRequestOrg()

Returns the organization DN for this authentication session.

Returns:

The organization DN.

setUserSessionProperty

public void setUserSessionProperty(String name,
                                   String value)
                            throws AuthLoginException

Sets a property in the user session. If the session is being force upgraded then set on the old session otherwise set on the current session.

Parameters:

name - The property name.

value - The property value.

Throws:

AuthLoginException - If the user session is invalid.

setAuthenticatingUserName

public void setAuthenticatingUserName(String userName)

See AMLoginModuleBinder.setAuthenticatingUserName(String).

getAuthenticatingUserName

public String getAuthenticatingUserName()

See AMLoginModuleBinder.getAuthenticatingUserName().