com.ibm.itim.webclient.logon

Class LogonMediator

java.lang.Object

com.ibm.itim.webclient.logon.LogonMediator

All Implemented Interfaces:

com.ibm.itim.webclient.challengeresponse.ChallengeResponseConstants

public class LogonMediator
extends java.lang.Object
implements com.ibm.itim.webclient.challengeresponse.ChallengeResponseConstants

Mediates the operations that need to performed when a user signs on to the system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCOUNT_PAGE For redirection to the account management page
static java.lang.String	CHANGE_PASSWD_PAGE For redirection to the password management page
static java.lang.String	COMPLETED_PAGE For redirection to the completed requests page
static java.lang.String	DELEGATE_PAGE For redirection to the delegate management page
static java.lang.String	INVALID_PASSWORD_ATTEMPTS Key for invalid password attempts
static java.lang.String	PENDING_PAGE For redirection to the pending requests page
static java.lang.String	SUBJECT Constant for refering to the authenticated subject
static java.lang.String	TODO_PAGE For redirection to the to do list page

Fields inherited from interface com.ibm.itim.webclient.challengeresponse.ChallengeResponseConstants

ACTION, ADD_REQUIRED_CHALLENGES, C_SUFFIX, CANCEL, CHALLENGE_AND_RESPONSE, CHALLENGE_MODE, CHALLENGE_PICK_LIST, CHALLENGE_RESPONSE_L, CHALLENGES, DEFINE_ATLEAST_ONE_CHALLENGE_TO_RESPOND, ENFORCE_CHALLENGE_RESPONSE_L, FROM_ENFORCE, FROM_PICK_LIST, HIDDEN_CONSTANT, INVALID_RESPONSES, IS_CANCEL_REQUIRED, IS_CHALLENGE_RESPONSE_ENABLED, IS_FORCE_PSWD_CHANGE, IS_HASHING_ENABLED, IS_RESPONSE_VALID, MESSAGE_ID, MULTIPLE_DATA_MOVE, NUM_USER_MUST_ANSWER, QUESTION_ANSWERS, QUESTION_CONFIRM, R_SUFFIX, SELECT_REQUIRED_CHALLENGES, USER_CHALLENGES, USER_CHALLENGES_AND_RESPONSES, USER_DEFINITION_MODE, YES

Constructor Summary

Constructors

Constructor and Description
LogonMediator(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Creates a new LogonMediator

Method Summary

Modifier and Type	Method and Description
void	login(Credentials credentials) Get information about the user, establish a http session, and forward the user to default home page.
void	logon(Credentials credentials) Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).
void	signIn(Credentials credentials) Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).
void	signIn(Credentials credentials, java.lang.String startPage) Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).
void	signIn(java.lang.String userID, java.lang.String startPage) Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).
void	signIn(java.lang.String userID, java.lang.String tenantID, java.lang.String startPage) Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Methods inherited from class java.lang.Object

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

Field Detail

CHANGE_PASSWD_PAGE

public static final java.lang.String CHANGE_PASSWD_PAGE

For redirection to the password management page

See Also:

Constant Field Values

ACCOUNT_PAGE

public static final java.lang.String ACCOUNT_PAGE

For redirection to the account management page

See Also:

Constant Field Values

TODO_PAGE

public static final java.lang.String TODO_PAGE

For redirection to the to do list page

See Also:

Constant Field Values

PENDING_PAGE

public static final java.lang.String PENDING_PAGE

For redirection to the pending requests page

See Also:

Constant Field Values

COMPLETED_PAGE

public static final java.lang.String COMPLETED_PAGE

For redirection to the completed requests page

See Also:

Constant Field Values

DELEGATE_PAGE

public static final java.lang.String DELEGATE_PAGE

For redirection to the delegate management page

See Also:

Constant Field Values

INVALID_PASSWORD_ATTEMPTS

public static final java.lang.String INVALID_PASSWORD_ATTEMPTS

Key for invalid password attempts

See Also:

Constant Field Values

SUBJECT

public static final java.lang.String SUBJECT

Constant for refering to the authenticated subject

See Also:

Constant Field Values

Constructor Detail

LogonMediator

public LogonMediator(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)

Creates a new LogonMediator

Parameters:

req - HttpServletRequest

res - HttpServletResponse

Method Detail

signIn

public void signIn(Credentials credentials)
            throws LogonException,
                   java.rmi.RemoteException,
                   AuthenticationException

Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Get information about the user, establish a http session, and forward the user to default home page. This method can support a multi-tenant deployment if the tenant information can be passed as credentials to the Authenticator.

Parameters:

credentials - The enRole user's Credentials. These credentials will be passed to the configured Authenticator, so all required corresponding authenticator's credentials must be supplied.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

AuthenticationException - Thrown if there was any kind of authentication problem

signIn

public void signIn(Credentials credentials,
                   java.lang.String startPage)
            throws LogonException,
                   java.rmi.RemoteException,
                   AuthenticationException

Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Get information about the user, establish a http session, and forward the user to the specified home page. This method can support a multi-tenant deployment if the tenant information can be passed as credentials to the Authenticator.

Parameters:

credentials - The enRole user's Credentials. The credentials will be passed to the configured Authenticator, so all required corresponding authenticator's credentials must be supplied.

startPage - The first page the user sees in the enRole system. Possible values for the start page are CHANGE_PWD_PAGE, ACCOUNT_PAGE, TODO_PAGE, PENDING_PAGE, COMPLETED_PAGE, DELEGATE_PAGE, or NULL.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

AuthenticationException - Thrown if there was any kind of authentication problem

signIn

public void signIn(java.lang.String userID,
                   java.lang.String startPage)
            throws LogonException,
                   java.rmi.RemoteException,
                   AuthenticationException

Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Get information about the user, establish a http session, and forward the user to the specified start page.

Parameters:

userID - The user id

startPage - The first page the user sees in the enRole system. Possible values for the start page are CHANGE_PWD_PAGE, ACCOUNT_PAGE, TODO_PAGE, PENDING_PAGE, COMPLETED_PAGE, DELEGATE_PAGE, or NULL.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

AuthenticationException - Thrown if there was any kind of authentication problem

signIn

public void signIn(java.lang.String userID,
                   java.lang.String tenantID,
                   java.lang.String startPage)
            throws LogonException,
                   java.rmi.RemoteException,
                   AuthenticationException

Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Get information about the user, establish a http session, and forward the user to the specified start page. This method is used in multi-tenant deployment.

Parameters:

userID - The user id

tenantID - The tenant that the user belongs in the enRole system.

startPage - The first page the user sees in the enRole system. Possible values for the start page are CHANGE_PWD_PAGE, ACCOUNT_PAGE, TODO_PAGE, PENDING_PAGE, COMPLETED_PAGE, DELEGATE_PAGE, or NULL.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

AuthenticationException - Thrown if there was any kind of authentication problem

logon

public void logon(Credentials credentials)
           throws LogonException,
                  java.rmi.RemoteException,
                  AuthenticationException

Deprecated. As of ITIM 4.6, replaced by login(Credentials credentials).

Get information about the user, establish a http session, and forward the user to default home page. This method can support a multi-tenant deployment if the tenant information can be passed as credentials to the Authenticator.

Parameters:

credentials - The enRole user's Credentials. Authenticator's credentials must be supplied. Note: Custom Authetication is not allowed using this API.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

AuthenticationException - Thrown if there was any kind of authentication problem

login

public void login(Credentials credentials)
           throws LogonException,
                  java.rmi.RemoteException,
                  javax.security.auth.login.FailedLoginException,
                  javax.security.auth.login.CredentialExpiredException

Get information about the user, establish a http session, and forward the user to default home page. This method can support a multi-tenant deployment if the tenant information can be passed as credentials to the Authenticator.

Parameters:

credentials - The object containing user's user id and password credentials to be authenticated. Note: Custom Authetication is not supported using this API.

Throws:

LogonException - Thrown if there was any kind of application problem

java.rmi.RemoteException - Thrown if there is a communication exception

javax.security.auth.login.FailedLoginException - Thrown if there was any kind of authentication problem

javax.security.auth.login.CredentialExpiredException - Thrown if the password gets expired.

See Also:

Credentials