com.iplanet.am.sdk

Interface AMGroupContainer

All Superinterfaces:

AMConstants, AMObject

Deprecated.

As of Sun Java System Access Manager 7.1.

public interface AMGroupContainer
extends AMObject

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); }
 
 

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
AMGroup	createAssignableDynamicGroup(String name, Map attributes, Map serviceNameAndAttrs) Deprecated. Creates assignable dynamic group.
Set	createAssignableDynamicGroups(Map groups) Deprecated. Creates assignable dynamic groups and initializes their attributes.
Set	createAssignableDynamicGroups(Set groupNames) Deprecated. Creates assignable dynamic groups in this group container.
AMGroup	createDynamicGroup(String name, Map attributes, Map serviceNameAndAttrs) Deprecated. Creates dynamic group.
Set	createDynamicGroups(Map groups) Deprecated. Creates dynamic groups and initializes their attributes.
Set	createDynamicGroups(Set groupNames) Deprecated. Creates dynamic groups in this group container.
AMGroup	createStaticGroup(String name, Map attributes, Map serviceNameAndAttrs) Deprecated. Creates static group.
Set	createStaticGroups(Map groups) Deprecated. Creates static groups and initializes their attributes.
Set	createStaticGroups(Set groupNames) Deprecated. Creates static groups in this group container.
Set	createSubGroupContainers(Map groupContainers) Deprecated. Creates sub group containers and initializes their attributes.
Set	createSubGroupContainers(Set groupContainers) Deprecated. Creates sub group containers in this group container.
void	deleteAssignableDynamicGroups(Set groupDNs) Deprecated. Deletes assignable dynamic groups in this group container.
void	deleteDynamicGroups(Set groupDNs) Deprecated. Deletes dynamic groups in this group container.
void	deleteStaticGroups(Set groupDNs) Deprecated. Deletes static groups in this group container.
void	deleteSubGroupContainers(Set groupContainers) Deprecated. Deletes sub group containers in this group container.
Set	getGroupDNs(int level) Deprecated. Gets the groups in this group container.
long	getNumberOfGroups(int level) Deprecated. Returns number of groups in the group container.
long	getNumberOfSubGroupContainers() Deprecated. Returns number of sub group containers in the group container.
Set	getSubGroupContainerDNs(int level) Deprecated. Returns the sub containers in this group container.
Set	searchGroups(String wildcard, int level, String groupSearchTemplate, Map avPairs) Deprecated. Searches for groups in this group container using wildcards.
AMSearchResults	searchGroups(String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated. Searches for groups in this group container using wildcards and attribute values.
Set	searchGroups(String wildcard, Map avPairs, int level) Deprecated. Searches for groups in this group container using wildcards and attribute values.
AMSearchResults	searchGroups(String wildcard, Map avPairs, String groupSearchTemplate, AMSearchControl searchControl) Deprecated. Searches for assignable dynamic groups in this group container using wildcards and attribute values.
AMSearchResults	searchStaticGroups(String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated. Searches for static groups in this group container using wildcards and attribute values.
AMSearchResults	searchSubGroupContainers(String wildcard, Map avPairs, AMSearchControl searchControl) Deprecated. Searches for group containers in this group container using wildcards and attribute values.
Set	searchSubGroupContainers(String wildcard, Map avPairs, int level) Deprecated. Searches for sub group containers in this group 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

createSubGroupContainers

Set createSubGroupContainers(Set groupContainers)
                      throws AMException,
                             SSOException

Deprecated.

Creates sub group containers in this group container.

Parameters:

groupContainers - The set of group container names to be created in this group container.

Returns:

Set set of group container 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.

createSubGroupContainers

Set createSubGroupContainers(Map groupContainers)
                      throws AMException,
                             SSOException

Deprecated.

Creates sub group containers and initializes their attributes.

Parameters:

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

Returns:

Set of group container 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.

getSubGroupContainerDNs

Set getSubGroupContainerDNs(int level)
                     throws AMException,
                            SSOException

Deprecated.

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

Parameters:

level - AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB for returning sub containers.

Returns:

The sub container distinguished names in this group container.

Throws:

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.

getNumberOfSubGroupContainers

long getNumberOfSubGroupContainers()
                            throws AMException,
                                   SSOException

Deprecated.

Returns number of sub group containers in the group container.

Returns:

Number of sub group containers in the group container.

Throws:

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.

deleteSubGroupContainers

void deleteSubGroupContainers(Set groupContainers)
                       throws AMException,
                              SSOException

Deprecated.

Deletes sub group containers in this group container.

Parameters:

groupContainers - set of container distinguished name to be deleted from the group 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.

searchSubGroupContainers

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

Deprecated.

Searches for sub group containers in this group 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 distinguished name of group 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 group Containers.

level - the search level that needs to be used AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB.

Returns:

Set distinguished name of group 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.

searchSubGroupContainers

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

Deprecated.

Searches for group containers in this group 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 distinguished names of group 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 group containers.

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

Returns:

AMSearchResults object which contains the set distinguished name of group 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.

createStaticGroups

Set createStaticGroups(Set groupNames)
                throws AMException,
                       SSOException

Deprecated.

Creates static groups in this group container.

Parameters:

groupNames - The set of static groups' names to be created in this group container.

Returns:

set of static group 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.

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

createStaticGroups

Set createStaticGroups(Map groups)
                throws AMException,
                       SSOException

Deprecated.

Creates static groups and initializes their attributes.

Parameters:

groups - Map where the key is the name of the static group, and the value is a Map to represent attribute-value Pairs.

Returns:

Set of group 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.

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

createStaticGroup

AMGroup createStaticGroup(String name,
                          Map attributes,
                          Map serviceNameAndAttrs)
                   throws AMException,
                          SSOException

Deprecated.

Creates static group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

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

Returns:

the newly created group.

Throws:

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.

createDynamicGroups

Set createDynamicGroups(Set groupNames)
                 throws AMException,
                        SSOException

Deprecated.

Creates dynamic groups in this group container.

Parameters:

groupNames - The set of dynamic groups' names to be created in this group container.

Returns:

Set of dynamic group 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.

createDynamicGroups

Set createDynamicGroups(Map groups)
                 throws AMException,
                        SSOException

Deprecated.

Creates dynamic groups and initializes their attributes.

Parameters:

groups - map of dynamic group's name to its attribute-value pairs map.

Returns:

Set of dynamic group 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.

createDynamicGroup

AMGroup createDynamicGroup(String name,
                           Map attributes,
                           Map serviceNameAndAttrs)
                    throws AMException,
                           SSOException

Deprecated.

Creates dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

name - of group to be created.

attributes - attributes to be set in group

serviceNameAndAttrs - map of service name and attribute maps where the map is like this:

 <serviceName><AttrMap>
      (attrMap=<attrName><Set of attrvalues>)
 

Returns:

AMGroup object of newly created group.

Throws:

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.

createAssignableDynamicGroups

Set createAssignableDynamicGroups(Set groupNames)
                           throws AMException,
                                  SSOException

Deprecated.

Creates assignable dynamic groups in this group container.

Parameters:

groupNames - The set of assignable dynamic groups' names to be created in this group container.

Returns:

Set of assignable dynamic group 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.

createAssignableDynamicGroups

Set createAssignableDynamicGroups(Map groups)
                           throws AMException,
                                  SSOException

Deprecated.

Creates assignable dynamic groups and initializes their attributes.

Parameters:

groups - Map where the key is the name of the assignable dynamic group, and the value is a Map to represent attribute-value pairs.

Returns:

Set of assignable dynamic group 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.

createAssignableDynamicGroup

AMGroup createAssignableDynamicGroup(String name,
                                     Map attributes,
                                     Map serviceNameAndAttrs)
                              throws AMException,
                                     SSOException

Deprecated.

Creates assignable dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

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

Returns:

AMGroup object of newly created group.

Throws:

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.

getGroupDNs

Set getGroupDNs(int level)
         throws AMException,
                SSOException

Deprecated.

Gets the groups in this group container. It returns groups either at one level or a whole subtree.

Parameters:

level - the level (AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB) for returning groups.

Returns:

the group distinguished names in this group container.

Throws:

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.

getNumberOfGroups

long getNumberOfGroups(int level)
                throws AMException,
                       SSOException

Deprecated.

Returns number of groups in the group container. It returns number of groups either at one level or a whole subtree.

Parameters:

level - the level (AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB) for returning groups.

Returns:

the number of groups in the group 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.

deleteStaticGroups

void deleteStaticGroups(Set groupDNs)
                 throws AMException,
                        SSOException

Deprecated.

Deletes static groups in this group container.

Parameters:

groupDNs - The set of static group distinguished name to be deleted from this group 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.

deleteDynamicGroups

void deleteDynamicGroups(Set groupDNs)
                  throws AMException,
                         SSOException

Deprecated.

Deletes dynamic groups in this group container.

Parameters:

groupDNs - The set of dynamic group distinguished names to be deleted from this group 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.

deleteAssignableDynamicGroups

void deleteAssignableDynamicGroups(Set groupDNs)
                            throws AMException,
                                   SSOException

Deprecated.

Deletes assignable dynamic groups in this group container.

Parameters:

groupDNs - The set of assignable dynamic group distinguished names to be deleted from this group 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.

searchGroups

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

Deprecated.

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

Parameters:

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.

Returns:

Set of distinguished name of groups 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.

searchGroups

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

Deprecated.

Searches for groups in this group container using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. Otherwise the default search templates for the types of groups are used.

Parameters:

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.

Returns:

Set of distinguished name of assignable dynamic groups 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.

searchGroups

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

Deprecated.

Searches for assignable dynamic groups in this group 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 distinguished name of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a set of distinguished name of assignable dynamic groups 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.

searchGroups

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

Deprecated.

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

Parameters:

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.

Returns:

AMSearchResults which contains Set a of distinguished name of groups 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.

searchStaticGroups

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

Deprecated.

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

Parameters:

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.

Returns:

AMSearchResults which contains Set a of distinguished name of groups 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.