com.adobe.idp.um.spi.directoryservices
Interface UserConfigBO

All Known Implementing Classes:

GenericUserConfigBO

public interface UserConfigBO

The UserConfigBO interface defines a container for storing configuration information about the user provider. User Management uses the container for passing configuration information to your user provider. The configuration information includes the properties required to connect to the user store for retrieving all users. The configuration information was previously specified in User Management in XML format.

This interface defines methods that the provider uses to retrieve information from the container.

Your implementation will be passed an instance of GenericUserConfigBO.

Method Summary

java.util.Map	getCustomConfiguration() Retrieves the configuration settings of the user provider.
java.lang.String	getRefUserProvider() Retrieves the name of the user provider.

Method Detail

getRefUserProvider

java.lang.String getRefUserProvider()

Retrieves the name of the user provider.

Returns:

A java.lang.String that contains the name of the user provider.

getCustomConfiguration

java.util.Map getCustomConfiguration()

Retrieves the configuration settings of the user provider. This method can only be used for reading configuration settings.

Returns:

A java.util.Map that contains key-value pairs of strings representing the first-level configuration settings of the user provider.