com.adobe.idp.um.spi.directoryservices
Class GenericUserConfigBO

java.lang.Object
  com.adobe.idp.um.spi.directoryservices.GenericUserConfigBO

All Implemented Interfaces:

UserConfigBO, java.io.Serializable

public class GenericUserConfigBO
extends java.lang.Object
implements UserConfigBO, java.io.Serializable

The GenericUserConfigBO class provides a container for configuration information of a specific user provider. The configuration information includes the properties required to connect to the user store for retrieving all user records.

Adobe User Management creates GenericUserConfigBO objects and passes them to the user provider.

GenericUserConfigBO objects contain configuration information only for the user provider that is called upon.

For retrieving only the user records for a specific group, use the GenericGroupConfigBO class.

See Also:

GenericGroupConfigBO, Serialized Form

Constructor Summary

GenericUserConfigBO()
Default constructor.

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.
void	setCustomConfiguration(java.util.Map m) Sets the configuration settings of the user provider.
void	setRefUserProvider(java.lang.String string) Sets the name of the user provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUserConfigBO

public GenericUserConfigBO()

Default constructor.

Method Detail

getRefUserProvider

public java.lang.String getRefUserProvider()

Retrieves the name of the user provider.

Specified by:

getRefUserProvider in interface UserConfigBO

Returns:

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

setRefUserProvider

public void setRefUserProvider(java.lang.String string)

Sets the name of the user provider.

Parameters:

string - A String that contains the name of the user provider.

setCustomConfiguration

public void setCustomConfiguration(java.util.Map m)

Sets the configuration settings of the user provider.

Parameters:

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

getCustomConfiguration

public java.util.Map getCustomConfiguration()

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

Specified by:

getCustomConfiguration in interface UserConfigBO

Returns:

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