概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

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

すべてのスーパーインタフェース:
AMConstants, AMObject
既知のサブインタフェースの一覧:
AMFilteredRole
推奨されていません。 As of Sun Java System Access Manager 7.1. 

public interface AMRole
extends AMObject

The Role interface provides methods to manage role AMRole 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(rDN)) { AMRole role = amsc.getRole(rDN); }

フィールドの概要
static int GENERAL_ADMIN_ROLE
          推奨されていません。 Represents a General Administrative Role
static int TOP_LEVEL_ADMIN_ROLE
          推奨されていません。 Represents a Top Level Administrative Role
static int USER_ROLE
          推奨されていません。 Represents a User Role
 
インタフェース 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 addUsers(Set users)
          推奨されていません。 Adds users to the role.
 Set getAssignedPolicyDNs()
          推奨されていません。 Gets all the assigned policies created for this role
 long getNumberOfUsers()
          推奨されていません。 Gets number of users in the role.
 Set getPolicyTemplates(Set serviceNames)
          推奨されていません。 Get requested policy templates defined for this role.
 int getRoleType()
          推奨されていません。 Gets the type of the role.
 Set getTemplates(Map templateReqs)
          推奨されていません。 Get requested templates defined for this role.
 Set getUserDNs()
          推奨されていません。 Gets the DNs of users in the role.
 void removeUsers(Set users)
          推奨されていません。 Removes users from the role.
 AMSearchResults searchUsers(AMSearchControl searchControl, String avfilter)
          推奨されていません。 Searches for users in this role using attribute values.
 AMSearchResults searchUsers(String wildcard, AMSearchControl searchControl)
          推奨されていません。 Searches for users in this people container using wildcards and attribute values.
 Set searchUsers(String wildcard, int level)
          推奨されていません。 Searches for users in this role using wildcards and attribute values.
 AMSearchResults searchUsers(String wildcard, Map avPairs, AMSearchControl searchControl)
          推奨されていません。 Searches for users in this group using wildcards and attribute values.
 Set searchUsers(String wildcard, Map avPairs, int level)
          推奨されていません。 Searches for users in this role using wildcards and attribute values.
 void setRoleType(int roleType)
          推奨されていません。 Sets the type of the role.
 
インタフェース 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
 

フィールドの詳細

TOP_LEVEL_ADMIN_ROLE

static final int TOP_LEVEL_ADMIN_ROLE
推奨されていません。 
Represents a Top Level Administrative Role

関連項目:
定数フィールド値

GENERAL_ADMIN_ROLE

static final int GENERAL_ADMIN_ROLE
推奨されていません。 
Represents a General Administrative Role

関連項目:
定数フィールド値

USER_ROLE

static final int USER_ROLE
推奨されていません。 
Represents a User Role

関連項目:
定数フィールド値
メソッドの詳細

getRoleType

int getRoleType()
                throws AMException,
                       SSOException
推奨されていません。 
Gets the type of the role.

戻り値:
One of the possible values:
  • USER_ROLE
  • GENERAL_ADMIN_ROLE
  • TOP_LEVEL_ADMIN_ROLE
例外:
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

setRoleType

void setRoleType(int roleType)
                 throws AMException,
                        SSOException
推奨されていません。 
Sets the type of the role.

パラメータ:
roleType - The type of the role.
例外:
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

addUsers

void addUsers(Set users)
              throws AMException,
                     SSOException
推奨されていません。 
Adds users to the role.

パラメータ:
users - The set of user DN's to be added to the role.
例外:
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

removeUsers

void removeUsers(Set users)
                 throws AMException,
                        SSOException
推奨されていません。 
Removes users from the role.

パラメータ:
users - The set of user DN's to be removed from the role.
例外:
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

getNumberOfUsers

long getNumberOfUsers()
                      throws AMException,
                             SSOException
推奨されていません。 
Gets number of users in the role.

戻り値:
Number of users in the role.
例外:
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

getUserDNs

Set getUserDNs()
               throws AMException,
                      SSOException
推奨されていません。 
Gets the DNs of users in the role.

戻り値:
The DNs of users in the role.
例外:
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,
                int level)
                throws AMException,
                       SSOException
推奨されていません。 
Searches for users in this role using wildcards and attribute values. 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_SUB)
戻り値:
Set DNs 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,
                            AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
推奨されていません。 
Searches for users in this people container using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

パラメータ:
wildcard - wildcard pattern to be used in the search
searchControl - specifies the search scope to be used, VLV ranges etc.,
戻り値:
AMSearchResults which contains a Set DNs 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

Set searchUsers(String wildcard,
                Map avPairs,
                int level)
                throws AMException,
                       SSOException
推奨されていません。 
Searches for users in this role 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 DNs of users with matching attribute-value pairs will be returned.

パラメータ:
wildcard - wildcard pattern to be used in the search
avPairs - attribute-value pairs to match when searching users
level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
戻り値:
Set DNs 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 and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.

パラメータ:
wildcard - wildcard pattern to be used in the search
avPairs - attribute-value pairs to match when searching users
searchControl - specifies the search scope to be used, VLV ranges etc.
戻り値:
AMSearchResults which contains a DNs 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(AMSearchControl searchControl,
                            String avfilter)
                            throws AMException,
                                   SSOException
推奨されていません。 
Searches for users in this role using attribute values. Wildcards such as a*, *, *a can be specified for the attribute values. The DNs 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 DNs of Users matching the search.
例外:
AMException - if there is an internal error in the AM Store.
SSOException - if the single sign on token is no longer valid.

getTemplates

Set getTemplates(Map templateReqs)
                 throws AMException,
                        SSOException
推奨されていません。 
Get requested templates defined for this role.

パラメータ:
templateReqs - a Map of services names and template types. The key in the Map entry is the service name as a String, and the value of the Map entry is a java.lang.Integer whose integer value is one of AMTemplate.DYNAMIC_TEMPLATE AMTemplate.POLICY_TEMPLATE AMTemplate.ORGANIZATION_TEMPLATE AMTemplate.ALL_TEMPLATES
戻り値:
a Set of AMTemplate objects representing the templates requested. If the templateReqs argument is null or empty, the returned set will contain the AMTemplates for each registered service which has a template defined. If there is no template defined for any registered services for this role, an empty Set will be returned.
例外:
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.

getPolicyTemplates

Set getPolicyTemplates(Set serviceNames)
                       throws AMException,
                              SSOException
推奨されていません。 
Get requested policy templates defined for this role.

パラメータ:
serviceNames - a Set of services names, each specified as a java.lang.String.
戻り値:
set of AMTemplate objects representing the policy templates requested. If the serviceNames argument is null or empty, the returned set will contain the AMTemplates for each registered service which has a policy template defined. If there is no policy template defined for any registered services for this role, an empty Set will be returned.
例外:
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.

getAssignedPolicyDNs

Set getAssignedPolicyDNs()
                         throws AMException,
                                SSOException
推奨されていません。 
Gets all the assigned policies created for this role

戻り値:
Set a set of assigned policy DNs
例外:
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.
概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド