Package com.sun.identity.authentication.service

Class AuthLevel

java.lang.Object

com.sun.identity.authentication.service.AuthLevel

public class AuthLevel
extends Object

This class is representing authentication level for associated auth module. The authentication level is set separately for each method of authentication. The value indicates how much to trust an authentication. Once a user has authenticated, this value is stored in the SSO token for the session. When the SSO token is presented to an application the user wants to access, the application uses the stored value to determine whether the level is sufficient to grant the user access. If the authentication level stored in an SSO token does not meet the minimum value required, the application can prompt the user to authenticate again through a service with a higher authentication level. The default value is 0.

Constructor Summary

Constructors

Constructor	Description
AuthLevel(AuthContext.IndexType indexType, String indexName, String orgDN, String clientType, Locale loc)	Class constructor

Method Summary

Modifier and Type	Method	Description
Callback[]	createChoiceCallback()	Returns choice callback.
void	getAuthModulesConfig()	Returns auth modules configuration
String[]	getModuleList()	Returns configured List of authentication modules
protected String	getModuleLocalizedName(String moduleName)	Returns localized name of a module.
protected Map	getModuleMap()	Returns a map containing localized module name and module name.
String	getModuleName()	Returns associated authentication module with auth level
int	getNumberOfAuthModules()	Returns configured number of authentication modules

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthLevel

public AuthLevel(AuthContext.IndexType indexType,
                 String indexName,
                 String orgDN,
                 String clientType,
                 Locale loc)
          throws AuthException

Class constructor

Parameters:

indexType - IndexType defines the possible kinds of "objects" or "resources" for which an authentication can be performed.

indexName - authentication index name.

orgDN - associated organizational DN for authentication module.

clientType - associated client type for authentication module.

loc - associated locale instance for authentication module.

Throws:

AuthException - if an error occurred during instanciation.

Method Detail

getAuthModulesConfig

public void getAuthModulesConfig()

Returns auth modules configuration

getNumberOfAuthModules

public int getNumberOfAuthModules()

Returns configured number of authentication modules

Returns:

configured number of authentication modules

getModuleList

public String[] getModuleList()

Returns configured List of authentication modules

Returns:

configured List of authentication modules

getModuleName

public String getModuleName()

Returns associated authentication module with auth level

Returns:

associated authentication module with auth level

createChoiceCallback

public Callback[] createChoiceCallback()
                                throws AuthException

Returns choice callback. Gets module matching the level and generates choice callback.

Returns:

choice callback.

Throws:

AuthException

getModuleLocalizedName

protected String getModuleLocalizedName(String moduleName)

Returns localized name of a module.

Parameters:

moduleName - name of module.

Returns:

localized name of a module.

getModuleMap

protected Map getModuleMap()

Returns a map containing localized module name and module name.

Returns:

module map with key the localized module name and value the module name.