Programming tasks

Programming tasks using virtual member manager application programming interface are described in this section.

Creating an entity
Use the create(DataObject) method to create an entity.
Creating a group with an initial member
Use the create(DataObject) method to create a group with an initial person assigned to that group.
Performing a search
Use the search(DataObject) method to return a set of entities that match the search expression.
Performing a paged search
Use the search(DataObject) method and PageControl DataObject to set the number of items returned at any one time during a search.
Performing a sorted search
Use the search(DataObject) method and SortControl DataObject to specify the order of items returned during a search.
Searching for changed entities
Use the search(DataObject) method and the ChangeControl DataObject to query the federated repository for changed entities from a certain checkpoint onwards.
Getting the properties of an entity
Use the get(DataObject) method to obtain the properties of entities, group membership, group members, ancestors, and descendents by specifying the corresponding control.
Getting group membership
Use the get(DataObject) method and the GroupMembershipControl to show what groups an entity belongs to.
Getting group members
Use the get(DataObject) method and the GroupMemberControl to show what entities belong to a group.
Getting the ancestors of an entity
Use the get(DataObject) method and the AncestorControl to show the ancestors of an entity.
Getting the descendants of an entity
Use the get(DataObject) method and the DescendantControl to show the children of an entity.
Updating the properties of an entity
Use the update(DataObject) method and the PropertyControl to change the properties of an entity.
Assigning entities to a group
Use the update(DataObject) method and GroupMemberControl to assign one or more entities to a group.
Assigning an entity to multiple groups
Use the update(DataObject) method and GroupMembershipControl to assign an entity to one or more groups.
Unassigning entities from groups using GroupMemberControl
Use the update(DataObject) method and GroupMemberControl to remove one or more entities from one or more groups.
Unassigning entities from groups using GroupMembershipControl
Use the update(DataObject) method and GroupMembershipControl to remove one or more entities from one or more groups.
Renaming an entity
Use the update(DataObject) method to rename an entity.
Deleting entities
Use the delete (DataObject) method and DeleteControl to remove entries.
Creating an entity using an asynchronous adapter
Use the create(DataObject) method with an asynchronous adapter to create an entity.
Logging in
Use the login(DataObject) method and LoginControl to authenticate a user.
Testing a certificate map
Use this procedure to test the certificate map.
Creating a property type and adding it to an existing entity type
You can use the sample data graphs and code snippet provided here to create a property type, age, and add it to an existing entity type, PersonAccount.
Creating an entity type and adding a new property type to it
Use the data graph to create an entity type ContactPerson and add a new property cellPhone to it.
Creating an entity type and adding an existing property to it
Use the data graph to create an entity type ExtendedLogin and add an existing property type uid to it.
Dynamically adding a new base entry
Use this procedure to dynamically add a new base entry to the specified profile repository.
Dynamically adding a new profile repository
Use this procedure to dynamically add a new profile repository to the current configuration at runtime.
Dynamically adding a new realm
Use this procedure to dynamically add a new realm to the current configuration at runtime.
Dynamically adding a new default parent to a realm
Use this procedure to dynamically add a new default parent to a realm.
Dynamically adding a new participating base entry to a realm
Use this procedure to add a new participating base entry to a realm.
Dynamically adding a new entity type configuration
Use this procedure to dynamically add a new supported entity type configuration.
Dynamically adding a new property configuration
Use this procedure to dynamically add a new property configuration to the specified profile repository.
Dynamically adding a property extension repository
Use this procedure to dynamically add a property extension repository to the current configuration at runtime.
Dynamically updating the administrator password for a database repository
Use this procedure to dynamically update the database administrator password for a database repository.
Dynamically updating the administrator password for a property extension repository
Use this procedure to dynamically update the database administrator password for a property extension repository.
Dynamically updating the administrator password for an entry mapping repository
Use this procedure to dynamically update the database administrator password for an entry mapping repository.
Dynamically updating the bind DN and password for an LDAP repository
Use this procedure to dynamically update the LDAP bind information of the specified LDAP repository at runtime.
Dynamically resetting the bind DN and password of an LDAP repository
Use this procedure to dynamically reset the LDAP bind information of the specified LDAP repository at runtime.