Package org.forgerock.openam.authentication.modules.deviceprint

Class DeviceIdSave

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

org.forgerock.openam.authentication.modules.deviceprint.DeviceIdSave

All Implemented Interfaces:

LoginModule

public class DeviceIdSave
extends AMLoginModule

AM Login Module which presents the user with a UI to choose whether to save the device print profile of the device they are using to authenticate with.

Since:

12.0.0

Field Summary

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

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor	Description
DeviceIdSave()

Method Summary

Modifier and Type	Method	Description
Principal	getPrincipal()	Abstract method must be implemeted by each login module to get the user Principal
void	init(Subject subject, Map sharedState, Map config)	Initialize this LoginModule.
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

Constructor Detail

DeviceIdSave

public DeviceIdSave()

Method Detail

init

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

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.

config - - 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 LoginException

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:

LoginException - if login fails.

getPrincipal

public Principal getPrincipal()

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

Specified by:

getPrincipal in class AMLoginModule

Returns:

Principal