com.iplanet.am.sdk
Interface AMGroupContainer

All Superinterfaces:

AMConstants, AMObject

public interface AMGroupContainer

extends AMObject

The AMGroupContainer interface provides methods to manage group container

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

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

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

SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE

Method Summary

java.util.Set	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.
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.
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 GroupContainers 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) Gets number of groups in the group container.
long	getNumberOfSubGroupContainers() Gets number of sub group containers in the group container.
java.util.Set	getSubGroupContainerDNs(int level) Gets the sub containers in this group container.
AMSearchResults	searchGroups(java.lang.String wildcard, java.util.Map avPairs, com.iplanet.am.sdk.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	searchSubGroupContainers(java.lang.String wildcard, java.util.Map avPairs, com.iplanet.am.sdk.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.

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

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

Method Detail

createSubGroupContainers

public java.util.Set createSubGroupContainers(java.util.Set groupContainers)
                                       throws AMException,
                                              SSOException

Creates sub GroupContainers in this group container.

Parameters:

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

Returns:

Set set of GroupContainer objects created

Throws:

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

SSOException - if the sign on is no longer valid

createSubGroupContainers

public java.util.Set createSubGroupContainers(java.util.Map groupContainers)
                                       throws AMException,
                                              SSOException

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

Set - Set of GroupContainer objects created.

Throws:

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

SSOException - if the sign on is no longer valid

getSubGroupContainerDNs

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

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

Parameters:

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

Returns:

The sub container DNs 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 sign on is no longer valid

getNumberOfSubGroupContainers

public long getNumberOfSubGroupContainers()
                                   throws AMException,
                                          SSOException

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

deleteSubGroupContainers

public void deleteSubGroupContainers(java.util.Set groupContainers)
                              throws AMException,
                                     SSOException

Deletes sub group containers in this group container.

Parameters:

groupContainers - The set of container DN's 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 sign on is no longer valid

searchSubGroupContainers

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

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 specifed so that DNs 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 DNs 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 sign on is no longer valid

searchSubGroupContainers

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

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 specifed so that DNs 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 which contains the Set DNs 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 sign on is no longer valid

createStaticGroups

public java.util.Set createStaticGroups(java.util.Set groupNames)
                                 throws AMException,
                                        SSOException

Creates static groups in this group container.

Parameters:

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

Returns:

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

createStaticGroups

public java.util.Set createStaticGroups(java.util.Map groups)
                                 throws AMException,
                                        SSOException

Creates static groups and initializes their attributes.

Parameters:

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

Returns:

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

createDynamicGroups

public java.util.Set createDynamicGroups(java.util.Set groupNames)
                                  throws AMException,
                                         SSOException

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

createDynamicGroups

public java.util.Set createDynamicGroups(java.util.Map groups)
                                  throws AMException,
                                         SSOException

Creates dynamic groups and initializes their attributes.

Parameters:

groups - Map where the key is the name of the dynamic group, and the value is a Map to represent Attribute-Value Pairs

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

createAssignableDynamicGroups

public java.util.Set createAssignableDynamicGroups(java.util.Set groupNames)
                                            throws AMException,
                                                   SSOException

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

createAssignableDynamicGroups

public java.util.Set createAssignableDynamicGroups(java.util.Map groups)
                                            throws AMException,
                                                   SSOException

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

getGroupDNs

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

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

getNumberOfGroups

public long getNumberOfGroups(int level)
                       throws AMException,
                              SSOException

Gets 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:

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

deleteStaticGroups

public void deleteStaticGroups(java.util.Set groupDNs)
                        throws AMException,
                               SSOException

Deletes static groups in this group container.

Parameters:

groups - The set of static group DN's 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 sign on is no longer valid

deleteDynamicGroups

public void deleteDynamicGroups(java.util.Set groupDNs)
                         throws AMException,
                                SSOException

Deletes dynamic groups in this group container.

Parameters:

groups - The set of dynamic group DN's 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 sign on is no longer valid

deleteAssignableDynamicGroups

public void deleteAssignableDynamicGroups(java.util.Set groupDNs)
                                   throws AMException,
                                          SSOException

Deletes assignable dynamic groups in this group container.

Parameters:

groups - The set of assignable dynamic group DN's 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 sign on is no longer valid

searchGroups

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

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

Parameters:

wildcard - 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_ONE or AMConstants.SCOPE_SUB)

Returns:

Set DNs 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 sign on is no longer valid

searchGroups

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

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

Parameters:

wildcard - 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 DNs 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 sign on is no longer valid