Package com.sun.identity.authentication.service

Class CompositeAdvices

java.lang.Object

com.sun.identity.authentication.service.CompositeAdvices

public class CompositeAdvices
extends Object

This class allows the authentication services of OpenAM to decouple the advice handling mechanism of the agents. This allows user to introduce and manage custom advices by solely writing OpenAM server-side plug-ins. Users are not required to make changes on the agent side. Such advices are honored automatically by the composite advice handling mechanism. A benefit of composite advice is that you can incorporate a custom advice type without having to make changes to an agent deployment.

Constructor Summary

Constructors

Constructor	Description
CompositeAdvices(String indexName, String orgDN, String clientType, Locale loc)	Default class constructor for class

Method Summary

Modifier and Type	Method	Description
Callback[]	createChoiceCallback()	Returns array of choice callback.
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 configured List of authentication modules
int	getNumberOfAuthModules()	Returns configured number of authentication modules
protected int	getType()	Returns a type indicating the type of authentication required.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeAdvices

public CompositeAdvices(String indexName,
                        String orgDN,
                        String clientType,
                        Locale loc)
                 throws AuthException

Default class constructor for class

Parameters:

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

getNumberOfAuthModules

public int getNumberOfAuthModules()

Returns configured number of authentication modules

Returns:

configured number of authentication modules

getModuleName

public String getModuleName()

Returns configured List of authentication modules

Returns:

configured List of authentication modules

createChoiceCallback

public Callback[] createChoiceCallback()
                                throws AuthException

Returns array of choice callback. Get module matching the level and generate choice callback.

Returns:

array of 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.

getType

protected int getType()

Returns a type indicating the type of authentication required.

Returns:

an integer type indicating the type of authentication required.