|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The AMGroup
interface provides methods to manage group
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 | |
void |
addNestedGroups(java.util.Set groups)
Nests the given group distinguished names in this the 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. |
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. |
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. |
void |
deleteAssignableDynamicGroups(java.util.Set groupDNs)
Deletes assignable dynamic groups in this group. |
void |
deleteDynamicGroups(java.util.Set groupDNs)
Deletes dynamic groups in this group. |
void |
deleteStaticGroups(java.util.Set groupDNs)
Deletes static groups in this group. |
java.util.Set |
getGroupDNs(int level)
Gets the groups in this group. |
java.util.Set |
getNestedGroupDNs()
Returns the groups nested in this group. |
long |
getNumberOfGroups(int level)
Returns number of groups in the group. |
long |
getNumberOfUsers()
Returns number of users in the group. |
java.util.Set |
getUserAndGroupDNs()
Returns the distinguished name of users and nested groups in the group. |
java.util.Set |
getUserDNs()
Returns the distinguished name of users in the group. |
void |
removeNestedGroups(java.util.Set groups)
Removes groups which are nested in this group. |
java.util.Set |
searchGroups(java.lang.String wildcard,
int level)
Searches for groups in this group using wildcards. |
AMSearchResults |
searchGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for groups in this group 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 using wildcards and attribute values. |
AMSearchResults |
searchUsers(AMSearchControl searchControl,
java.lang.String avfilter)
Searches for users in this group using attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard)
Searches for users in this group 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. |
Method Detail |
public long getNumberOfUsers() throws AMException, SSOException
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.SSOException
- if the single sign on token 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 store.SSOException
- if the single sign on token is no longer valid.public java.util.Set getUserAndGroupDNs() throws AMException, SSOException
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 addNestedGroups(java.util.Set groups) throws AMException, SSOException
members
of this group. And
any ACIs set for this group will be inherited by the nested groups
and their members.groups
- The set of group distinguished names to be nested in
this group.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 searchUsers(java.lang.String wildcard) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the searchAMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the single sign on token is no longer validpublic 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 size limit and time limitAMSearchResults
which contains a set of
distinguished name of Users matching the search.AMException
- if there is an internal error in the access
management 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 of
distinguished names of Users matching the search.AMException
- if there is an internal error in the access
management 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.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.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 PairsAMException
- 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.Set groupNames) throws AMException, SSOException
groupNames
- The set of dynamic groups' names to be created
in this group.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 name of the dynamic group to 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 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.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 of name of the assignable dynamic group to
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 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 java.util.Set getNestedGroupDNs() throws AMException, SSOException
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 removeNestedGroups(java.util.Set groups) throws AMException, SSOException
groups
- The set of user DN's to be removed from the static group.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 validpublic 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 names to be
deleted from this group.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.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 validpublic void deleteAssignableDynamicGroups(java.util.Set groupDNs) throws AMException, SSOException
groupDNs
- The set of assignable dynamic group distinguished
names to be deleted from this group.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) 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 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
- 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_TREE
)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
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching groupssearchControl
- specifies the search scope to be usedAMSearchResults
which contains a set 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 |