Package com.sun.identity.authentication.modules.federation

Class Federation

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.federation.Federation

All Implemented Interfaces:

LoginModule

public class Federation
extends AMLoginModule

Field Summary

Fields inherited from class com.sun.identity.authentication.spi.AMLoginModule

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor	Description
Federation()	Constructor

Method Summary

Modifier and Type	Method	Description
void	destroyModuleState()	Clean up the login state.
Principal	getPrincipal()	Returns principal of the authenticated user.
void	init(Subject subject, Map sharedState, Map options)	Initialize parameters.
int	process(Callback[] callbacks, int state)	Process the authentication request.

Methods inherited from class com.sun.identity.authentication.spi.AMLoginModule

abort, clearInfoText, commit, createIdentity, forceCallbacksInit, getAMIdentityRepository, getAttribute, getAuditEntryDetail, getAuthenticatedPrincipals, getAuthLevel, getCallback, getCallback, getCallbackHandler, getCurrentState, getFailCount, getHttpServletRequest, getHttpServletResponse, getInfoText, getLocale, getLoginLocale, getLoginState, getMaximumFailCount, getNewUserIDs, getNumberOfStates, getOrgProfile, getOrgServiceTemplate, getPwdKey, getRequestOrg, getServiceConfig, getSessionId, getSSOSession, getUserAliasList, getUserKey, getUserProfile, getUserSessionProperty, getUserSessions, incrementFailCount, initialize, isAccountLocked, isDynamicProfileCreationEnabled, isRequired, isSessionQuotaReached, isSharedStateEnabled, isSuperAdmin, isUseFirstPassEnabled, isValidUserEntry, login, logout, nullifyUsedVars, replaceCallback, replaceHeader, resetCallback, resetCurrentState, setAuthLevel, setFailureID, setForceCallbacksRead, setLoginFailureURL, setLoginSuccessURL, setModuleErrorTemplate, setOrg, setSharedStateEnabled, setUserAttributes, setUserSessionProperty, storeUsername, storeUsernamePasswd, substituteHeader, substituteInfoText, validatePassword, validateUserName

Methods inherited from class java.lang.Object

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

Constructor Detail

Federation

public Federation()

Constructor

Method Detail

init

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

Initialize parameters.

Specified by:

init in class AMLoginModule

Parameters:

subject - - the Subject to be authenticated.

sharedState - - state shared with other configured LoginModules.

options - - options specified in the login Configuration for this particular LoginModule. 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 int process(Callback[] callbacks,
                   int state)
            throws AuthLoginException

Process the authentication request.

Specified by:

process in class AMLoginModule

Parameters:

callbacks - Callback[] for this Login state

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

Returns:

ISAuthConstants.LOGIN_SUCCEED as succeeded; ISAuthConstants.LOGIN_IGNORE as failed.

Throws:

AuthLoginException - upon any failure. login state should be kept on exceptions for status check in auth chaining.

getPrincipal

public Principal getPrincipal()

Returns principal of the authenticated user.

Specified by:

getPrincipal in class AMLoginModule

Returns:

Principal of the authenticated user.

destroyModuleState

public void destroyModuleState()

Clean up the login state.

Overrides:

destroyModuleState in class AMLoginModule