com.sun.identity.authentication.modules.datastore

Class DataStore

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.datastore.DataStore

All Implemented Interfaces:

LoginModule

public class DataStore
extends AMLoginModule

Field Summary

Fields

Modifier and Type	Field and Description
protected String	amAuthDataStore
Map	currentConfig
protected Debug	debug
protected Principal	userPrincipal
protected String	validatedUserID

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

amCache, auditor

Constructor Summary

Constructors

Constructor and Description
DataStore()

Method Summary

Modifier and Type	Method and Description
void	destroyModuleState() This method should be overridden by each login module to destroy dispensable state fields.
Principal	getPrincipal() Abstract method must be implemeted by each login module to get the user Principal
void	init(Subject subject, Map sharedState, Map options) Initialize this LoginModule.
void	nullifyUsedVars() This method should be overridden by each login module to do some garbage collection work after the module process is done.
int	process(Callback[] callbacks, int state) Abstract method must be implemented by each login module to control the flow of the login process.

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, 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

Field Detail

validatedUserID

protected String validatedUserID

currentConfig

public Map currentConfig

debug

protected Debug debug

amAuthDataStore

protected String amAuthDataStore

userPrincipal

protected Principal userPrincipal

Constructor Detail

DataStore

public DataStore()

Method Detail

init

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

Description copied from class: AMLoginModule

Initialize this LoginModule.

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

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

Description copied from class: AMLoginModule

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

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

Specified by:

process in class AMLoginModule

Parameters:

callbacks - Callback[] for this Login state

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

Returns:

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

Throws:

AuthLoginException

getPrincipal

public Principal getPrincipal()

Description copied from class: AMLoginModule

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

Specified by:

getPrincipal in class AMLoginModule

Returns:

Principal

destroyModuleState

public void destroyModuleState()

Description copied from class: AMLoginModule

This method should be overridden by each login module to destroy dispensable state fields.

Overrides:

destroyModuleState in class AMLoginModule

nullifyUsedVars

public void nullifyUsedVars()

Description copied from class: AMLoginModule

This method should be overridden by each login module to do some garbage collection work after the module process is done. Typically those class wide global variables that will not be used again until a logout call should be nullified.

Overrides:

nullifyUsedVars in class AMLoginModule