| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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);
          }
 
| 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 | 
| Method Summary | |
|  java.util.Set | createEntities(java.lang.String stype,
               java.util.Map entities)Creates entities and initializes their attributes. | 
|  java.util.Set | createEntities(java.lang.String type,
               java.util.Set entities)Create managed entities in this container. | 
|  java.util.Set | createResources(java.util.Map resourceMap)Create resources in this organization. | 
|  java.util.Set | createResources(java.util.Set resourceNames)Create resources in this organization. | 
|  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 people containers in this people container. | 
|  AMUser | createUser(java.lang.String uid,
           java.util.Map attrMap,
           java.util.Map serviceNameAndAttrs)Create user and initializes the attributes. | 
|  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 | deleteEntities(java.util.Set resources)Deletes a set of resources in this people container. | 
|  void | deleteResources(java.util.Set resources)Deletes a set of resources 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 people 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. | 
|  AMSearchResults | searchEntities(java.lang.String wildcard,
               AMSearchControl searchControl,
               java.lang.String avfilter,
               java.lang.String eSearchTemplate)Searches for entities in this people container using wildcards and a filter. | 
|  java.util.Set | searchEntities(java.lang.String wildcard,
               int level,
               java.lang.String eSearchTemplate,
               java.util.Map avPairs)Searches for resources in this organization using wildcards and attribute values. | 
|  AMSearchResults | searchEntities(java.lang.String wildcard,
               java.util.Map avPairs,
               java.lang.String eSearchTemplate,
               AMSearchControl searchControl)Searches for entities in this people container using wildcards and attribute values. | 
|  java.util.Set | searchResources(java.lang.String wildcard,
                int level,
                java.lang.String resourceSearchTemplate,
                java.util.Map avPairs)Searches for resources in this organization using wildcards and attribute values. | 
|  AMSearchResults | searchResources(java.lang.String wildcard,
                java.util.Map avPairs,
                java.lang.String rSearchTemplate,
                AMSearchControl searchControl)Searches for resources in this people container using wildcards and attribute values. | 
|  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(AMSearchControl searchControl,
            java.lang.String avfilter)Searches for users in this people container using attribute values. | 
|  AMSearchResults | searchUsers(java.lang.String wildcard,
            AMSearchControl searchControl)Searches for users in this people container using wildcards and attribute values. | 
|  AMSearchResults | searchUsers(java.lang.String wildcard,
            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. | 
|  java.util.Set | searchUsers(java.lang.String wildcard,
            int level,
            java.lang.String userSearchTemplate,
            java.util.Map avPairs)Searches for users in this organization using wildcards and attribute values. | 
|  AMSearchResults | searchUsers(java.lang.String wildcard,
            java.util.Map avPairs,
            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. | 
|  AMSearchResults | searchUsers(java.lang.String wildcard,
            java.util.Map avPairs,
            java.lang.String userSearchTemplate,
            AMSearchControl searchControl)Searches for users in this people container using wildcards and attribute values. | 
| Method Detail | 
public java.util.Set createUsers(java.util.Set users)
                          throws AMException,
                                 SSOException
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.users - The set of user names to be created in this people 
              container.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set createUsers(java.util.Map users)
                          throws AMException,
                                 SSOException
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.users - Map where the key is the name of the user, and the value is 
              a Map to represent Attribute-Value PairsAMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set createUsers(java.util.Map users,
                                 java.util.Set serviceNames)
                          throws AMException,
                                 SSOException
users - Map where the key is the name of the user, and the value is 
              a Map to represent Attribute-Value PairsserviceNames - 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 PairsAMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public AMUser createUser(java.lang.String uid,
                         java.util.Map attrMap,
                         java.util.Map serviceNameAndAttrs)
                  throws AMException,
                         SSOException
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.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.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.
public void deleteUsers(java.util.Set users)
                 throws AMException,
                        SSOException
users - The set of user DN's to be deleted from the people
 container.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public long getNumberOfUsers()
                      throws AMException,
                             SSOException
AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set getUserDNs()
                         throws AMException,
                                SSOException
AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set createSubPeopleContainers(java.util.Set peopleContainersNames)
                                        throws AMException,
                                               SSOException
peopleContainersNames - The set of people container names to be
        created in this people container.PeopleContainer objects created.AMException - if an error is encountered when trying to
         access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set createSubPeopleContainers(java.util.Map peopleContainers)
                                        throws AMException,
                                               SSOException
peopleContainers - Map where the key is the name of the people
        container, and the value is a Map to represent Attribute-Value
        Pairs.PeopleContainer objects created.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.
public java.util.Set getSubPeopleContainerDNs(int level)
                                       throws AMException,
                                              SSOException
level - the level (SCOPE_ONE or SCOPE_TREE)
        for returning sub containersAMException - 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.
public long getNumberOfSubPeopleContainers()
                                    throws AMException,
                                           SSOException
AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public void deleteSubPeopleContainers(java.util.Set peopleContainers)
                               throws AMException,
                                      SSOException
peopleContainers - The set of container DN's to be deleted from the 
                         people container.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set searchUsers(java.lang.String wildcard,
                                 int level)
                          throws AMException,
                                 SSOException
wildcard - wildcard pattern to be used in the searchlevel - the search level that needs to be used
        (AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_TREE)AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set searchUsers(java.lang.String wildcard,
                                 int level,
                                 java.lang.String userSearchTemplate,
                                 java.util.Map avPairs)
                          throws AMException,
                                 SSOException
userSearchTemplate, if provided. Otherwise,
 it uses the BasicUserSearchTemplate. Any %U in
 the search template are replaced with the wildcard.wildcard - wildcard pattern to be used in the searchlevel - 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.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public AMSearchResults searchUsers(java.lang.String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - specifies the search scope to be used, VLV
 ranges etc.,AMSearchResults which contains a Set DNs of Users
         matching the search.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set searchUsers(java.lang.String wildcard,
                                 java.util.Map avPairs,
                                 int level)
                          throws AMException,
                                 SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching userslevel - the search level that needs to be used
        (AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_TREE)AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching userssearchControl - specifies the search scope to be used, VLV
 ranges etc.,AMSearchResults which contains a Set DNs of Users
         matching the search.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public AMSearchResults searchUsers(java.lang.String wildcard,
                                   AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - specifies the search scope to be used, VLV
 ranges etc.,avfilter - this attribute-value pairs filter will be logical AND
        with user search filter.AMSearchResults which contains a Set DNs of Users
         matching the search.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.
public AMSearchResults searchUsers(AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException
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.AMSearchResults which contains a Set DNs of Users
         matching the search.AMException - if there is an internal error in the AM StoreSSOException - if the single sign on token is no longer valid
public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   java.lang.String userSearchTemplate,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching usersuserSearchTemplate - Name of user search template to be used.searchControl - specifies the search scope to be used, VLV
 ranges etc.,AMSearchResults which contains a Set DNs of Users
         matching the search.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
public java.util.Set createResources(java.util.Set resourceNames)
                              throws AMException,
                                     SSOException
resourceNames - Names of the resources to be created.AMResource objectsAMException - If there is an error when trying to save to 
 the data storeSSOException - If the SSO Token is invalid.
public java.util.Set createResources(java.util.Map resourceMap)
                              throws AMException,
                                     SSOException
resourceMap - Map of resource names to be created and attributes
    to be set in the newly creates resource.AMResource objects.AMException - If there is an error when trying to save to 
 the data storeSSOException - If the SSO Token is invalid.
public java.util.Set createEntities(java.lang.String type,
                                    java.util.Set entities)
                             throws AMException,
                                    SSOException
DAI, can be created
 using this method.type - Type of entity to be create (For example "user" or "agent")entities - Set of names for the entities to be createdAMEntity objectsAMException - If there is an error when trying to save to 
 the data storeSSOException - If the SSO Token is invalid.
public java.util.Set createEntities(java.lang.String stype,
                                    java.util.Map entities)
                             throws AMException,
                                    SSOException
DAI, can be
 created using this method.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 PairsAMEntity objects createdAMException - 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
public java.util.Set searchResources(java.lang.String wildcard,
                                     int level,
                                     java.lang.String resourceSearchTemplate,
                                     java.util.Map avPairs)
                              throws AMException,
                                     SSOException
resourceSearchTemplate, if provided. Otherwise,
 it uses the BasicResourceSearchTemplate.wildcard - wildcard pattern to be used in the searchlevel - 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.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.
public AMSearchResults searchResources(java.lang.String wildcard,
                                       java.util.Map avPairs,
                                       java.lang.String rSearchTemplate,
                                       AMSearchControl searchControl)
                                throws AMException,
                                       SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching usersrSearchTemplate - Name of resource search template to be used.searchControl - specifies the search scope to be used, VLV
        ranges etc.,AMSearchResults which contains a Set DNs of
         resources matching the search.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set searchEntities(java.lang.String wildcard,
                                    int level,
                                    java.lang.String eSearchTemplate,
                                    java.util.Map avPairs)
                             throws AMException,
                                    SSOException
eSearchTemplate, if provided. Otherwise, it
 uses the BasicEntitySearch template.wildcard - wildcard pattern to be used in the searchlevel - 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.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.
public AMSearchResults searchEntities(java.lang.String wildcard,
                                      java.util.Map avPairs,
                                      java.lang.String eSearchTemplate,
                                      AMSearchControl searchControl)
                               throws AMException,
                                      SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching userseSearchTemplate - Name of search template to be used.searchControl - specifies the search scope to be used, VLV
 ranges etc.,AMSearchResults which contains a Set DNs of
         resources matching the search.AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public AMSearchResults searchEntities(java.lang.String wildcard,
                                      AMSearchControl searchControl,
                                      java.lang.String avfilter,
                                      java.lang.String eSearchTemplate)
                               throws AMException,
                                      SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - 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.AMSearchResults which contains a Set DNs of Users
         matching the search.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
public void deleteResources(java.util.Set resources)
                     throws AMException,
                            SSOException
resources - The set of resource DNs to be removed.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
public void deleteEntities(java.util.Set resources)
                    throws AMException,
                           SSOException
resources - The set of resource DNs to be removed.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
public java.util.Set searchSubPeopleContainers(java.lang.String wildcard,
                                               int level)
                                        throws AMException,
                                               SSOException
wildcard - wildcard pattern to be used in the searchlevel - the search level that needs to be used
        (AMConstants.SCOPE_ONE or 
        AMConstants.SCOPE_SUB)AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid
public java.util.Set searchSubPeopleContainers(java.lang.String wildcard,
                                               java.util.Map avPairs,
                                               int level)
                                        throws AMException,
                                               SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching people
                Containerslevel - the search level that needs to be used
        (AMConstants.SCOPE_ONE or 
        AMConstants.SCOPE_SUB)AMException - if an error is encountered when trying to
 access/retrieve data from the data storeSSOException - if the single sign on token is no longer valid| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||