com.iplanet.am.sdk
Interface AMPeopleContainer

All Superinterfaces:

AMConstants, AMObject

public interface AMPeopleContainer

extends AMObject

The PeopleContainer interface provides methods to manage people container

Fields inherited from interface com.iplanet.am.sdk.AMObject

ASSIGNABLE_DYNAMIC_GROUP, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNKNOWN_OBJECT_TYPE, USER

Fields inherited from interface com.iplanet.am.sdk.AMConstants

SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE

Method Summary

java.util.Set	createSubPeopleContainers(java.util.Map peopleContainers) Creates sub people containers and initializes their attributes.
java.util.Set	createSubPeopleContainers(java.util.Set peopleContainersNames) Creates sub PeopleContainers in this people container.
java.util.Set	createUsers(java.util.Map users) Creates users and initializes their attributes.
java.util.Set	createUsers(java.util.Map users, java.util.Set serviceNames) Creates users and initializes their attributes.
java.util.Set	createUsers(java.util.Set users) Creates users in this people container.
void	deleteSubPeopleContainers(java.util.Set peopleContainers) Deletes sub people containers in this people container.
void	deleteUsers(java.util.Set users) Deletes users from this people container.
long	getNumberOfSubPeopleContainers() Gets number of sub peoople containers in the people container.
long	getNumberOfUsers() Gets number of users in the people container.
java.util.Set	getSubPeopleContainerDNs(int level) Gets the sub containers in this people container.
java.util.Set	getUserDNs() Gets the names (DNs) of users in the people container.
java.util.Set	searchSubPeopleContainers(java.lang.String wildcard, int level) Searches for sub people containers in this people container using wildcards and attribute values.
java.util.Set	searchSubPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, int level) Searches for sub people containers in this people container using wildcards and attribute values.
AMSearchResults	searchUsers(com.iplanet.am.sdk.AMSearchControl searchControl, java.lang.String avfilter) Searches for users in this people container using attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, com.iplanet.am.sdk.AMSearchControl searchControl) Searches for users in this people container using wildcards and attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, com.iplanet.am.sdk.AMSearchControl searchControl, java.lang.String avfilter) Searches for users in this people container using wildcards and attribute values.
java.util.Set	searchUsers(java.lang.String wildcard, int level) Searches for users in this people container using wildcards and attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, java.util.Map avPairs, com.iplanet.am.sdk.AMSearchControl searchControl) Searches for users in this group using wildcards and attribute values.
java.util.Set	searchUsers(java.lang.String wildcard, java.util.Map avPairs, int level) Searches for users in this group using wildcards and attribute values.

Methods inherited from interface com.iplanet.am.sdk.AMObject

addEventListener, assignPolicies, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getStringAttribute, getTemplate, isExists, removeAttributes, removeEventListener, search, setAttributes, setStringAttribute, store, unassignPolicies

Method Detail

createUsers

public java.util.Set createUsers(java.util.Set users)
                          throws AMException,
                                 SSOException

Creates users in this people container. For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added. If a corresponding template does not exist, the default values are picked up from schema.

Parameters:

users - The set of user names to be created in this people container.

Returns:

Set Set of User objects created

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

createUsers

public java.util.Set createUsers(java.util.Map users)
                          throws AMException,
                                 SSOException

Creates users and initializes their attributes. For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added. If a corresponding template does not exist, the default values are picked up from schema.

Parameters:

users - Map where the key is the name of the user, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set Set of User objects created

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

createUsers

public java.util.Set createUsers(java.util.Map users,
                                 java.util.Set serviceNames)
                          throws AMException,
                                 SSOException

Creates users and initializes their attributes.

Parameters:

users - Map where the key is the name of the user, and the value is a Map to represent Attribute-Value Pairs

serviceNames - Set of service names assigned to the users where the key is the name of the user, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set Set of User objects created

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

deleteUsers

public void deleteUsers(java.util.Set users)
                 throws AMException,
                        SSOException

Deletes users from this people container.

Parameters:

users - The set of user DN's to be deleted from the people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

getNumberOfUsers

public long getNumberOfUsers()
                      throws AMException,
                             SSOException

Gets number of users in the people container.

Returns:

Number of users in the people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

getUserDNs

public java.util.Set getUserDNs()
                         throws AMException,
                                SSOException

Gets the names (DNs) of users in the people container.

Returns:

Set The names(DNs) of users in the people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

createSubPeopleContainers

public java.util.Set createSubPeopleContainers(java.util.Set peopleContainersNames)
                                        throws AMException,
                                               SSOException

Creates sub PeopleContainers in this people container.

Parameters:

peopleContainers - The set of peopleContainer names to be created in this people container.

Returns:

Set set of PeopleContainer objects created

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

createSubPeopleContainers

public java.util.Set createSubPeopleContainers(java.util.Map peopleContainers)
                                        throws AMException,
                                               SSOException

Creates sub people containers and initializes their attributes.

Parameters:

users - Map where the key is the name of the people container, and the value is a Map to represent Attribute-Value Pairs

Set - Set of PeopleContainer objects created.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

getSubPeopleContainerDNs

public java.util.Set getSubPeopleContainerDNs(int level)
                                       throws AMException,
                                              SSOException

Gets the sub containers in this people container. It returns sub containers either at one level or a whole subtree.

Parameters:

level - the level(SCOPE_ONE or SCOPE_TREE) for returning subcontainers

Returns:

The sub container DNs in this people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store if the level is invalid

SSOException - if the sign on is no longer valid

getNumberOfSubPeopleContainers

public long getNumberOfSubPeopleContainers()
                                    throws AMException,
                                           SSOException

Gets number of sub peoople containers in the people container.

Returns:

Number of sub people containers in the people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

deleteSubPeopleContainers

public void deleteSubPeopleContainers(java.util.Set peopleContainers)
                               throws AMException,
                                      SSOException

Deletes sub people containers in this people container.

Parameters:

peopleContainers - The set of container DN's to be deleted from the people container.

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard,
                                 int level)
                          throws AMException,
                                 SSOException

Searches for users in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_TREE)

Returns:

Set DNs of Users matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   com.iplanet.am.sdk.AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for users in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a Set DNs of Users matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard,
                                 java.util.Map avPairs,
                                 int level)
                          throws AMException,
                                 SSOException

Searches for users in this group using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specifed so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_TREE)

Returns:

Set DNs of Users matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   com.iplanet.am.sdk.AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for users in this group using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specifed so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a Set DNs of Users matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   com.iplanet.am.sdk.AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException

Searches for users in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specifed so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.,

avfilter - this attribute-value pairs filter will be & with user search filter

Returns:

AMSearchResults which contains a Set DNs of Users matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(com.iplanet.am.sdk.AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException

Searches for users in this people container using attribute values. Wildcards such as a*, *, *a can be specified for the attribute values. The DNs of users with matching attribute-value pairs will be returned.

Parameters:

searchControl - specifies the search scope to be used, VLV ranges etc.,

avfilter - this attribute-value pairs filter will be & with user search filter

Returns:

AMSearchResults which contains a Set DNs of Users matching the search

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

searchSubPeopleContainers

public java.util.Set searchSubPeopleContainers(java.lang.String wildcard,
                                               int level)
                                        throws AMException,
                                               SSOException

Searches for sub people containers in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_TREE)

Returns:

Set DNs of people containers matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid

searchSubPeopleContainers

public java.util.Set searchSubPeopleContainers(java.lang.String wildcard,
                                               java.util.Map avPairs,
                                               int level)
                                        throws AMException,
                                               SSOException

Searches for sub people containers in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specifed so that DNs of people containers with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching people Containers

level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_TREE)

Returns:

Set DNs of people containers matching the search

Throws:

AMException - if an error is encountered when trying to access/retrieve data from the data store

SSOException - if the sign on is no longer valid