Packagecom.adobe.idp.um.api
Interfacepublic interface DirectoryManager

This is the primary interface for directory management.


Public Methods
 MethodDefined By
  
void addPrincipalToLocalGroup(String principalOid, String localGroupOid)
Adds a principal to an existing local group.
DirectoryManager
  
String createDirectoryPrincipal(Principal principal)
Creates a new directory principal.
DirectoryManager
  
void createDomain(Domain d)
Creates a domain in the system.
DirectoryManager
  
String createLocalGroup(Group localGroup)
Creates a new local group.
DirectoryManager
  
String createLocalSystemUser(User p)
Creates a new local system user.
DirectoryManager
  
String createLocalUser(User localUser, String password)
Creates a new local user.
DirectoryManager
  
String createLocalUser(User localUser, String hashedPassword, String salt)
Creates a new local user.
DirectoryManager
  
Map createLocalUsers(Set userInfo)
Creates a set of new local users.
DirectoryManager
  
void deleteDomain(String domainName)
Deletes the domain and all associated principals from the system.
DirectoryManager
  
void deleteLocalGroup(String groupOid)
Deletes the specified local group.
DirectoryManager
  
void deleteLocalUser(String userOid)
Deletes a local user from the system.
DirectoryManager
  
Domain findDomain(String domainName)
Retrieves the domain with the specified name.
DirectoryManager
  
List findDomains()
Enumerates all domains in the system.
DirectoryManager
  
List findGroupMembers(GroupMembershipSearchFilter gsf)
Finds user and group members contained with a group.
DirectoryManager
  
List findGroups(PrincipalSearchFilter searchFilter)
Finds the groups according to the specified search filter.
DirectoryManager
  
Principal findPrincipal(String oid)
Retrieves a principal according to the specified identifier.
DirectoryManager
  
Principal findPrincipal(String domainName, String canonicalName)
Retrieves a principal according to the specified domain name and canonical name.
DirectoryManager
  
PrincipalReference findPrincipalReference(String oid)
Retrieves a principal reference according to the specified identifier.
DirectoryManager
  
Map findPrincipalReference(List principalOids)
Retrieves principal references according to the specified identifiers.
DirectoryManager
  
PrincipalReference findPrincipalReference(String domainName, String canonicalName)
Retrieves a principal reference according to the specified domain name and canonical name.
DirectoryManager
  
List findPrincipalReferences(PrincipalSearchFilter searchFilter, String principalType)
Finds the principals according to the specified search filter and the specified principal type.
DirectoryManager
  
List findPrincipalReferences(PrincipalSearchFilter searchFilter)
Finds the principals according to the specified search filter and the specified principal type.
DirectoryManager
  
List findPrincipals(PrincipalSearchFilter searchFilter, String principalType)
Finds the principals according to the specified search filter and the specified principal type.
DirectoryManager
  
List findPrincipals(PrincipalSearchFilter searchFilter)
Finds the principals according to the specified search filter
DirectoryManager
  
Map findPrincipals(List principalOids)
Retrieves principals according to the specified identifiers.
DirectoryManager
  
List findPrincipals(PrincipalSearchFilter searchFilter, List principalOids)
Finds the principals according to the specified search filter.
DirectoryManager
  
Map findPrincipals(Set principalReferences)
Finds the principals having the specified principal references.
DirectoryManager
  
Map findPrincipalsByEmailId(Set emailIds)
Finds the principals having the specified email identifiers.
DirectoryManager
  
Map findPrincipalStatus(Set principalReferences)
Retrieves the status for the specified principals.
DirectoryManager
  
List findUsers(PrincipalSearchFilter searchFilter)
Finds the users according to the specified search filter.
DirectoryManager
  
List getAllBusinessCalendarKeys()
Returns a unique set of all the business calendar attribute values.
DirectoryManager
  
String getBusinessCalendarKeyforUser(String oid)
Returns the business calendar key attribute value for the user whose oid has been passed in.
DirectoryManager
  
Map getDirectorySyncStatus(Set domainNames)
Retrieves the synchronization status for the java.util.Set of domains.
DirectoryManager
  
Group getDomainAsGroup(String domainName)
Retrieves the associated group with the specified domain.
DirectoryManager
  
void removePrincipalFromLocalGroup(String principalOid, String localGroupOid)
Removes a principal from an existing local group.
DirectoryManager
  
void updateDomain(Domain updatedDom)
Updates the mutable fields in a domain.
DirectoryManager
  
void updateLocalGroup(Group updatedGroup)
Updates information in the group.
DirectoryManager
  
void updateLocalUser(User updatedUser, String password)
Updates a local user.
DirectoryManager
  
void updateLocalUser(User updatedUser, String oldPassword, String newPassword)
Updates a local user.
DirectoryManager
Method Detail
addPrincipalToLocalGroup()
public void addPrincipalToLocalGroup(String principalOid, String localGroupOid)

Adds a principal to an existing local group.

Parameters

principalOid — The principal identifier.
 
localGroupOid — The local group identifier.


Throws
UMException
createDirectoryPrincipal() 
public String createDirectoryPrincipal(Principal principal)

Creates a new directory principal.

Parameters

principal — directory principal to be created in the system.

Returns
The directory principal identifier.

Throws
UMException
createDomain() 
public void createDomain(Domain d)

Creates a domain in the system.

Parameters

d — The domain to be created.


Throws
UMException
createLocalGroup() 
public String createLocalGroup(Group localGroup)

Creates a new local group.

Parameters

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

Returns
The local group identifier.

Throws
UMException
createLocalSystemUser() 
public String createLocalSystemUser(User p)

Creates a new local system user.

Parameters

p — The new local system user.

Returns
The local system user identifier.

Throws
UMException
createLocalUser() 
public String createLocalUser(User localUser, String password)

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() 
public String createLocalUser(User localUser, String hashedPassword, String salt)

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() 
public Map createLocalUsers(Set userInfo)

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 com.adobe.idp.um.api.infomodel.UserInfo instances that represent each user's object and password.

Returns
A java.util.Map whose keys are the com.adobe.idp.um.api.infomodel.UserInfo instances and whose values are the automatically generated corresponding local user identifiers.

Throws
UMException
deleteDomain() 
public void deleteDomain(String domainName)

Deletes the domain and all associated principals from the system.

Parameters

domainName — The domain to be deleted.


Throws
UMException
deleteLocalGroup() 
public void deleteLocalGroup(String groupOid)

Deletes the specified local group.

Parameters

groupOid — The local group identifier.


Throws
UMException
deleteLocalUser() 
public void deleteLocalUser(String userOid)

Deletes a local user from the system.

Parameters

userOid — The local user's identifier.


Throws
UMException
findDomain() 
public Domain findDomain(String domainName)

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
findDomains() 
public List findDomains()

Enumerates all domains in the system.

Returns
A java.util.List containing all the com.adobe.idp.um.api.infomodel.Domain objects in the system.

Throws
UMException
findGroupMembers() 
public List findGroupMembers(GroupMembershipSearchFilter gsf)

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
findGroups() 
public List findGroups(PrincipalSearchFilter searchFilter)
Deprecated:

Finds the groups according to the specified search filter.

Parameters

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

Returns
A java.util.List containing all the com.adobe.idp.um.api.infomodel.Group objects found according to the specified search criteria.

Throws
UMException
findPrincipal() 
public Principal findPrincipal(String oid)

Retrieves a principal according to the specified identifier.

Parameters

oid — The principal identifier.

Returns
The principal to be retrieved.

Throws
UMException
findPrincipal() 
public Principal findPrincipal(String domainName, String canonicalName)

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.
findPrincipalReference() 
public PrincipalReference findPrincipalReference(String oid)

Retrieves a principal reference according to the specified identifier.

Parameters

oid — The principal identifier.

Returns
A reference com.adobe.idp.um.api.infomodel.PrincipalReference for the principal to be retrieved.

Throws
UMException
findPrincipalReference() 
public Map findPrincipalReference(List principalOids)

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 com.adobe.idp.um.api.infomodel.PrincipalReference for the principals.

Throws
UMException
findPrincipalReference() 
public PrincipalReference findPrincipalReference(String domainName, String canonicalName)

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 com.adobe.idp.um.api.infomodel.PrincipalReference for the principal to be retrieved.
findPrincipalReferences() 
public List findPrincipalReferences(PrincipalSearchFilter searchFilter, String principalType)
Deprecated:

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.
 
principalType — The type of the principals to be retrieved.

Returns
A java.util.List containing all references com.adobe.idp.um.api.infomodel.PrincipalReference for the principals found according to the specified search criteria and principal type.

Throws
UMException
findPrincipalReferences() 
public List findPrincipalReferences(PrincipalSearchFilter searchFilter)

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 com.adobe.idp.um.api.infomodel.PrincipalReference for the principals found according to the specified search criteria and principal type.

Throws
UMException
findPrincipals() 
public List findPrincipals(PrincipalSearchFilter searchFilter, String principalType)
Deprecated:

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.
 
principalType — The type of the principals to be retrieved.

Returns
A java.util.List containing all the com.adobe.idp.um.api.infomodel.Principal objects found according to the specified search criteria and principal type.

Throws
UMException
findPrincipals() 
public List findPrincipals(PrincipalSearchFilter searchFilter)

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 com.adobe.idp.um.api.infomodel.Principal objects found according to the specified search criteria and principal type.

Throws
UMException
findPrincipals() 
public Map findPrincipals(List principalOids)

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() 
public List findPrincipals(PrincipalSearchFilter searchFilter, List principalOids)
Deprecated:

Finds the principals according to the specified search filter. The search is limited to the principals represented by the identifiers in the List.

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 com.adobe.idp.um.api.infomodel.Principal objects found.

Throws
UMException
findPrincipals() 
public Map findPrincipals(Set principalReferences)

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
findPrincipalsByEmailId() 
public Map findPrincipalsByEmailId(Set emailIds)

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
findPrincipalStatus() 
public Map findPrincipalStatus(Set principalReferences)

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 — java.util.List of principal references com.adobe.idp.um.api.infomodel.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
findUsers() 
public List findUsers(PrincipalSearchFilter searchFilter)
Deprecated:

Finds the users according to the specified search filter.

Parameters

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

Returns
A java.util.List containing all the com.adobe.idp.um.api.infomodel.User objects found according to the specified search criteria.

Throws
UMException
getAllBusinessCalendarKeys() 
public List getAllBusinessCalendarKeys()

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
getBusinessCalendarKeyforUser() 
public String getBusinessCalendarKeyforUser(String oid)

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
getDirectorySyncStatus() 
public Map getDirectorySyncStatus(Set domainNames)

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 (com.adobe.idp.um.api.infomodel.DirectorySyncInfo) objects.

Throws
UMException

See also

DirectorySyncInfo
getDomainAsGroup() 
public Group getDomainAsGroup(String domainName)

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
removePrincipalFromLocalGroup() 
public void removePrincipalFromLocalGroup(String principalOid, String localGroupOid)

Removes a principal from an existing local group.

Parameters

principalOid — The principal identifier.
 
localGroupOid — The local group identifier.


Throws
UMException
updateDomain() 
public void updateDomain(Domain updatedDom)

Updates the mutable fields in a domain. Call findDomains() to retrieve the com.adobe.idp.um.api.infomodel.Domain object to be updated.

Parameters

updatedDom


Throws
UMException

See also

findDomains()
updateLocalGroup() 
public void updateLocalGroup(Group updatedGroup)

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 com.adobe.idp.um.api.infomodel.Group), and invoke the object's setDescription() method.

Parameters

updatedGroup — The group to be updated.


Throws
UMException
updateLocalUser() 
public void updateLocalUser(User updatedUser, String password)

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() 
public void updateLocalUser(User updatedUser, String oldPassword, String newPassword)

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



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/DirectoryManager.html