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

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

public class DirectoryProviderConfig
extends java.lang.Object

The DirectoryProviderConfig class provides methods for retrieving information about directory service providers from the User Management configuration settings. User Management creates DirectoryProviderConfig objects and uses them as parameters when calling user and group providers.

DirectoryProviderConfig objects are associated with either a user provider or a group provider. A DirectoryProviderConfig object provides access to either a UserConfigBO object or a GroupConfigBO object.

See Also:

UserConfigBO, GroupConfigBO

Constructor Summary

DirectoryProviderConfig(java.lang.String domain, GroupConfigBO groupConfig)
Creates a new DirectoryProviderConfig object based on the provided configuration information.

DirectoryProviderConfig(java.lang.String domain, UserConfigBO userConfig)
Creates a new DirectoryProviderConfig object based on the provided configuration information.

Method Summary

java.lang.String	getDomain() Retrieves the name of the domain associated with this object.
GroupConfigBO	getGroupConfig() Retrieves the GroupConfigBO object associated with this object.
UserConfigBO	getUserConfig() Retrieves the UserConfigBO object associated with this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryProviderConfig

public DirectoryProviderConfig(java.lang.String domain,
                               UserConfigBO userConfig)

Creates a new DirectoryProviderConfig object based on the provided configuration information. The new object provides information that user providers can use to retrieve user records from a repository.

Parameters:

domain - A java.lang.String that contains the domain name associated with the user provider.

userConfig - A UserConfigBO object that contains configuration information about the user provider.

DirectoryProviderConfig

public DirectoryProviderConfig(java.lang.String domain,
                               GroupConfigBO groupConfig)

Creates a new DirectoryProviderConfig object based on the provided configuration information. The new object provides information that group providers use to retrieve user records that belong to a specific group.

Parameters:

domain - A java.lang.String that contains the domain name associated with the group provider.

groupConfig - A GroupConfigBO object that contains configuration information about the group provider and identifies the group to retrieve.

Method Detail

getDomain

public java.lang.String getDomain()

Retrieves the name of the domain associated with this object.

Returns:

A java.lang.String that contains the domain name.

getGroupConfig

public GroupConfigBO getGroupConfig()

Retrieves the GroupConfigBO object associated with this object. This information is required for retrieving groups from the user store.

Returns:

An object that contains either the information about the group provider, or null if this object is associated with a user provider.

getUserConfig

public UserConfigBO getUserConfig()

Retrieves the UserConfigBO object associated with this object.

Returns:

An object that contains either the information about the user provider, or null if this object is associated with a group provider.