| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
This interface provides methods to manage group container.
 AMGroupContainer 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(gcDN)) {
              AMGroupContainer dg = amsc.getGroupContainer(gcDN);
          }
 
| 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 | |
|  AMGroup | createAssignableDynamicGroup(java.lang.String name,
                             java.util.Map attributes,
                             java.util.Map serviceNameAndAttrs)Creates assignable dynamic group. | 
|  java.util.Set | createAssignableDynamicGroups(java.util.Map groups)Creates assignable dynamic groups and initializes their attributes. | 
|  java.util.Set | createAssignableDynamicGroups(java.util.Set groupNames)Creates assignable dynamic groups in this group container. | 
|  AMGroup | createDynamicGroup(java.lang.String name,
                   java.util.Map attributes,
                   java.util.Map serviceNameAndAttrs)Creates dynamic group. | 
|  java.util.Set | createDynamicGroups(java.util.Map groups)Creates dynamic groups and initializes their attributes. | 
|  java.util.Set | createDynamicGroups(java.util.Set groupNames)Creates dynamic groups in this group container. | 
|  AMGroup | createStaticGroup(java.lang.String name,
                  java.util.Map attributes,
                  java.util.Map serviceNameAndAttrs)Creates static group. | 
|  java.util.Set | createStaticGroups(java.util.Map groups)Creates static groups and initializes their attributes. | 
|  java.util.Set | createStaticGroups(java.util.Set groupNames)Creates static groups in this group container. | 
|  java.util.Set | createSubGroupContainers(java.util.Map groupContainers)Creates sub group containers and initializes their attributes. | 
|  java.util.Set | createSubGroupContainers(java.util.Set groupContainers)Creates sub group containers in this group container. | 
|  void | deleteAssignableDynamicGroups(java.util.Set groupDNs)Deletes assignable dynamic groups in this group container. | 
|  void | deleteDynamicGroups(java.util.Set groupDNs)Deletes dynamic groups in this group container. | 
|  void | deleteStaticGroups(java.util.Set groupDNs)Deletes static groups in this group container. | 
|  void | deleteSubGroupContainers(java.util.Set groupContainers)Deletes sub group containers in this group container. | 
|  java.util.Set | getGroupDNs(int level)Gets the groups in this group container. | 
|  long | getNumberOfGroups(int level)Returns number of groups in the group container. | 
|  long | getNumberOfSubGroupContainers()Returns number of sub group containers in the group container. | 
|  java.util.Set | getSubGroupContainerDNs(int level)Returns the sub containers in this group container. | 
|  java.util.Set | searchGroups(java.lang.String wildcard,
             int level,
             java.lang.String groupSearchTemplate,
             java.util.Map avPairs)Searches for groups in this group container using wildcards. | 
|  AMSearchResults | searchGroups(java.lang.String wildcard,
             java.util.Map avPairs,
             AMSearchControl searchControl)Searches for groups in this group container using wildcards and attribute values. | 
|  java.util.Set | searchGroups(java.lang.String wildcard,
             java.util.Map avPairs,
             int level)Searches for groups in this group container using wildcards and attribute values. | 
|  AMSearchResults | searchGroups(java.lang.String wildcard,
             java.util.Map avPairs,
             java.lang.String groupSearchTemplate,
             AMSearchControl searchControl)Searches for assignable dynamic groups in this group container using wildcards and attribute values. | 
|  AMSearchResults | searchStaticGroups(java.lang.String wildcard,
                   java.util.Map avPairs,
                   AMSearchControl searchControl)Searches for static groups in this group container using wildcards and attribute values. | 
|  AMSearchResults | searchSubGroupContainers(java.lang.String wildcard,
                         java.util.Map avPairs,
                         AMSearchControl searchControl)Searches for group containers in this group container using wildcards and attribute values. | 
|  java.util.Set | searchSubGroupContainers(java.lang.String wildcard,
                         java.util.Map avPairs,
                         int level)Searches for sub group containers in this group container using wildcards and attribute values. | 
| Method Detail | 
public java.util.Set createSubGroupContainers(java.util.Set groupContainers)
                                       throws AMException,
                                              SSOException
groupContainers - The set of group container names to be created 
        in this group container.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 createSubGroupContainers(java.util.Map groupContainers)
                                       throws AMException,
                                              SSOException
groupContainers - Map where the key is the name of the group
        container, and the value is a Map to represent
        Attribute-Value Pairs .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 getSubGroupContainerDNs(int level)
                                      throws AMException,
                                             SSOException
level - AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_SUB for returning sub containers.AMException - if an error is encountered when trying to
         access/retrieve data from the data store or if level is invalid.SSOException - if the single sign on token is no longer valid.
public long getNumberOfSubGroupContainers()
                                   throws AMException,
                                          SSOException
AMException - if an error is encountered when trying to
         access/retrieve data from the data store.SSOException - if the single sign token on is no longer valid.
public void deleteSubGroupContainers(java.util.Set groupContainers)
                              throws AMException,
                                     SSOException
groupContainers - set of container distinguished name to be
        deleted from the group container.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 searchSubGroupContainers(java.lang.String wildcard,
                                              java.util.Map avPairs,
                                              int level)
                                       throws AMException,
                                              SSOException
wildcard - wildcard pattern to be used in the search.avPairs - attribute-value pairs to match when searching group
        Containers.level - 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 AMSearchResults searchSubGroupContainers(java.lang.String wildcard,
                                                java.util.Map avPairs,
                                                AMSearchControl searchControl)
                                         throws AMException,
                                                SSOException
wildcard - wildcard pattern to be used in the search.avPairs - attribute-value pairs to match when searching group
        containers.searchControl - specifies the search scope to be used, VLV
        ranges etc.,AMSearchResults object which contains the set
         distinguished name of group containers 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 createStaticGroups(java.util.Set groupNames)
                                 throws AMException,
                                        SSOException
groupNames - The set of static groups' names to be created 
        in this group container.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.AMException - if an error is encountered when trying to
		create entries in the data store.
public java.util.Set createStaticGroups(java.util.Map groups)
                                 throws AMException,
                                        SSOException
groups - Map where the key is the name of the static group, and 
        the value is a Map to represent attribute-value Pairs.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.AMException - if an error is encountered when trying to
		create entries in the data store.
public AMGroup createStaticGroup(java.lang.String name,
                                 java.util.Map attributes,
                                 java.util.Map serviceNameAndAttrs)
                          throws AMException,
                                 SSOException
serviceNameAndAttr map
 so that services can be assigned to the group which is just created.name - of group to be created.attributes - attributes to be set in group node.serviceNameAndAttrs - map of service name to attribute map where
        the map is like this:
 <serviceName><AttrMap>
      (attrMap=<attrName><Set of attrvalues>)
 AMException - if an error is encountered when trying to
		create entries in the data store.SSOException - if the single sign on token is no longer valid.
public java.util.Set createDynamicGroups(java.util.Set groupNames)
                                  throws AMException,
                                         SSOException
groupNames - The set of dynamic groups' names to be created 
        in this group container.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 createDynamicGroups(java.util.Map groups)
                                  throws AMException,
                                         SSOException
groups - map of dynamic group's name to its attribute-value pairs
        map.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 AMGroup createDynamicGroup(java.lang.String name,
                                  java.util.Map attributes,
                                  java.util.Map serviceNameAndAttrs)
                           throws AMException,
                                  SSOException
serviceNameAndAttr map
 so that services can be assigned to the group which is just created.name - of group to be created.attributes - attributes to be set in groupserviceNameAndAttrs - map of service name and attribute maps
        where the map is like this:
 <serviceName><AttrMap>
     (attrMap=<attrName><Set of attrvalues>)
 AMGroup object of newly created group.AMException - if an error is encountered when trying to
		create entries in the data store.SSOException - if the single sign on token is no longer valid.
public java.util.Set createAssignableDynamicGroups(java.util.Set groupNames)
                                            throws AMException,
                                                   SSOException
groupNames - The set of assignable dynamic groups' names to be
        created in this group container.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 createAssignableDynamicGroups(java.util.Map groups)
                                            throws AMException,
                                                   SSOException
groups - Map where the key is the name of the assignable dynamic
        group, and the value is a Map to represent attribute-value
        pairs.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 AMGroup createAssignableDynamicGroup(java.lang.String name,
                                            java.util.Map attributes,
                                            java.util.Map serviceNameAndAttrs)
                                     throws AMException,
                                            SSOException
serviceNameAndAttr
 map so that services can be assigned to the group which is just created.name - of group to be created.attributes - attribute-value pairs to be set.serviceNameAndAttrs - map of service name to attribute map where the
 map is like this:
 <serviceName><AttrMap>
     (attrMap=<attrName><Set of attrvalues>)AMGroup object of newly created group.AMException - if an error is encountered when trying to
		create entries in the data store.SSOException - if the single sign on token is no longer valid.
public java.util.Set getGroupDNs(int level)
                          throws AMException,
                                 SSOException
level - the level (AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_SUB) for returning groups.AMException - if an error is encountered when trying to
         access/retrieve data from the data store or if the level is
         invalid.SSOException - if the single sign on token is no longer valid.
public long getNumberOfGroups(int level)
                       throws AMException,
                              SSOException
level - the level (AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_SUB) for returning groups.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 deleteStaticGroups(java.util.Set groupDNs)
                        throws AMException,
                               SSOException
groupDNs - The set of static group distinguished name to be deleted
        from this group container.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 deleteDynamicGroups(java.util.Set groupDNs)
                         throws AMException,
                                SSOException
groupDNs - The set of dynamic group distinguished names to be
        deleted from this group container.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 deleteAssignableDynamicGroups(java.util.Set groupDNs)
                                   throws AMException,
                                          SSOException
groupDNs - The set of assignable dynamic group distinguished
        names to be deleted from this group container.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 searchGroups(java.lang.String wildcard,
                                  java.util.Map avPairs,
                                  int level)
                           throws AMException,
                                  SSOException
wildcard - pattern to be used in the search.avPairs - attribute-value pairs to match when searching groups.level - the search level that needs to be used
 AMConstants.SCOPE_ON or
 AMConstants.SCOPE_SUB.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 searchGroups(java.lang.String wildcard,
                                  int level,
                                  java.lang.String groupSearchTemplate,
                                  java.util.Map avPairs)
                           throws AMException,
                                  SSOException
groupSearchTemplate, if provided. Otherwise the
 default search templates for the types of groups are used.wildcard - pattern to be used in the search.level - the search level that needs to be used
        AMConstants.SCOPE_ONE or
        AMConstants.SCOPE_SUB.groupSearchTemplate - name of the search template to be used to
        perform this search.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 searchGroups(java.lang.String wildcard,
                                    java.util.Map avPairs,
                                    java.lang.String groupSearchTemplate,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
wildcard - pattern to be used in the search.avPairs - attribute-value pairs to match when searching assignable
        dynamic groups.groupSearchTemplate - Name of search template to be used to perform
       the search.searchControl - specifies the search scope to be used, VLV ranges
        etc.AMSearchResults which contains a set of
         distinguished name of assignable dynamic groups 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 searchGroups(java.lang.String wildcard,
                                    java.util.Map avPairs,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
wildcard - pattern to be used in the search.avPairs - attribute-value pairs to match when searching groups.searchControl - specifies the search scope to be used.AMSearchResults which contains Set a of
         distinguished name of groups 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 searchStaticGroups(java.lang.String wildcard,
                                          java.util.Map avPairs,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException
wildcard - pattern to be used in the search.avPairs - attribute-value pairs to match when searching groups.searchControl - specifies the search scope to be used.AMSearchResults which contains Set a of
         distinguished name of groups 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.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||