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

All Superinterfaces:

DirectoryPrincipalProvider

public interface DirectoryGroupProvider
extends DirectoryPrincipalProvider

The DirectoryGroupProvider interface defines a mechanism for retrieving the user records that belong to a specific user group from a repository. You must implement this interface to create a custom group provider service that integrates with User Management.

Some of the functionality of this interface is inherited from the DirectoryPrincipalProvider interface.

See Also:

DirectoryPrincipalProvider, DirectoryUserProvider

Field Summary

Fields inherited from interface com.adobe.idp.um.spi.directoryservices.DirectoryPrincipalProvider

E_DIRSERVICES_COLLIDING_PRINCIPAL_SPEC, E_DIRSERVICES_CONFIGURATION_ERROR, E_DIRSERVICES_PROVIDER_DATA_ERROR, E_DIRSERVICES_PROVIDER_UNKNOWN_ERROR

Method Summary

DSGroupContainmentRecord

getGroupMembers(DirectoryProviderConfig config, DSPrincipalIdRecord group) Retrieves the records for all users and groups of a specified group.

Methods inherited from interface com.adobe.idp.um.spi.directoryservices.DirectoryPrincipalProvider

getPrincipals, testConfiguration

Method Detail

getGroupMembers

DSGroupContainmentRecord getGroupMembers(DirectoryProviderConfig config,
                                         DSPrincipalIdRecord group)
                                         throws IDPException

Retrieves the records for all users and groups of a specified group. All records are retrieved on the first call to this method.

Parameters:

config - A DirectoryProviderConfig object that contains information used to connect to the repository, such as the domain name and other information specific to the implementation.

group - A DSPrincipalIdRecord object that identifies the group to be retrieved.

Returns:

A DSGroupContainmentRecord object that contains the retrieved user records of the group.

Throws:

IDPException