com.adobe.idp.um.api
Interface DirectoryManager

All Known Implementing Classes:

DirectoryManagerServiceClient

public interface DirectoryManager

This is the primary interface for directory management.

Method Summary

void	addAllowedRefererExceptions(java.lang.String listId, java.util.List refererExceptions) Creates a list of exceptions of Allowed Referers for which a request will be blocked
void	addPrincipalToLocalGroup(java.lang.String principalOid, java.lang.String localGroupOid) Adds a principal to an existing local group.
void	createAllowedURIsList(java.lang.String listId, java.util.List allowedURIs) Creates a list of allowed URI's to be white-listed for any calling referer
java.lang.String	createDirectoryPrincipal(Principal principal) Creates a new directory principal.
void	createDomain(Domain d) Creates a domain in the system.
java.lang.String	createLocalGroup(Group localGroup) Creates a new local group.
java.lang.String	createLocalSystemUser(User p) Creates a new local system user.
java.lang.String	createLocalUser(User localUser, java.lang.String password) Creates a new local user.
java.lang.String	createLocalUser(User localUser, java.lang.String hashedPassword, java.lang.String salt) Creates a new local user.
java.util.Map	createLocalUsers(java.util.Set userInfo) Creates a set of new local users.
void	deleteAllowedRefererExceptions(java.lang.String listId) Deletes the list of Allowed Referer Exceptions with the input list Id.
void	deleteAllowedURIsList(java.lang.String listId) Deletes the list of white listed URIs with the input list Id.
void	deleteDomain(java.lang.String domainName) Deletes the domain and all associated principals from the system.
void	deleteLocalGroup(java.lang.String groupOid) Deletes the specified local group.
void	deleteLocalUser(java.lang.String userOid) Deletes a local user from the system.
Domain	findDomain(java.lang.String domainName) Retrieves the domain with the specified name.
java.util.List	findDomains() Enumerates all domains in the system.
java.util.List	findGroupMembers(GroupMembershipSearchFilter gsf) Finds user and group members contained with a group.
java.util.List	findGroups(PrincipalSearchFilter searchFilter) Deprecated.
Principal	findPrincipal(java.lang.String oid) Retrieves a principal according to the specified identifier.
Principal	findPrincipal(java.lang.String domainName, java.lang.String canonicalName) Retrieves a principal according to the specified domain name and canonical name.
java.util.Map	findPrincipalReference(java.util.List principalOids) Retrieves principal references according to the specified identifiers.
PrincipalReference	findPrincipalReference(java.lang.String oid) Retrieves a principal reference according to the specified identifier.
PrincipalReference	findPrincipalReference(java.lang.String domainName, java.lang.String canonicalName) Retrieves a principal reference according to the specified domain name and canonical name.
java.util.List	findPrincipalReferences(PrincipalSearchFilter searchFilter) Finds the principals according to the specified search filter and the specified principal type.
java.util.List	findPrincipalReferences(PrincipalSearchFilter searchFilter, java.lang.String principalType) Deprecated.
java.util.Map	findPrincipals(java.util.List principalOids) Retrieves principals according to the specified identifiers.
java.util.List	findPrincipals(PrincipalSearchFilter searchFilter) Finds the principals according to the specified search filter
java.util.List	findPrincipals(PrincipalSearchFilter searchFilter, java.util.List principalOids) Deprecated.
java.util.List	findPrincipals(PrincipalSearchFilter searchFilter, java.lang.String principalType) Deprecated.
java.util.Map	findPrincipals(java.util.Set principalReferences) Finds the principals having the specified principal references.
java.util.Map	findPrincipalsByEmailId(java.util.Set emailIds) Finds the principals having the specified email identifiers.
java.util.Map	findPrincipalStatus(java.util.Set principalReferences) Retrieves the status for the specified principals.
java.util.List	findUsers(PrincipalSearchFilter searchFilter) Deprecated.
java.util.List	getAllBusinessCalendarKeys() Returns a unique set of all the business calendar attribute values.
java.util.List	getAllowedRefererExceptions(java.lang.String listId) Returns a list of Allowed Referer Exception existing in the input list id.
java.util.List	getAllowedReferers() Returns a list of all allowed Referers.
java.util.List	getAllowedURIsList(java.lang.String listId) Returns a list of all white listed URIs existing in the input list id.
java.lang.String	getBusinessCalendarKeyforUser(java.lang.String oid) Returns the business calendar key attribute value for the user whose oid has been passed in.
java.util.Map	getDirectorySyncStatus(java.util.Set domainNames) Retrieves the synchronization status for the java.util.Set of domains.
Group	getDomainAsGroup(java.lang.String domainName) Retrieves the associated group with the specified domain.
java.util.List	getDynamicGroupCriteriaAttributes() Returns a list of all attributes which are being used as criteria in creation of Dynamic Groups.
DynamicGroupMembershipCriteria	getDynamicGroupMembershipCriteria(java.lang.String groupOid) Fetches the membership criteria of a DynamicGroup
void	removePrincipalFromLocalGroup(java.lang.String principalOid, java.lang.String localGroupOid) Removes a principal from an existing local group.
void	updateAllowedRefererExceptions(java.lang.String listId, java.util.List refererExceptions) Updates a list of exceptions of Allowed Referers for which a request will be blocked.
void	updateAllowedURIsList(java.lang.String listId, java.util.List allowedURIs) Updates a list of allowed URI's to be white-listed for any calling referer.
void	updateDomain(Domain updatedDom) Updates the mutable fields in a domain.
void	updateDynamicGroupMembershipCriteria(java.lang.String groupOid, DynamicGroupMembershipCriteria criteria) Updates the membership criteria of a DynamicGroup
void	updateLocalGroup(Group updatedGroup) Updates information in the group.
void	updateLocalUser(User updatedUser, java.lang.String password) Updates a local user.
void	updateLocalUser(User updatedUser, java.lang.String oldPassword, java.lang.String newPassword) Updates a local user.

Method Detail

createDomain

void createDomain(Domain d)
                  throws UMException

Creates a domain in the system.

Parameters:

d - The domain to be created.

Throws:

UMException

deleteDomain

void deleteDomain(java.lang.String domainName)
                  throws UMException

Deletes the domain and all associated principals from the system.

Parameters:

domainName - The domain to be deleted.

Throws:

UMException

updateDomain

void updateDomain(Domain updatedDom)
                  throws UMException

Updates the mutable fields in a domain. Call findDomains() to retrieve the Domain object to be updated.

Parameters:

updatedDom -

Throws:

UMException

See Also:

DirectoryManager.findDomains()

findDomain

Domain findDomain(java.lang.String domainName)
                  throws UMException

Retrieves the domain with the specified name.

Parameters:

domainName - The name of the domain to be found.

Returns:

The domain with the specified name.

Throws:

UMException

getDomainAsGroup

Group getDomainAsGroup(java.lang.String domainName)
                       throws UMException

Retrieves the associated group with the specified domain.

Parameters:

domainName - The domain associated with the group.

Returns:

The associated group with the domain.

Throws:

UMException

getDirectorySyncStatus

java.util.Map getDirectorySyncStatus(java.util.Set domainNames)
                                     throws UMException

Retrieves the synchronization status for the java.util.Set of domains.

Parameters:

domainNames - The set of domains whose synchronization status is to be retrieved.

Returns:

A java.util.Map whose keys are the domain names and whose values are the corresponding synchronization status (DirectorySyncInfo) objects.

Throws:

UMException

See Also:

DirectorySyncInfo

createDirectoryPrincipal

java.lang.String createDirectoryPrincipal(Principal principal)
                                          throws UMException

Creates a new directory principal.

Parameters:

principal - The directory principal to be created in the system.

Returns:

The directory principal identifier.

Throws:

UMException

createLocalGroup

java.lang.String createLocalGroup(Group localGroup)
                                  throws UMException

Creates a new local group.

Parameters:

localGroup - The local group to be created in the system.

Returns:

The local group identifier.

Throws:

UMException

updateDynamicGroupMembershipCriteria

void updateDynamicGroupMembershipCriteria(java.lang.String groupOid,
                                          DynamicGroupMembershipCriteria criteria)
                                          throws UMException

Updates the membership criteria of a DynamicGroup

Parameters:

groupOid -

criteria -

Throws:

UMException

getDynamicGroupMembershipCriteria

DynamicGroupMembershipCriteria getDynamicGroupMembershipCriteria(java.lang.String groupOid)
                                                                 throws UMException

Fetches the membership criteria of a DynamicGroup

Parameters:

groupOid -

Throws:

UMException

deleteLocalGroup

void deleteLocalGroup(java.lang.String groupOid)
                      throws UMException

Deletes the specified local group.

Parameters:

groupOid - The local group identifier.

Throws:

UMException

updateLocalGroup

void updateLocalGroup(Group updatedGroup)
                      throws UMException

Updates information in the group. For example, if you would like to change the description of the group, retrieve the group via the findPrincipal() method (cast the result to a Group), and invoke the object's setDescription() method.

Parameters:

updatedGroup - The group to be updated.

Throws:

UMException

createLocalUser

java.lang.String createLocalUser(User localUser,
                                 java.lang.String password)
                                 throws UMException

Creates a new local user.

Parameters:

localUser - The local user to be created in the system.

password - The local user's password.

Returns:

The local user identifier.

Throws:

UMException

createLocalUser

java.lang.String createLocalUser(User localUser,
                                 java.lang.String hashedPassword,
                                 java.lang.String salt)
                                 throws UMException

Creates a new local user.

Parameters:

localUser - The local user to be created in the system.

hashedPassword - The local user's hashed password.

salt - The salt used with the local user's hashed password.

Returns:

The local user identifier.

Throws:

UMException

createLocalUsers

java.util.Map createLocalUsers(java.util.Set userInfo)
                               throws UMException

Creates a set of new local users. It creates either all or none of the specified local users.

Parameters:

userInfo - A java.util.Set containing UserInfo instances that represent each user's object and password.

Returns:

A java.util.Map whose keys are the UserInfo instances and whose values are the automatically generated corresponding local user identifiers.

Throws:

UMException

createLocalSystemUser

java.lang.String createLocalSystemUser(User p)
                                       throws UMException

Creates a new local system user.

Parameters:

p - The new local system user.

Returns:

The local system user identifier.

Throws:

UMException

deleteLocalUser

void deleteLocalUser(java.lang.String userOid)
                     throws UMException

Deletes a local user from the system.

Parameters:

userOid - The local user's identifier.

Throws:

UMException

updateLocalUser

void updateLocalUser(User updatedUser,
                     java.lang.String password)
                     throws UMException

Updates a local user. For example, you could use this method to change the Administrator's password.

Parameters:

updatedUser - The updated user information.

password - The user's new password. Use null if you do not want to change the password.

Throws:

UMException

updateLocalUser

void updateLocalUser(User updatedUser,
                     java.lang.String oldPassword,
                     java.lang.String newPassword)
                     throws UMException

Updates a local user. For example, you could use this method to change the Administrator's password.

Parameters:

updatedUser - The updated user information.

oldPassword - The user's old password.

newPassword - The user's new password. Use null if you do not want to change the password.

Throws:

UMException

addPrincipalToLocalGroup

void addPrincipalToLocalGroup(java.lang.String principalOid,
                              java.lang.String localGroupOid)
                              throws UMException

Adds a principal to an existing local group.

Parameters:

principalOid - The principal identifier.

localGroupOid - The local group identifier.

Throws:

UMException

removePrincipalFromLocalGroup

void removePrincipalFromLocalGroup(java.lang.String principalOid,
                                   java.lang.String localGroupOid)
                                   throws UMException

Removes a principal from an existing local group.

Parameters:

principalOid - The principal identifier.

localGroupOid - The local group identifier.

Throws:

UMException

findDomains

java.util.List findDomains()
                           throws UMException

Enumerates all domains in the system.

Returns:

A java.util.List containing all the Domain objects in the system.

Throws:

UMException

findGroups

java.util.List findGroups(PrincipalSearchFilter searchFilter)
                          throws UMException

Deprecated.

Finds the groups according to the specified search filter. Use findPrincipals(PrincipalSearchFilter).

Parameters:

searchFilter - The search filter specifying the groups to be returned.

Returns:

A java.util.List containing all the Group objects found according to the specified search criteria.

Throws:

UMException

findUsers

java.util.List findUsers(PrincipalSearchFilter searchFilter)
                         throws UMException

Deprecated.

Finds the users according to the specified search filter. Use findPrincipals(PrincipalSearchFilter).

Parameters:

searchFilter - The search filter specifying the users to be returned.

Returns:

A java.util.List containing all the User objects found according to the specified search criteria.

Throws:

UMException

findPrincipals

java.util.List findPrincipals(PrincipalSearchFilter searchFilter,
                              java.lang.String principalType)
                              throws UMException

Deprecated.

Finds the principals according to the specified search filter and the specified principal type. Use findPrincipals(PrincipalSearchFilter).

Parameters:

searchFilter - The search filter specifying the principals to be returned.

principalType - The type of the principals to be retrieved.

Returns:

A java.util.List containing all the Principal objects found according to the specified search criteria and principal type.

Throws:

UMException

findPrincipals

java.util.List findPrincipals(PrincipalSearchFilter searchFilter)
                              throws UMException

Finds the principals according to the specified search filter

Parameters:

searchFilter - The search filter specifying the principals to be returned.

Returns:

A java.util.List containing all the Principal objects found according to the specified search criteria and principal type.

Throws:

UMException

findPrincipalReferences

java.util.List findPrincipalReferences(PrincipalSearchFilter searchFilter,
                                       java.lang.String principalType)
                                       throws UMException

Deprecated.

Finds the principals according to the specified search filter and the specified principal type. Use findPrincipalReferences(PrincipalSearchFilter)

Parameters:

searchFilter - The search filter specifying the principals to be returned.

principalType - The type of the principals to be retrieved.

Returns:

A java.util.List containing all references PrincipalReference for the principals found according to the specified search criteria and principal type.

Throws:

UMException

findPrincipalReferences

java.util.List findPrincipalReferences(PrincipalSearchFilter searchFilter)
                                       throws UMException

Finds the principals according to the specified search filter and the specified principal type.

Parameters:

searchFilter - The search filter specifying the principals to be returned.

Returns:

A java.util.List containing all references PrincipalReference for the principals found according to the specified search criteria and principal type.

Throws:

UMException

findPrincipal

Principal findPrincipal(java.lang.String oid)
                        throws UMException

Retrieves a principal according to the specified identifier.

Parameters:

oid - The principal identifier.

Returns:

The principal to be retrieved.

Throws:

UMException

findPrincipalReference

PrincipalReference findPrincipalReference(java.lang.String oid)
                                          throws UMException

Retrieves a principal reference according to the specified identifier.

Parameters:

oid - The principal identifier.

Returns:

A reference PrincipalReference for the principal to be retrieved.

Throws:

UMException

findPrincipalReference

java.util.Map findPrincipalReference(java.util.List principalOids)
                                     throws UMException

Retrieves principal references according to the specified identifiers.

Parameters:

principalOids - A List containing the principal identifiers.

Returns:

A Map whose keys are the principal identifiers and whose values are references PrincipalReference for the principals.

Throws:

UMException

findPrincipal

Principal findPrincipal(java.lang.String domainName,
                        java.lang.String canonicalName)
                        throws UMException

Retrieves a principal according to the specified domain name and canonical name.

Parameters:

domainName - The domain name of the principal.

canonicalName - The canonical name of the principal.

Returns:

The principal to be retrieved.

Throws:

UMException

findPrincipalReference

PrincipalReference findPrincipalReference(java.lang.String domainName,
                                          java.lang.String canonicalName)
                                          throws UMException

Retrieves a principal reference according to the specified domain name and canonical name.

Parameters:

domainName - The domain name of the principal.

canonicalName - The canonical name of the principal.

Returns:

A reference PrincipalReference for the principal to be retrieved.

Throws:

UMException

findPrincipals

java.util.Map findPrincipals(java.util.List principalOids)
                             throws UMException

Retrieves principals according to the specified identifiers.

Parameters:

principalOids - A List of principal identifiers.

Returns:

A Map whose keys are the principal identifiers and whose values are the principals.

Throws:

UMException

findPrincipals

java.util.List findPrincipals(PrincipalSearchFilter searchFilter,
                              java.util.List principalOids)
                              throws UMException

Deprecated.

Finds the principals according to the specified search filter. The search is limited to the principals represented by the identifiers in the List. Use findPrincipals(PrincipalSearchFilter).

Parameters:

searchFilter - The search filter specifying the principals to be returned.

principalOids - A java.util.List of principal identifiers used to limit the search.

Returns:

A List containing all the Principal objects found.

Throws:

UMException

findPrincipalStatus

java.util.Map findPrincipalStatus(java.util.Set principalReferences)
                                  throws UMException

Retrieves the status for the specified principals. In each case, the status will indicate wither the principal is active, has been deleted, or does not refer to any existing principal.

Parameters:

principalReferences - A java.util.Set of principal references PrincipalReference.

Returns:

A java.util.Map whose keys are principal references and whose values are the corresponding status in each case.

Throws:

UMException

See Also:

UMConstants

findPrincipalsByEmailId

java.util.Map findPrincipalsByEmailId(java.util.Set emailIds)
                                      throws UMException

Finds the principals having the specified email identifiers.

Parameters:

emailIds - A java.util.Set of email identifiers for the principals.

Returns:

A java.util.Map whose key is the email identifier and whose value is a java.util.Set containing the corresponding principals.

Throws:

UMException

findGroupMembers

java.util.List findGroupMembers(GroupMembershipSearchFilter gsf)
                                throws UMException

Finds user and group members contained with a group.

Parameters:

gsf - The group membership search filter used for the search.

Returns:

The user and group members contained with the group.

Throws:

UMException

findPrincipals

java.util.Map findPrincipals(java.util.Set principalReferences)
                             throws UMException

Finds the principals having the specified principal references.

Parameters:

principalReferences - The principal references.

Returns:

A java.util.Map whose key is the principal reference and whose value is a java.util.Set containing the corresponding principals.

Throws:

UMException

getBusinessCalendarKeyforUser

java.lang.String getBusinessCalendarKeyforUser(java.lang.String oid)
                                               throws UMException

Returns the business calendar key attribute value for the user whose oid has been passed in. Null is returned if the passed in Oid is a group Oid.

Parameters:

oid - The principal Oid.

Returns:

A java.lang.String containing the Calender key for the User.

Throws:

UMException

getAllBusinessCalendarKeys

java.util.List getAllBusinessCalendarKeys()
                                          throws UMException

Returns a unique set of all the business calendar attribute values. The set is evaluated across all the users that exist in LC system.

Returns:

A java.util.List containing java.lang.String values for All Business Calender Keys.

Throws:

UMException

createAllowedURIsList

void createAllowedURIsList(java.lang.String listId,
                           java.util.List allowedURIs)
                           throws UMException

Creates a list of allowed URI's to be white-listed for any calling referer

Parameters:

listId - A java.lang.String id that identifies the List.

allowedURIs - A java.uitl.List of all white listed URI's

Throws:

UMException

getAllowedURIsList

java.util.List getAllowedURIsList(java.lang.String listId)
                                  throws UMException

Returns a list of all white listed URIs existing in the input list id.

Parameters:

listId - A java.lang.String id that identifies the List.

Returns:

A java.util.List containing java.lang.String values for white listed URIs.

Throws:

UMException

updateAllowedURIsList

void updateAllowedURIsList(java.lang.String listId,
                           java.util.List allowedURIs)
                           throws UMException

Updates a list of allowed URI's to be white-listed for any calling referer. If list doesn't exists than it creates a new one.

Parameters:

listId - A java.lang.String id that identifies the List.

allowedURIs - A java.uitl.List of all white listed URI's

Throws:

UMException

deleteAllowedURIsList

void deleteAllowedURIsList(java.lang.String listId)
                           throws UMException

Deletes the list of white listed URIs with the input list Id.

Parameters:

listId - A java.lang.String id that identifies the List.

Throws:

UMException

getAllowedReferers

java.util.List getAllowedReferers()
                                  throws UMException

Returns a list of all allowed Referers.

Returns:

A java.util.List containing java.lang.String values for white listed Referers.

Throws:

UMException

getDynamicGroupCriteriaAttributes

java.util.List getDynamicGroupCriteriaAttributes()
                                                 throws UMException

Returns a list of all attributes which are being used as criteria in creation of Dynamic Groups.

Returns:

A java.util.List containing java.lang.Integer values for Dynamic Group Attributes.

Throws:

UMException

See Also:

DynamicGroupMembershipCriteria#membership_canonicalName}, DynamicGroupMembershipCriteria#membership_commonName}, DynamicGroupMembershipCriteria#membership_domainName}, DynamicGroupMembershipCriteria#membership_email}

addAllowedRefererExceptions

void addAllowedRefererExceptions(java.lang.String listId,
                                 java.util.List refererExceptions)
                                 throws UMException

Creates a list of exceptions of Allowed Referers for which a request will be blocked

Parameters:

listId - A java.lang.String id that identifies the List.

allowedURIs - A java.uitl.List of all Allowed Referer Exceptions

Throws:

UMException

getAllowedRefererExceptions

java.util.List getAllowedRefererExceptions(java.lang.String listId)
                                           throws UMException

Returns a list of Allowed Referer Exception existing in the input list id.

Parameters:

listId - A java.lang.String id that identifies the List.

Returns:

A java.util.List containing java.lang.String values for Allowed Referer Exceptions

Throws:

UMException

updateAllowedRefererExceptions

void updateAllowedRefererExceptions(java.lang.String listId,
                                    java.util.List refererExceptions)
                                    throws UMException

Updates a list of exceptions of Allowed Referers for which a request will be blocked. If list doesn't exists than it creates a new one.

Parameters:

listId - A java.lang.String id that identifies the List.

allowedURIs - A java.uitl.List of all Allowed Referer Exceptions

Throws:

UMException

deleteAllowedRefererExceptions

void deleteAllowedRefererExceptions(java.lang.String listId)
                                    throws UMException

Deletes the list of Allowed Referer Exceptions with the input list Id.

Parameters:

listId - A java.lang.String id that identifies the List.

Throws:

UMException