com.adobe.idp.um.spi.authentication
Interface AuthConfigBO

public interface AuthConfigBO

The AuthConfigBO interface defines a container for storing configuration information about an authentication service provider. User Management uses the container for passing configuration information to the authentication provider. The configuration information is previously specified in the User Management configuration settings in XML format.

To obtain AuthConfigBO objects, use the authConfigs parameter passed to the AuthProvider.authenticate() method.

For information about specifying configuration settings, log into User Management using an administrator account and click Help.

Field Summary

static java.lang.String

DEFAULT_CONFIG The default configuration for an AuthProvider is stored against this constant in the map returned by AuthConfigBO.getCustomConfiguration()

Method Summary

java.util.Map	getCustomConfiguration() Retrieves the first-level custom configuration settings from User Management.
java.lang.String	getDomainName() Retrieves the domain that is specified for use with this authentication provider.

Field Detail

DEFAULT_CONFIG

static final java.lang.String DEFAULT_CONFIG

The default configuration for an AuthProvider is stored against this constant in the map returned by AuthConfigBO.getCustomConfiguration()

See Also:

Constant Field Values

Method Detail

getDomainName

java.lang.String getDomainName()

Retrieves the domain that is specified for use with this authentication provider. This domain is specified in the configuration settings for User Management.

Returns:

A java.lang.String that contains the domain to be used with this authentication provider.

getCustomConfiguration

java.util.Map getCustomConfiguration()

Retrieves the first-level custom configuration settings from User Management. This method can only be used for reading the configuration settings.

Returns:

A java.util.Map object that contains key-value pairs of java.lang.String objects representing the first-level custom configuration settings. The String values may be parsed as needed. The returned object cannot be used to change the configuration.