Package com.sun.identity.authentication.service

Class AuthenticationPrincipalDataRetrieverFactory

java.lang.Object

com.sun.identity.authentication.service.AuthenticationPrincipalDataRetrieverFactory

public class AuthenticationPrincipalDataRetrieverFactory
extends Object

A factory to access AuthenticationPrincipalDataRetriever instance. This factory uses the configuration key com.sun.identity.authentication.principalDataRetriever to identify the implementation of AuthenticationPrincipalDataRetriever interface; instantiates this class; and returns the instance for retrieving Authentication module Principal data, to be populated in successful user authentication session.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_PRINCIPAL_DATA_RETRIEVER	The configuration key used for identifying the implemenation class of AuthenticationPrincipalDataRetriever interface.
static String	DEFAULT_PRINCIPAL_DATA_RETRIEVER	The default implementation to be used in case no value is specified in the configuration.

Method Summary

Modifier and Type	Method	Description
static AuthenticationPrincipalDataRetriever	getPrincipalDataRetriever()	Returns an instance of AuthenticationPrincipalDataRetriever.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PRINCIPAL_DATA_RETRIEVER

public static final String CONFIG_PRINCIPAL_DATA_RETRIEVER

The configuration key used for identifying the implemenation class of AuthenticationPrincipalDataRetriever interface.

See Also:

Constant Field Values

DEFAULT_PRINCIPAL_DATA_RETRIEVER

public static final String DEFAULT_PRINCIPAL_DATA_RETRIEVER

The default implementation to be used in case no value is specified in the configuration.

See Also:

Constant Field Values

Method Detail

getPrincipalDataRetriever

public static AuthenticationPrincipalDataRetriever getPrincipalDataRetriever()

Returns an instance of AuthenticationPrincipalDataRetriever. This instance is instantiated during static initialization of this factory and is kept as a singleton throughout its lifecycle.

Returns:

an instance of AuthenticationPrincipalDataRetriever.