com.iplanet.am.sdk
インタフェース AMGroup

すべてのスーパーインタフェース:

AMConstants, AMObject

既知のサブインタフェースの一覧:

AMAssignableDynamicGroup, AMDynamicGroup, AMStaticGroup

推奨されていません。 As of Sun Java System Access Manager 7.1.

public interface AMGroup
extends AMObject

The AMGroup interface provides methods to manage group

フィールドの概要

インタフェース 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

インタフェース 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

メソッドの概要

void	addNestedGroups(Set groups) 推奨されていません。 Nests the given group distinguished names in this the group.
Set	createAssignableDynamicGroups(Map groups) 推奨されていません。 Creates assignable dynamic groups and initializes their attributes.
Set	createAssignableDynamicGroups(Set groupNames) 推奨されていません。 Creates assignable dynamic groups in this group.
Set	createDynamicGroups(Map groups) 推奨されていません。 Creates dynamic groups and initializes their attributes.
Set	createDynamicGroups(Set groupNames) 推奨されていません。 Creates dynamic groups in this group.
Set	createStaticGroups(Map groups) 推奨されていません。 Creates static groups and initializes their attributes.
Set	createStaticGroups(Set groupNames) 推奨されていません。 Creates static groups in this group.
void	deleteAssignableDynamicGroups(Set groupDNs) 推奨されていません。 Deletes assignable dynamic groups in this group.
void	deleteDynamicGroups(Set groupDNs) 推奨されていません。 Deletes dynamic groups in this group.
void	deleteStaticGroups(Set groupDNs) 推奨されていません。 Deletes static groups in this group.
Set	getGroupDNs(int level) 推奨されていません。 Gets the groups in this group.
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.
Set	getUserAndGroupDNs() 推奨されていません。 Returns the distinguished name of users and nested groups in the group.
Set	getUserDNs() 推奨されていません。 Returns the distinguished name of users in the group.
void	removeNestedGroups(Set groups) 推奨されていません。 Removes groups which are nested in this group.
Set	searchGroups(String wildcard, int level) 推奨されていません。 Searches for groups in this group using wildcards.
AMSearchResults	searchGroups(String wildcard, Map avPairs, AMSearchControl searchControl) 推奨されていません。 Searches for groups in this group using wildcards and attribute values.
Set	searchGroups(String wildcard, Map avPairs, int level) 推奨されていません。 Searches for groups in this group using wildcards and attribute values.
AMSearchResults	searchUsers(AMSearchControl searchControl, String avfilter) 推奨されていません。 Searches for users in this group using attribute values.
Set	searchUsers(String wildcard) 推奨されていません。 Searches for users in this group using wildcards and attribute values.
AMSearchResults	searchUsers(String wildcard, Map avPairs, AMSearchControl searchControl) 推奨されていません。 Searches for users in this group using wildcards.

インタフェース 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

メソッドの詳細

getNumberOfUsers

long getNumberOfUsers()
                      throws AMException,
                             SSOException

推奨されていません。

Returns number of users in the group.

戻り値:

Number of users in the group.

例外:

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.

getUserDNs

Set getUserDNs()
               throws AMException,
                      SSOException

推奨されていません。

Returns the distinguished name of users in the group.

戻り値:

a set of user distinguished names in the 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.

getUserAndGroupDNs

Set getUserAndGroupDNs()
                       throws AMException,
                              SSOException

推奨されていません。

Returns the distinguished name of users and nested groups in the group.

戻り値:

The distinguished name of users and nested groups in the 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.

addNestedGroups

void addNestedGroups(Set groups)
                     throws AMException,
                            SSOException

推奨されていません。

Nests the given group distinguished names in this the group. This will effectively make the groups 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.

searchUsers

Set searchUsers(String wildcard)
                throws AMException,
                       SSOException

推奨されていません。

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

パラメータ:

wildcard - wildcard pattern to be used in the search

戻り値:

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

searchUsers

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

推奨されていません。

Searches for users in this group using wildcards. Wildcards can be specified such as a*, *, *a.

パラメータ:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

searchControl - specifies the size limit and time limit

戻り値:

AMSearchResults 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.

searchUsers

AMSearchResults searchUsers(AMSearchControl searchControl,
                            String avfilter)
                            throws AMException,
                                   SSOException

推奨されていません。

Searches for users in this group using attribute values. Wildcards such as a*, *, *a can be specified for the attribute values. The distinguished names of users with matching attribute-value pairs will be returned.

パラメータ:

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.

createStaticGroups

Set createStaticGroups(Set groupNames)
                       throws AMException,
                              SSOException

推奨されていません。

Creates static groups in this group.

パラメータ:

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

戻り値:

set of static group objects created.

例外:

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(Map groups)
                       throws AMException,
                              SSOException

推奨されていません。

Creates static groups and initializes their attributes.

パラメータ:

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

戻り値:

Set of group objects created.

例外:

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(Set groupNames)
                        throws AMException,
                               SSOException

推奨されていません。

Creates dynamic groups in this group.

パラメータ:

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

戻り値:

Set of dynamic group objects created

例外:

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

推奨されていません。

Creates dynamic groups and initializes their attributes.

パラメータ:

groups - Map of name of the dynamic group to attribute-value pairs map.

戻り値:

Set of dynamic group objects created.

例外:

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(Set groupNames)
                                  throws AMException,
                                         SSOException

推奨されていません。

Creates assignable dynamic groups in this group.

パラメータ:

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

戻り値:

Set of assignable dynamic group objects created.

例外:

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

推奨されていません。

Creates assignable dynamic groups and initializes their attributes.

パラメータ:

groups - Map of name of the assignable dynamic group to attribute-value pairs map;

戻り値:

Set of assignable dynamic group objects created.

例外:

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.

getGroupDNs

Set getGroupDNs(int level)
                throws AMException,
                       SSOException

推奨されていません。

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

パラメータ:

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

戻り値:

The group distinguished names in this group.

例外:

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.

getNestedGroupDNs

Set getNestedGroupDNs()
                      throws AMException,
                             SSOException

推奨されていません。

Returns the groups nested in this group.

戻り値:

The group distinguished names 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.

removeNestedGroups

void removeNestedGroups(Set groups)
                        throws AMException,
                               SSOException

推奨されていません。

Removes groups which are nested in this group.

パラメータ:

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 store

SSOException - if the single sign on token is no longer valid

getNumberOfGroups

long getNumberOfGroups(int level)
                       throws AMException,
                              SSOException

推奨されていません。

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

パラメータ:

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

戻り値:

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

deleteStaticGroups

void deleteStaticGroups(Set groupDNs)
                        throws AMException,
                               SSOException

推奨されていません。

Deletes static groups in this group.

パラメータ:

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.

deleteDynamicGroups

void deleteDynamicGroups(Set groupDNs)
                         throws AMException,
                                SSOException

推奨されていません。

Deletes dynamic groups in this group.

パラメータ:

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 store

SSOException - if the single sign on token is no longer valid

deleteAssignableDynamicGroups

void deleteAssignableDynamicGroups(Set groupDNs)
                                   throws AMException,
                                          SSOException

推奨されていません。

Deletes assignable dynamic groups in this group.

パラメータ:

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.

searchGroups

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

推奨されていません。

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

パラメータ:

wildcard - wildcard pattern to be used in the search

level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_TREE).

戻り値:

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

searchGroups

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

推奨されていません。

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

パラメータ:

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

戻り値:

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.

searchGroups

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

推奨されていません。

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

パラメータ:

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

戻り値:

AMSearchResults 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.