Package com.sun.identity.authentication.modules.wss

Class WSSAuthModule

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.wss.WSSAuthModule

All Implemented Interfaces:

LoginModule

public class WSSAuthModule
extends AMLoginModule

Authentication module for web services user name token profile. This module handles both password digest and plain authentication mechanisms and authenticates the users configured via the configured user repository.

Field Summary

Fields

Modifier and Type	Field	Description
protected Principal	userPrincipal

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

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor	Description
WSSAuthModule()

Method Summary

Modifier and Type	Method	Description
Principal	getPrincipal()	Returns the authenticated principal.
void	init(Subject subject, Map sharedState, Map options)	Initialize the authentication module with it's configuration
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, destroyModuleState, 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

Field Detail

userPrincipal

protected Principal userPrincipal

Constructor Detail

WSSAuthModule

public WSSAuthModule()
              throws LoginException

Throws:

LoginException

Method Detail

init

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

Initialize the authentication module with it's configuration

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

Returns the authenticated principal. This is consumed by the authentication framework to set the principal

Specified by:

getPrincipal in class AMLoginModule

Returns:

Principal