Package com.sun.identity.authentication.modules.ldap

Class LDAP

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.ldap.LDAP

All Implemented Interfaces:

LoginModule

Direct Known Subclasses:

AD

public class LDAP
extends AMLoginModule

Field Summary

Fields

Modifier and Type	Field	Description
protected String	amAuthLDAP
Map	currentConfig
protected Debug	debug
protected LDAPAuthUtils	ldapUtil
protected Principal	userPrincipal
protected String	validatedUserID

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

amCache, auditor

Constructor Summary

Constructors

Constructor	Description
LDAP()	TODO-JAVADOC

Method Summary

Modifier and Type	Method	Description
void	destroyModuleState()	Cleans up state fields.
Principal	getPrincipal()	Returns principal.
void	init(Subject subject, Map sharedState, Map options)	TODO-JAVADOC
boolean	initializeLDAP()	TODO-JAVADOC
void	nullifyUsedVars()	TODO-JAVADOC
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

ldapUtil

protected LDAPAuthUtils ldapUtil

currentConfig

public Map currentConfig

debug

protected Debug debug

amAuthLDAP

protected String amAuthLDAP

userPrincipal

protected Principal userPrincipal

Constructor Detail

LDAP

public LDAP()

TODO-JAVADOC

Method Detail

init

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

TODO-JAVADOC

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.

initializeLDAP

public boolean initializeLDAP()
                       throws AuthLoginException

TODO-JAVADOC

Throws:

AuthLoginException

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()

Returns principal.

Specified by:

getPrincipal in class AMLoginModule

Returns:

principal.

destroyModuleState

public void destroyModuleState()

Cleans up state fields.

Overrides:

destroyModuleState in class AMLoginModule

nullifyUsedVars

public void nullifyUsedVars()

TODO-JAVADOC

Overrides:

nullifyUsedVars in class AMLoginModule