com.iplanet.am.sdk

Interface AMPeopleContainer

All Superinterfaces:

AMConstants, AMObject

Deprecated.

As of Sun Java System Access Manager 7.1.

public interface AMPeopleContainer
extends AMObject

This interface provides methods to manage people container. AMPeopleContainer objects can be obtained by using AMStoreConnection. A handle to this object can be obtained by using the DN of the object.

 
 AMStoreConnection amsc = new AMStoreConnection(ssotoken); if
 (amsc.doesEntryExist(pcDN)) { AMPeopleContainer pc =
 amsc.getPeopleContainer(oDN); }
 
 

Field Summary

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

ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER

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

ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Method Summary

Modifier and Type	Method and Description
Set	createEntities(String stype, Map entities) Deprecated. Creates entities and initializes their attributes.
Set	createEntities(String type, Set entities) Deprecated. Create managed entities in this container.
Set	createResources(Map resourceMap) Deprecated. Create resources in this organization.
Set	createResources(Set resourceNames) Deprecated. Create resources in this organization.
Set	createSubPeopleContainers(Map peopleContainers) Deprecated. Creates sub people containers and initializes their attributes.
Set	createSubPeopleContainers(Set peopleContainersNames) Deprecated. Creates sub people containers in this people container.
AMUser	createUser(String uid, Map attrMap, Map serviceNameAndAttrs) Deprecated. Create user and initializes the attributes.
Set	createUsers(Map users) Deprecated. Creates users and initializes their attributes.
Set	createUsers(Map users, Set serviceNames) Deprecated. Creates users and initializes their attributes.
Set	createUsers(Set users) Deprecated. Creates users in this people container.
void	deleteEntities(Set resources) Deprecated. Deletes a set of resources in this people container.
void	deleteResources(Set resources) Deprecated. Deletes a set of resources in this people container.
void	deleteSubPeopleContainers(Set peopleContainers) Deprecated. Deletes sub people containers in this people container.
void	deleteUsers(Set users) Deprecated. Deletes users from this people container.
long	getNumberOfSubPeopleContainers() Deprecated. Gets number of sub people containers in the people container.
long	getNumberOfUsers() Deprecated. Gets number of users in the people container.
Set	getSubPeopleContainerDNs(int level) Deprecated. Gets the sub containers in this people container.
Set	getUserDNs() Deprecated. Gets the names (DNs) of users in the people container.
AMSearchResults	searchEntities(String wildcard, AMSearchControl searchControl, String avfilter, String eSearchTemplate) Deprecated. Searches for entities in this people container using wildcards and a filter.
Set	searchEntities(String wildcard, int level, String eSearchTemplate, Map avPairs) Deprecated. Searches for resources in this organization using wildcards and attribute values.
AMSearchResults	searchEntities(String wildcard, Map avPairs, String eSearchTemplate, AMSearchControl searchControl) Deprecated. Searches for entities in this people container using wildcards and attribute values.
Set	searchResources(String wildcard, int level, String resourceSearchTemplate, Map avPairs) Deprecated. Searches for resources in this organization using wildcards and attribute values.
AMSearchResults	searchResources(String wildcard, Map avPairs, String rSearchTemplate, AMSearchControl searchControl) Deprecated. Searches for resources in this people container using wildcards and attribute values.
Set	searchSubPeopleContainers(String wildcard, int level) Deprecated. Searches for sub people containers in this people container using wildcards and attribute values.
Set	searchSubPeopleContainers(String wildcard, Map avPairs, int level) Deprecated. Searches for sub people containers in this people container using wildcards and attribute values.
AMSearchResults	searchUsers(AMSearchControl searchControl, String avfilter) Deprecated. Searches for users in this people container using attribute values.
AMSearchResults	searchUsers(String wildcard, AMSearchControl searchControl) Deprecated. Searches for users in this people container using wildcards and attribute values.
AMSearchResults	searchUsers(String wildcard, AMSearchControl searchControl, String avfilter) Deprecated. Searches for users in this people container using wildcards and attribute values.
Set	searchUsers(String wildcard, int level) Deprecated. Searches for users in this people container using wildcards and attribute values.
Set	searchUsers(String wildcard, int level, String userSearchTemplate, Map avPairs) Deprecated. Searches for users in this organization using wildcards and attribute values.
AMSearchResults	searchUsers(String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated. Searches for users in this group using wildcards and attribute values.
Set	searchUsers(String wildcard, Map avPairs, int level) Deprecated. Searches for users in this group using wildcards and attribute values.
AMSearchResults	searchUsers(String wildcard, Map avPairs, String userSearchTemplate, AMSearchControl searchControl) Deprecated. Searches for users in this people container using wildcards and attribute values.

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

addEventListener, assignPolicies, assignServices, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAssignedServices, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getAttributesFromDataStore, getAttributesFromDataStore, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getServiceStatus, getStringAttribute, getTemplate, isExists, modifyService, purge, removeAttributes, removeEventListener, search, setAttributeByteArray, setAttributes, setAttributesByteArray, setServiceStatus, setStringAttribute, store, store, unassignPolicies, unassignServices

Method Detail

createUsers

Set createUsers(Set users)
         throws AMException,
                SSOException

Deprecated.

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 single sign on token is no longer valid

createUsers

Set createUsers(Map users)
         throws AMException,
                SSOException

Deprecated.

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 single sign on token is no longer valid

createUsers

Set createUsers(Map users,
                Set serviceNames)
         throws AMException,
                SSOException

Deprecated.

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 single sign on token is no longer valid

createUser

AMUser createUser(String uid,
                  Map attrMap,
                  Map serviceNameAndAttrs)
           throws AMException,
                  SSOException

Deprecated.

Create user and initializes the 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. Also services as defined in the arguments, are assigned to the user, with default values being picked up from the service schema if none are provided for required attributes of the service.

Parameters:

uid - value of naming attribute for user.

attrMap - attribute-values to be set in the user entry.

serviceNameAndAttrs - service names and attributes to be assigned to the user.

Returns:

AMUser object of newly created user.

Throws:

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

SSOException - if the single sign on token is no longer valid.

deleteUsers

void deleteUsers(Set users)
          throws AMException,
                 SSOException

Deprecated.

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 single sign on token is no longer valid

getNumberOfUsers

long getNumberOfUsers()
               throws AMException,
                      SSOException

Deprecated.

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 single sign on token is no longer valid

getUserDNs

Set getUserDNs()
        throws AMException,
               SSOException

Deprecated.

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 single sign on token is no longer valid

createSubPeopleContainers

Set createSubPeopleContainers(Set peopleContainersNames)
                       throws AMException,
                              SSOException

Deprecated.

Creates sub people containers in this people container.

Parameters:

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

Returns:

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 single sign on token is no longer valid

createSubPeopleContainers

Set createSubPeopleContainers(Map peopleContainers)
                       throws AMException,
                              SSOException

Deprecated.

Creates sub people containers and initializes their attributes.

Parameters:

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

Returns:

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 single sign on token is no longer valid.

getSubPeopleContainerDNs

Set getSubPeopleContainerDNs(int level)
                      throws AMException,
                             SSOException

Deprecated.

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 sub containers

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 and if the level is invalid.

SSOException - if the single sign on token is no longer valid.

getNumberOfSubPeopleContainers

long getNumberOfSubPeopleContainers()
                             throws AMException,
                                    SSOException

Deprecated.

Gets number of sub people 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 single sign on token is no longer valid

deleteSubPeopleContainers

void deleteSubPeopleContainers(Set peopleContainers)
                        throws AMException,
                               SSOException

Deprecated.

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 single sign on token is no longer valid

searchUsers

Set searchUsers(String wildcard,
                int level)
         throws AMException,
                SSOException

Deprecated.

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 single sign on token is no longer valid

searchUsers

Set searchUsers(String wildcard,
                int level,
                String userSearchTemplate,
                Map avPairs)
         throws AMException,
                SSOException

Deprecated.

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK users the userSearchTemplate, if provided. Otherwise, it uses the BasicUserSearchTemplate. Any %U in the search template are replaced with the wildcard.

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)

userSearchTemplate - Name of search template to use. If null is passed then the default search template BasicUserSearch is used.

avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.

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 single sign on token is no longer valid

searchUsers

AMSearchResults searchUsers(String wildcard,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException

Deprecated.

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 single sign on token is no longer valid

searchUsers

Set searchUsers(String wildcard,
                Map avPairs,
                int level)
         throws AMException,
                SSOException

Deprecated.

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 specified 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 single sign on token is no longer valid

searchUsers

AMSearchResults searchUsers(String wildcard,
                            Map avPairs,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException

Deprecated.

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 specified 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 single sign on token is no longer valid

searchUsers

AMSearchResults searchUsers(String wildcard,
                            AMSearchControl searchControl,
                            String avfilter)
                     throws AMException,
                            SSOException

Deprecated.

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 specified 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 logical AND 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 single sign on token is no longer valid.

searchUsers

AMSearchResults searchUsers(AMSearchControl searchControl,
                            String avfilter)
                     throws AMException,
                            SSOException

Deprecated.

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 logical AND 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 single sign on token is no longer valid

searchUsers

AMSearchResults searchUsers(String wildcard,
                            Map avPairs,
                            String userSearchTemplate,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException

Deprecated.

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 specified 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

userSearchTemplate - Name of user search template to be used.

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 single sign on token is no longer valid

createResources

Set createResources(Set resourceNames)
             throws AMException,
                    SSOException

Deprecated.

Create resources in this organization. Resource is a specialized entity, which is created in the people container and is a leaf node.

Parameters:

resourceNames - Names of the resources to be created.

Returns:

Set of AMResource objects

Throws:

AMException - If there is an error when trying to save to the data store

SSOException - If the SSO Token is invalid.

createResources

Set createResources(Map resourceMap)
             throws AMException,
                    SSOException

Deprecated.

Create resources in this organization. Resource is a specialized entity, which is created in the people container and is a leaf node.

Parameters:

resourceMap - Map of resource names to be created and attributes to be set in the newly creates resource.

Returns:

Set of AMResource objects.

Throws:

AMException - If there is an error when trying to save to the data store

SSOException - If the SSO Token is invalid.

createEntities

Set createEntities(String type,
                   Set entities)
            throws AMException,
                   SSOException

Deprecated.

Create managed entities in this container. Supported entities, as defined in the configuration service DAI, can be created using this method.

Parameters:

type - Type of entity to be create (For example "user" or "agent")

entities - Set of names for the entities to be created

Returns:

Set of AMEntity objects

Throws:

AMException - If there is an error when trying to save to the data store

SSOException - If the SSO Token is invalid.

createEntities

Set createEntities(String stype,
                   Map entities)
            throws AMException,
                   SSOException

Deprecated.

Creates entities and initializes their attributes. Supported entities, as defined in the configuration service DAI, can be created using this method.

Parameters:

stype - Type of entity to be create (For example "user" or "agent")

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

Returns:

Set Set of AMEntity objects created

Throws:

AMException - if an error is encountered when trying to create entity in the data store.

SSOException - if the single sign on token is no longer valid

searchResources

Set searchResources(String wildcard,
                    int level,
                    String resourceSearchTemplate,
                    Map avPairs)
             throws AMException,
                    SSOException

Deprecated.

Searches for resources in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK uses the resourceSearchTemplate, if provided. Otherwise, it uses the BasicResourceSearchTemplate.

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)

resourceSearchTemplate - Name of resource search template to be used.

avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.

Returns:

Set DNs of resources matching the search

Throws:

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

SSOException - if the single sign on token is no longer valid.

searchResources

AMSearchResults searchResources(String wildcard,
                                Map avPairs,
                                String rSearchTemplate,
                                AMSearchControl searchControl)
                         throws AMException,
                                SSOException

Deprecated.

Searches for resources 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 specified 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

rSearchTemplate - Name of resource search template to be used.

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

Returns:

AMSearchResults which contains a Set DNs of resources matching the search.

Throws:

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

SSOException - if the single sign on token is no longer valid

searchEntities

Set searchEntities(String wildcard,
                   int level,
                   String eSearchTemplate,
                   Map avPairs)
            throws AMException,
                   SSOException

Deprecated.

Searches for resources in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK uses the eSearchTemplate, if provided. Otherwise, it uses the BasicEntitySearch template.

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_SUB)

eSearchTemplate - Name of search template to be used.

avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.

Returns:

Set DNs of resources matching the search

Throws:

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

SSOException - if the single sign on token is no longer valid.

searchEntities

AMSearchResults searchEntities(String wildcard,
                               Map avPairs,
                               String eSearchTemplate,
                               AMSearchControl searchControl)
                        throws AMException,
                               SSOException

Deprecated.

Searches for entities 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 specified 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

eSearchTemplate - Name of search template to be used.

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

Returns:

AMSearchResults which contains a Set DNs of resources matching the search.

Throws:

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

SSOException - if the single sign on token is no longer valid

searchEntities

AMSearchResults searchEntities(String wildcard,
                               AMSearchControl searchControl,
                               String avfilter,
                               String eSearchTemplate)
                        throws AMException,
                               SSOException

Deprecated.

Searches for entities in this people container using wildcards and a filter. Wildcards can be specified such as a*, *, *a. To further refine the search, a filter can be passed, which is used to further qualify the basic entity search filter.

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 logical AND with user search filter.

eSearchTemplate - Name of search template to be used. If a null is passed then the default search template for entities BasicEntitySearch is used.

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 single sign on token is no longer valid

deleteResources

void deleteResources(Set resources)
              throws AMException,
                     SSOException

Deprecated.

Deletes a set of resources in this people container.

Parameters:

resources - The set of resource DNs to be removed.

Throws:

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

SSOException - if the single sign on token is no longer valid

deleteEntities

void deleteEntities(Set resources)
             throws AMException,
                    SSOException

Deprecated.

Deletes a set of resources in this people container.

Parameters:

resources - The set of resource DNs to be removed.

Throws:

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

SSOException - if the single sign on token is no longer valid

searchSubPeopleContainers

Set searchSubPeopleContainers(String wildcard,
                              int level)
                       throws AMException,
                              SSOException

Deprecated.

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_SUB)

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 single sign on token is no longer valid

searchSubPeopleContainers

Set searchSubPeopleContainers(String wildcard,
                              Map avPairs,
                              int level)
                       throws AMException,
                              SSOException

Deprecated.

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 specified 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_SUB)

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 single sign on token is no longer valid