|
|||||||||
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 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. |
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 |
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 GroupContainer names to be created
in this group container.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic 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 PairsSet
- Set of GroupContainer objects created.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.util.Set getSubGroupContainerDNs(int level) throws AMException, SSOException
level
- the level(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
for returning subcontainersAMException
- if an error is encountered when trying to
access/retrieve data from the data store or if level is invalidSSOException
- if the sign on is no longer validpublic long getNumberOfSubGroupContainers() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void deleteSubGroupContainers(java.util.Set groupContainers) throws AMException, SSOException
groupContainers
- The set of container DN's to be deleted from the
group container.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic 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 searchavPairs
- attribute-value pairs to match when searching group
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 sign on is no longer validpublic AMSearchResults searchSubGroupContainers(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 group
containerssearchControl
- specifies the search scope to be used, VLV
ranges etc.,AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic 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 storeSSOException
- if the sign on is no longer validpublic java.util.Set createStaticGroups(java.util.Map groups) throws AMException, SSOException
users
- Map where the key is the name of the static group, 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 sign on is no longer validpublic AMGroup createStaticGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
Name
- of group to be createdMap
- attributes to be set in group node.ServiceName
- and attrsMap where the map is like this:
AMException
- SSOException
- if the SSOtoken is no longer validpublic 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 storeSSOException
- if the sign on is no longer validpublic java.util.Set createDynamicGroups(java.util.Map groups) throws AMException, SSOException
groups
- Map where the key is the name of the dynamic group, 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 sign on is no longer validpublic AMGroup createDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
Name
- of group to be createdMap
- attributes to be set in groupServiceName
- and attrsMap where the map is like this:
AMException
- SSOException
- if the SSOtoken is no longer validpublic 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 storeSSOException
- if the sign on is no longer validpublic 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
PairsAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic AMGroup createAssignableDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
Name
- of group to be createdMap
- attributes attribute-value pairs to be setServiceName
- and attrsMap where the map is like this:
AMException
- SSOException
- if the SSOtoken is no longer validpublic java.util.Set getGroupDNs(int level) throws AMException, SSOException
level
- the level(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
for returning groupsAMException
- if an error is encountered when trying to
access/retrieve data from the data store or if the level is invalidSSOException
- if the sign on is no longer validpublic long getNumberOfGroups(int level) throws AMException, SSOException
level
- the level(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
for returning groupsAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void deleteStaticGroups(java.util.Set groupDNs) throws AMException, SSOException
groups
- The set of static group DN's to be deleted from this group
container.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void deleteDynamicGroups(java.util.Set groupDNs) throws AMException, SSOException
groups
- The set of dynamic group DN's to be deleted from this
group container.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void deleteAssignableDynamicGroups(java.util.Set groupDNs) throws AMException, SSOException
groups
- The set of assignable dynamic group DN's to be deleted
from this group container.AMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.util.Set searchGroups(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 groupslevel
- 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 sign on is no longer validpublic java.util.Set searchGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) 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)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 storeSSOException
- if the sign on is no longer validpublic AMSearchResults searchGroups(java.lang.String wildcard, java.util.Map avPairs, java.lang.String groupSearchTemplate, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching assignable
dynamic groupssearchControl
- specifies the search scope to be used, VLV
ranges etc.,groupSearchTemplate
- Name of search template to be used to perform
the searchAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic AMSearchResults searchGroups(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 groupssearchControl
- specifies the search scope to be usedAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer valid
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |