|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||
public interface AMPeopleContainer
This interface provides methods to manage people container.
AMPeopleContainer 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(pcDN)) { AMPeopleContainer pc =
amsc.getPeopleContainer(oDN); }
| フィールドの概要 |
|---|
| インタフェース 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 |
| メソッドの概要 | |
|---|---|
Set |
createEntities(String stype,
Map entities)
推奨されていません。 Creates entities and initializes their attributes. |
Set |
createEntities(String type,
Set entities)
推奨されていません。 Create managed entities in this container. |
Set |
createResources(Map resourceMap)
推奨されていません。 Create resources in this organization. |
Set |
createResources(Set resourceNames)
推奨されていません。 Create resources in this organization. |
Set |
createSubPeopleContainers(Map peopleContainers)
推奨されていません。 Creates sub people containers and initializes their attributes. |
Set |
createSubPeopleContainers(Set peopleContainersNames)
推奨されていません。 Creates sub people containers in this people container. |
AMUser |
createUser(String uid,
Map attrMap,
Map serviceNameAndAttrs)
推奨されていません。 Create user and initializes the attributes. |
Set |
createUsers(Map users)
推奨されていません。 Creates users and initializes their attributes. |
Set |
createUsers(Map users,
Set serviceNames)
推奨されていません。 Creates users and initializes their attributes. |
Set |
createUsers(Set users)
推奨されていません。 Creates users in this people container. |
void |
deleteEntities(Set resources)
推奨されていません。 Deletes a set of resources in this people container. |
void |
deleteResources(Set resources)
推奨されていません。 Deletes a set of resources in this people container. |
void |
deleteSubPeopleContainers(Set peopleContainers)
推奨されていません。 Deletes sub people containers in this people container. |
void |
deleteUsers(Set users)
推奨されていません。 Deletes users from this people container. |
long |
getNumberOfSubPeopleContainers()
推奨されていません。 Gets number of sub people containers in the people container. |
long |
getNumberOfUsers()
推奨されていません。 Gets number of users in the people container. |
Set |
getSubPeopleContainerDNs(int level)
推奨されていません。 Gets the sub containers in this people container. |
Set |
getUserDNs()
推奨されていません。 Gets the names (DNs) of users in the people container. |
AMSearchResults |
searchEntities(String wildcard,
AMSearchControl searchControl,
String avfilter,
String eSearchTemplate)
推奨されていません。 Searches for entities in this people container using wildcards and a filter. |
Set |
searchEntities(String wildcard,
int level,
String eSearchTemplate,
Map avPairs)
推奨されていません。 Searches for resources in this organization using wildcards and attribute values. |
AMSearchResults |
searchEntities(String wildcard,
Map avPairs,
String eSearchTemplate,
AMSearchControl searchControl)
推奨されていません。 Searches for entities in this people container using wildcards and attribute values. |
Set |
searchResources(String wildcard,
int level,
String resourceSearchTemplate,
Map avPairs)
推奨されていません。 Searches for resources in this organization using wildcards and attribute values. |
AMSearchResults |
searchResources(String wildcard,
Map avPairs,
String rSearchTemplate,
AMSearchControl searchControl)
推奨されていません。 Searches for resources in this people container using wildcards and attribute values. |
Set |
searchSubPeopleContainers(String wildcard,
int level)
推奨されていません。 Searches for sub people containers in this people container using wildcards and attribute values. |
Set |
searchSubPeopleContainers(String wildcard,
Map avPairs,
int level)
推奨されていません。 Searches for sub people containers in this people container using wildcards and attribute values. |
AMSearchResults |
searchUsers(AMSearchControl searchControl,
String avfilter)
推奨されていません。 Searches for users in this people container using attribute values. |
AMSearchResults |
searchUsers(String wildcard,
AMSearchControl searchControl)
推奨されていません。 Searches for users in this people container using wildcards and attribute values. |
AMSearchResults |
searchUsers(String wildcard,
AMSearchControl searchControl,
String avfilter)
推奨されていません。 Searches for users in this people container using wildcards and attribute values. |
Set |
searchUsers(String wildcard,
int level)
推奨されていません。 Searches for users in this people container using wildcards and attribute values. |
Set |
searchUsers(String wildcard,
int level,
String userSearchTemplate,
Map avPairs)
推奨されていません。 Searches for users in this organization 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 group using wildcards and attribute values. |
AMSearchResults |
searchUsers(String wildcard,
Map avPairs,
String userSearchTemplate,
AMSearchControl searchControl)
推奨されていません。 Searches for users in this people container using wildcards and attribute values. |
| メソッドの詳細 |
|---|
Set createUsers(Set users)
throws AMException,
SSOException
iplanet-am-required-services of the service
iPlanetAMAdminConsoleService template are added. If a
corresponding template does not exist, the default values are picked up
from schema.
users - The set of user names to be created in this people container.
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
Set createUsers(Map users)
throws AMException,
SSOException
iplanet-am-required-services of the service
iPlanetAMAdminConsoleService template are added. If a
corresponding template does not exist, the default values are picked up
from schema.
users - Map where the key is the name of the user, and the value is a
Map to represent Attribute-Value Pairs
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
Set createUsers(Map users,
Set serviceNames)
throws AMException,
SSOException
users - Map where the key is the name of the user, and the value is a
Map to represent Attribute-Value PairsserviceNames - Set of service names assigned to the users where the key is
the name of the user, and the value is a Map to represent
Attribute-Value Pairs
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
AMUser createUser(String uid,
Map attrMap,
Map serviceNameAndAttrs)
throws AMException,
SSOException
iplanet-am-required-services of the service
iPlanetAMAdminConsoleService template are added. If a
corresponding template does not exist, the default values are picked up
from schema. Also services as defined in the arguments, are assigned to
the user, with default values being picked up from the service schema if
none are provided for required attributes of the service.
uid - value of naming attribute for user.attrMap - attribute-values to be set in the user entry.serviceNameAndAttrs - service names and attributes to be assigned to the user.
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.
void deleteUsers(Set users)
throws AMException,
SSOException
users - The set of user DN's to be deleted from the people container.
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
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 is no longer valid
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
Set createSubPeopleContainers(Set peopleContainersNames)
throws AMException,
SSOException
peopleContainersNames - The set of people container names to be created in this people
container.
PeopleContainer 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
Set createSubPeopleContainers(Map peopleContainers)
throws AMException,
SSOException
peopleContainers - Map where the key is the name of the people container, and the
value is a Map to represent Attribute-Value Pairs.
PeopleContainer 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.
Set getSubPeopleContainerDNs(int level)
throws AMException,
SSOException
level - the level (SCOPE_ONE or
SCOPE_TREE) for returning sub containers
AMException - if an error is encountered when trying to access/retrieve
data from the data store and if the level is invalid.
SSOException - if the single sign on token is no longer valid.
long getNumberOfSubPeopleContainers()
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
void deleteSubPeopleContainers(Set peopleContainers)
throws AMException,
SSOException
peopleContainers - The set of container DN's to be deleted from the people
container.
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
Set searchUsers(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
Set searchUsers(String wildcard,
int level,
String userSearchTemplate,
Map avPairs)
throws AMException,
SSOException
userSearchTemplate, if provided. Otherwise, it uses the
BasicUserSearchTemplate. Any %U in the
search template are replaced with the wildcard.
wildcard - wildcard pattern to be used in the searchlevel - the search level that needs to be used (
AMConstants.SCOPE_ONE
or AMConstants.SCOPE_TREE)userSearchTemplate - Name of search template to use. If null is passed then the
default search template BasicUserSearch is
used.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 store
SSOException - if the single sign on token is no longer valid
AMSearchResults searchUsers(String wildcard,
AMSearchControl searchControl)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - 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
Set searchUsers(String wildcard,
Map avPairs,
int level)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching userslevel - 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
AMSearchResults searchUsers(String wildcard,
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 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
AMSearchResults searchUsers(String wildcard,
AMSearchControl searchControl,
String avfilter)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - 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 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.
AMSearchResults searchUsers(AMSearchControl searchControl,
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 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
AMSearchResults searchUsers(String wildcard,
Map avPairs,
String userSearchTemplate,
AMSearchControl searchControl)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching usersuserSearchTemplate - Name of user search template to be used.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
Set createResources(Set resourceNames)
throws AMException,
SSOException
resourceNames - Names of the resources to be created.
AMResource objects
AMException - If there is an error when trying to save to the data store
SSOException - If the SSO Token is invalid.
Set createResources(Map resourceMap)
throws AMException,
SSOException
resourceMap - Map of resource names to be created and attributes to be set
in the newly creates resource.
AMResource objects.
AMException - If there is an error when trying to save to the data store
SSOException - If the SSO Token is invalid.
Set createEntities(String type,
Set entities)
throws AMException,
SSOException
DAI, can be created using
this method.
type - Type of entity to be create (For example "user" or "agent")entities - Set of names for the entities to be created
AMEntity objects
AMException - If there is an error when trying to save to the data store
SSOException - If the SSO Token is invalid.
Set createEntities(String stype,
Map entities)
throws AMException,
SSOException
DAI, can be created
using this method.
stype - Type of entity to be create (For example "user" or "agent")entities - Map where the key is the name of the entity, and the value is
a Map to represent Attribute-Value Pairs
AMEntity objects created
AMException - if an error is encountered when trying to create entity in
the data store.
SSOException - if the single sign on token is no longer valid
Set searchResources(String wildcard,
int level,
String resourceSearchTemplate,
Map avPairs)
throws AMException,
SSOException
resourceSearchTemplate, if provided. Otherwise, it uses
the BasicResourceSearchTemplate.
wildcard - wildcard pattern to be used in the searchlevel - the search level that needs to be used (
AMConstants.SCOPE_ONE
or AMConstants.SCOPE_TREE)resourceSearchTemplate - Name of resource search template to be used.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 store.
SSOException - if the single sign on token is no longer valid.
AMSearchResults searchResources(String wildcard,
Map avPairs,
String rSearchTemplate,
AMSearchControl searchControl)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching usersrSearchTemplate - Name of resource search template to be used.searchControl - specifies the search scope to be used, VLV ranges etc.,
AMSearchResults which contains a Set DNs of
resources 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
Set searchEntities(String wildcard,
int level,
String eSearchTemplate,
Map avPairs)
throws AMException,
SSOException
eSearchTemplate, if provided. Otherwise, it uses the
BasicEntitySearch template.
wildcard - wildcard pattern to be used in the searchlevel - the search level that needs to be used (
AMConstants.SCOPE_ONE
or AMConstants.SCOPE_SUB)eSearchTemplate - Name of search template to be used.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 store.
SSOException - if the single sign on token is no longer valid.
AMSearchResults searchEntities(String wildcard,
Map avPairs,
String eSearchTemplate,
AMSearchControl searchControl)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching userseSearchTemplate - Name of search template to be used.searchControl - specifies the search scope to be used, VLV ranges etc.,
AMSearchResults which contains a Set DNs of
resources 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
AMSearchResults searchEntities(String wildcard,
AMSearchControl searchControl,
String avfilter,
String eSearchTemplate)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchsearchControl - specifies the search scope to be used, VLV ranges etc.avfilter - this attribute-value pairs filter will be logical AND with
user search filter.eSearchTemplate - Name of search template to be used. If a null is passed then
the default search template for entities
BasicEntitySearch is used.
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
void deleteResources(Set resources)
throws AMException,
SSOException
resources - The set of resource DNs to be removed.
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
void deleteEntities(Set resources)
throws AMException,
SSOException
resources - The set of resource DNs to be removed.
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
Set searchSubPeopleContainers(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_SUB)
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
Set searchSubPeopleContainers(String wildcard,
Map avPairs,
int level)
throws AMException,
SSOException
wildcard - wildcard pattern to be used in the searchavPairs - attribute-value pairs to match when searching people
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 store
SSOException - if the single sign on token is no longer valid
|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||