|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The AMOrganizationalUnit
interface provides methods to manage
organizational unit
AMOrganizationalUnit
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(oDN)) { AMOrganizationalUnit org = amsc.getOrganizationalUnit(oDN); }
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 |
assignService(java.lang.String serviceName,
java.util.Map attrMap)
Assign service to the organizational unit. |
java.util.Set |
createAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
Creates assignable dynamic groups. |
java.util.Set |
createDynamicGroups(java.util.Map dynamicGroups)
Creates dynamic groups and initializes their attributes. |
java.util.Set |
createEntities(java.lang.String stype,
java.util.Map entities)
Creates entities and initializes their attributes. |
java.util.Set |
createEntities(java.lang.String type,
java.util.Set entities)
Create managed entities in this container. |
java.util.Set |
createFilteredRoles(java.util.Map roles)
Creates filtered roles. |
java.util.Set |
createFilteredRoles(java.util.Set roles)
Creates filtered roles. |
java.util.Set |
createGroupContainers(java.util.Map groupContainers)
Creates group containers and initializes their attributes. |
java.util.Set |
createGroupContainers(java.util.Set groupContainers)
Creates group containers. |
java.util.Set |
createOrganizations(java.util.Map organizations)
Creates organizations and initializes their attributes. |
java.util.Set |
createOrganizations(java.util.Set organizations)
Creates organizations. |
java.util.Set |
createPeopleContainers(java.util.Map peopleContainers)
Creates people containers and initializes their attributes. |
java.util.Set |
createPeopleContainers(java.util.Set peopleContainers)
Creates people containers. |
java.util.Set |
createRoles(java.util.Map roles)
Creates roles. |
java.util.Set |
createRoles(java.util.Set roles)
Creates roles. |
java.util.Set |
createStaticGroups(java.util.Set groups)
Creates static groups. |
java.util.Set |
createSubOrganizationalUnits(java.util.Map subOrganizationalUnits)
Creates sub-organizational units and initializes their attributes. |
java.util.Set |
createSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
Creates sub-organizational units. |
java.util.Set |
createUsers(java.util.Map users)
Creates users and initializes their attributes.For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service
iPlanetAMAdminConsoleService template are added. |
java.util.Set |
createUsers(java.util.Set users)
Creates users and initializes their attributes. |
boolean |
deleteAllNamedPolicyTemplates(java.lang.String policyDN)
Deletes all the named policy templates for this Organizational Unit corresponding to the given policy. |
void |
deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
Deletes assignable dynamic groups. |
void |
deleteDynamicGroups(java.util.Set dynamicGroups)
Deletes dynamic groups. |
void |
deleteEntities(java.util.Set resources)
Deletes a set of resources in this people container. |
void |
deleteFilteredRoles(java.util.Set roles)
Deletes filtered roles. |
void |
deleteGroupContainers(java.util.Set groupContainers)
Deletes group containers. |
void |
deleteOrganizations(java.util.Set organizations)
Deletes organizations |
void |
deletePeopleContainers(java.util.Set peopleContainers)
Creates people containers and initializes their attributes. |
void |
deleteRoles(java.util.Set roles)
Deletes roles. |
void |
deleteStaticGroups(java.util.Set groups)
Deletes static groups. |
void |
deleteSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
Deletes sub organizational units |
void |
deleteUsers(java.util.Set users)
Deletes users from this organizational unit. |
java.util.Set |
getAssignableDynamicGroups(int level)
Returns the assignable dynamic groups within the specified level. |
java.util.Set |
getAssignedPolicyDNs()
Returns all the assigned policies for this organizational unit. |
java.util.Set |
getDynamicGroups(int level)
Gets the dynamic groups within the specified level. |
java.util.Set |
getFilteredRoles(int level)
Gets the filtered roles within the specified level. |
java.util.Set |
getGroupContainers(int level)
Gets the group containers within the specified level. |
long |
getNumberOfAssignableDynamicGroups(int level)
Gets number of assignable dynamic groups within the specified level. |
long |
getNumberOfDynamicGroups(int level)
Gets number of dynamic groups within the specified level. |
long |
getNumberOfFilteredRoles(int level)
Gets number of filtered roles within the specified level. |
long |
getNumberOfGroupContainers(int level)
Gets number of group containers within the specified level. |
long |
getNumberOfOrganizations(int level)
Gets number of organizations within the specified level. |
long |
getNumberOfPeopleContainers(int level)
Gets number of people containers within the specified level. |
long |
getNumberOfRoles(int level)
Gets number of roles within the specified level. |
long |
getNumberOfServices()
Returns the number of services. |
long |
getNumberOfStaticGroups(int level)
Gets number of static groups within the specified level. |
long |
getNumberOfSubOrganizationalUnits(int level)
Gets number of sub organizational units within the specified level. |
long |
getNumberOfUsers(int level)
Gets number of users within the specified level. |
AMOrganization |
getOrganization(java.lang.String dn)
Gets the organization by DN |
java.util.Set |
getOrganizations(int level)
Gets the organizations within the specified level. |
java.util.Set |
getPeopleContainers(int level)
Gets the people containers within the specified level. |
java.util.Set |
getRegisteredServiceNames()
Gets the names of registered services. |
java.util.Set |
getRoles(int level)
Gets the roles within the specified level. |
java.util.Set |
getStaticGroups(int level)
Gets the static groups within the specified level. |
AMOrganizationalUnit |
getSubOrganizationalUnit(java.lang.String dn)
Gets the sub-organizational unit by DN |
java.util.Set |
getSubOrganizationalUnits(int level)
Gets the sub organizational units within the specified level. |
java.util.Set |
getUserDNs()
Gets the names (DNs) of users in the organizational unit. |
boolean |
isPolicyAssigned(java.lang.String policyDN,
java.lang.String serviceName)
Returns true if a policyDN is assigned to this
organizational unit or a role. |
void |
modifyAllPolicyTemplates(java.lang.String serviceName,
java.util.Set policyDNs)
Modifies all the templates under this organizational unit that contain any policyDN in given policyDNs . |
boolean |
orgTemplateExists(java.lang.String serviceName)
Returns true if an organizational template exists for the service. |
void |
registerService(java.lang.String serviceName,
boolean createTemplate,
boolean activate)
Register a service for this organizational unit. |
AMSearchResults |
searchAllRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for all roles in this organizational unit using wildcards. |
java.util.Set |
searchAllRoles(java.lang.String wildcard,
int level)
Searches for all roles in this organizational unit using wildcards. |
AMSearchResults |
searchAllRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for all roles in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchAllRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for all roles in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchAssignableDynamicGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for assignable dynamic groups in this organizational unit using wildcards. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
int level)
Searches for assignable dynamic groups in this organizational unit using wildcards. |
AMSearchResults |
searchAssignableDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchDynamicGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for dynamic groups in this organization unit using wildcards. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
int level)
Searches for dynamic groups in this organization unit using wildcards. |
AMSearchResults |
searchDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for dynamic groups in this organization unit using wildcards and attribute values. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for dynamic groups in this organization unit using wildcards and attribute values. |
AMSearchResults |
searchEntities(java.lang.String wildcard,
AMSearchControl searchControl,
java.lang.String avfilter,
java.lang.String eSearchTemplate)
Searches for entities in this container using wildcards and a filter. |
java.util.Set |
searchEntities(java.lang.String wildcard,
int level,
java.lang.String eSearchTemplate,
java.util.Map avPairs)
Searches for resources in this organization using wildcards and attribute values. |
AMSearchResults |
searchEntities(java.lang.String wildcard,
java.util.Map avPairs,
java.lang.String eSearchTemplate,
AMSearchControl searchControl)
Searches for resources in this people container using wildcards and attribute values. |
AMSearchResults |
searchFilteredRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for filtered roles in this organization using wildcards. |
java.util.Set |
searchFilteredRoles(java.lang.String wildcard,
int level)
Searches for filtered roles in this organization using wildcards. |
AMSearchResults |
searchFilteredRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for filtered roles in this organization using wildcards and attribute values. |
java.util.Set |
searchFilteredRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for filtered roles in this organization using wildcards and attribute values. |
AMSearchResults |
searchGroupContainers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for group containers in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchGroupContainers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for group containers in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for groups in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for groups in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchOrganizations(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for organizations in this organizational unit using wildcards. |
java.util.Set |
searchOrganizations(java.lang.String wildcard,
int level)
Searches for organizations in this organizational unit using wildcards. |
AMSearchResults |
searchOrganizations(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for organizations in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchOrganizations(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for organizations in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchPeopleContainers(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for people containers in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchPeopleContainers(java.lang.String wildcard,
int level)
Searches for people containers in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchPeopleContainers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for people containers in this organizational unit using wildcards * and * attribute values. |
java.util.Set |
searchPeopleContainers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for people containers in this organizational unit using wildcards * and * attribute values. |
AMSearchResults |
searchRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for roles in this organizational unit using wildcards. |
java.util.Set |
searchRoles(java.lang.String wildcard,
int level)
Searches for roles in this organizational unit using wildcards. |
AMSearchResults |
searchRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for roles in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for roles in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchStaticGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for static groups in this organizational unit using wildcards. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
int level)
Searches for static groups in this organizational unit using wildcards. |
AMSearchResults |
searchStaticGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for static groups in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for static groups in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchSubOrganizationalUnits(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for sub organizational units in this organizational unit using wildcards. |
java.util.Set |
searchSubOrganizationalUnits(java.lang.String wildcard,
int level)
Searches for sub organizational units in this organizational unit using wildcards. |
AMSearchResults |
searchSubOrganizationalUnits(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for sub organizational units in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchSubOrganizationalUnits(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for sub organizational units in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchUsers(AMSearchControl searchControl,
java.lang.String avfilter)
Searches for users in this organization attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
AMSearchControl searchControl)
Searches for users in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
AMSearchControl searchControl,
java.lang.String avfilter)
Searches for users in this organizational unit using wildcards and filter. |
java.util.Set |
searchUsers(java.lang.String wildcard,
int level)
Searches for users in this organizational unit using wildcards and attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Searches for users in this organizational unit using wildcards and attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for users in this organizational unit using wildcards and attribute values. |
void |
unassignAllPolicies(java.lang.String serviceName,
java.util.Set policyDNs)
Unassigns the given policies from this organizational unit and its roles. |
void |
unassignServices(java.util.Set serviceNames)
Unassigns services from the organizational unit. |
void |
unregisterService(java.lang.String serviceName)
Unregister a service for this organizational unit. |
Method Detail |
public java.util.Set createOrganizations(java.util.Set organizations) throws AMException, SSOException
organizations
- The set of organizations names to be created.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 java.util.Set createOrganizations(java.util.Map organizations) throws AMException, SSOException
organizations
- Map where the key is the name of the
organization, 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 single sign on token is no longer validpublic void deleteOrganizations(java.util.Set organizations) throws AMException, SSOException
organizations
- The set of organizations DNs to be deleted.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 AMOrganization getOrganization(java.lang.String dn) throws AMException, SSOException
dn
- DNAMException
- 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 getOrganizations(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 long getNumberOfOrganizations(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 searchOrganizations(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_SUB
)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 AMSearchResults searchOrganizations(java.lang.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 of DNs of
organizations 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 validpublic java.util.Set searchOrganizations(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
organizationslevel
- 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 single sign on token is no longer validpublic AMSearchResults searchOrganizations(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching
organizations.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
organizations 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.public java.util.Set createSubOrganizationalUnits(java.util.Set subOrganizationalUnits) throws AMException, SSOException
subOrganizationalUnits
- The set of sub-organizational units names
to be created.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 java.util.Set createSubOrganizationalUnits(java.util.Map subOrganizationalUnits) throws AMException, SSOException
subOrganizationalUnits
- Map where the key is the name of the
sub organizational unit, 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 storeSSOException
- if the single sign on token is no longer validpublic void deleteSubOrganizationalUnits(java.util.Set subOrganizationalUnits) throws AMException, SSOException
subOrganizationalUnits
- The set of sub organizational units DNs
to be deleted.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 AMOrganizationalUnit getSubOrganizationalUnit(java.lang.String dn) throws AMException, SSOException
dn
- distinguished name.OrganizationalUnit
object.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 java.util.Set getSubOrganizationalUnits(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 getNumberOfSubOrganizationalUnits(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchSubOrganizationalUnits(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_SUB
)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 AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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 of DNs of
sub organizational units 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.public java.util.Set searchSubOrganizationalUnits(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 sub
organizational unitslevel
- 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 single sign on token is no longer validpublic AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching sub
organizational units.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
sub organizational units 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 validpublic java.util.Set createRoles(java.util.Set roles) throws AMException, SSOException
roles
- The set of Roles' names to be created.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 java.util.Set createRoles(java.util.Map roles) throws AMException, SSOException
roles
- Map where the key is the name of the role, 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 single sign on token is no longer validpublic void deleteRoles(java.util.Set roles) throws AMException, SSOException
roles
- The set of roles' DNs to be deleted.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 java.util.Set getRoles(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 getNumberOfRoles(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchRoles(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_SUB
)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 AMSearchResults searchRoles(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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 of DNs of
roles 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.public java.util.Set searchRoles(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 roleslevel
- 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 single sign on token is no longer validpublic AMSearchResults searchRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching rolessearchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
roles 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.public java.util.Set createFilteredRoles(java.util.Set roles) throws AMException, SSOException
roles
- The set of filtered roles' names to be created.FilteredRole
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 validpublic java.util.Set createFilteredRoles(java.util.Map roles) throws AMException, SSOException
roles
- Map where the key is the name of the filtered role,
and the value is a Map to represent Attribute-Value PairsFilteredRole
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.public void deleteFilteredRoles(java.util.Set roles) throws AMException, SSOException
roles
- The set of filtered roles' DNs to be deleted.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 java.util.Set getFilteredRoles(int level) throws AMException, SSOException
level
- The search level starting from the organization.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 getNumberOfFilteredRoles(int level) throws AMException, SSOException
level
- The search level starting from the organization.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 java.util.Set searchFilteredRoles(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_SUB
)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 AMSearchResults searchFilteredRoles(java.lang.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 of DNs of
filtered roles 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.public java.util.Set searchFilteredRoles(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 filtered
roleslevel
- 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 single sign on token is no longer validpublic AMSearchResults searchFilteredRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching filtered
roles.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
filtered roles 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.public java.util.Set searchAllRoles(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_SUB
)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 AMSearchResults searchAllRoles(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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 of DNs of
all roles 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.public java.util.Set searchAllRoles(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 all roleslevel
- 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 single sign on token is no longer validpublic AMSearchResults searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching all rolessearchControl
- specifies the search scope to be used, VLV
ranges etc.,AMSearchResults
which contains a Set of DNs of
all roles 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.public java.util.Set createAssignableDynamicGroups(java.util.Set assignableDynamicGroups) throws AMException, SSOException
assignableDynamicGroups
- The set of assignable dynamic groups's
names to be created.AssignableDynamicGroup
objects created.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 assignableDynamicGroups) throws AMException, SSOException
assignableDynamicGroups
- The set of assignable dynamic groups's
DNs to be deleted.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 java.util.Set getAssignableDynamicGroups(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.AssignableDynamicGroups
within
the specified level.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 getNumberOfAssignableDynamicGroups(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchAssignableDynamicGroups(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_SUB
)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 AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
Set of DNs of assignable
dynamic 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.public java.util.Set searchAssignableDynamicGroups(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 assignable
dynamic 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 single sign on token is no longer validpublic AMSearchResults searchAssignableDynamicGroups(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 assignable
dynamic groupssearchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
assignable dynamic 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 validpublic java.util.Set createDynamicGroups(java.util.Map dynamicGroups) throws AMException, SSOException
dynamicGroups
- Map where the key is the name of the dynamic group,
and the value is a Map to represent Attribute-Value Pairs.AMDynamicGroup
objects createdAMException
- 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 dynamicGroups) throws AMException, SSOException
dynamicGroups
- The set of dynamic groups's DNs to be deleted.AMException
- if there is an internal error in the access
management data store.SSOException
- if the single sign on token is no longer validpublic java.util.Set getDynamicGroups(int level) throws AMException, SSOException
level
- The search level starting from the organization unit.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 getNumberOfDynamicGroups(int level) throws AMException, SSOException
level
- The search level starting from the organization unit.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 java.util.Set searchDynamicGroups(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_SUB
)AMException
- if there is an internal error in the access
management data storeSSOException
- if the single sign on token is no longer valid.public AMSearchResults searchDynamicGroups(java.lang.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 of DNs of
dynamic 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 validpublic java.util.Set searchDynamicGroups(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 dynamic
groups.level
- 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.public AMSearchResults searchDynamicGroups(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 dynamic
groups.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
dynamic 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.public java.util.Set createStaticGroups(java.util.Set groups) throws AMException, SSOException
groups
- The set of static groups's names to be created.AMStaticGroup
objects created.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 deleteStaticGroups(java.util.Set groups) throws AMException, SSOException
groups
- The set of static groups's DNs to be deleted.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 java.util.Set getStaticGroups(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 getNumberOfStaticGroups(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchStaticGroups(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_SUB
).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 AMSearchResults searchStaticGroups(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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 of DNs of
static 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.public java.util.Set searchStaticGroups(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 static
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 single sign on token is no longer validpublic AMSearchResults searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching static
groups.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of DNs of
static 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.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_SUB
)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 AMSearchResults searchGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
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 Set a of DNs 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.public java.util.Set createPeopleContainers(java.util.Set peopleContainers) throws AMException, SSOException
peopleContainers
- set of people containers' names to be created.PeopleContainer
objects createdAMException
- 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 createPeopleContainers(java.util.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.AMException
- if there is an internal error in the access
management data store.SSOException
- if the single sign on token is no longer validpublic void deletePeopleContainers(java.util.Set 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.public java.util.Set getPeopleContainers(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 getNumberOfPeopleContainers(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchPeopleContainers(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_SUB
)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 AMSearchResults searchPeopleContainers(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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
people containers 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.public java.util.Set searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, int level) throws AMException, SSOException
wildcard
- pattern to be used in the search.avPairs
- attribute-value pairs to match when searching people
containers.level
- 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.public AMSearchResults searchPeopleContainers(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 people
containers.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set DNs of
people containers 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 validpublic java.util.Set createGroupContainers(java.util.Set groupContainers) throws AMException, SSOException
groupContainers
- The set of group containers' names to be createdGroupContainer
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.public java.util.Set createGroupContainers(java.util.Map groupContainers) throws AMException, SSOException
groupContainers
- Map where the key is the name of the
groupContainer
, and the value is a Map to
represent Attribute-Value Pairs.GroupContainer
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.public void deleteGroupContainers(java.util.Set groupContainers) throws AMException, SSOException
groupContainers
- The set of group containers' DN to be deleted.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 java.util.Set getGroupContainers(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 getNumberOfGroupContainers(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchGroupContainers(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 single sign on token is no longer validpublic AMSearchResults searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- pattern to be used in the search.avPairs
- attribute-value pairs to match when searching group
containers.searchControl
- specifies the search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set DNs of group
containers matching the search.AMException
- if there is an internal error in the access
management data store.SSOException
- if the single sign on token is no longer valid.public java.util.Set createUsers(java.util.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
- Map where the key is the name of the user, and the value is
a Map to represent Attribute-Value PairsAMException
- if there is an internal error in the access management data storeSSOException
- if the single sign on token is no longer validpublic java.util.Set createUsers(java.util.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 PairsAMException
- 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 deleteUsers(java.util.Set users) throws AMException, SSOException
users
- The set of user DN's to be deleted from the organizational
unit.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 java.util.Set getUserDNs() throws AMException, SSOException
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 getNumberOfUsers(int level) throws AMException, SSOException
level
- The search level starting from the organizational unit.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 java.util.Set searchUsers(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_SUB
)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 AMSearchResults searchUsers(java.lang.String wildcard, AMSearchControl searchControl) throws AMException, SSOException
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 validpublic java.util.Set searchUsers(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 userslevel
- 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 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 search scope to be used, VLV
ranges etc.AMSearchResults
which contains a Set of 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 validpublic AMSearchResults searchUsers(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.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 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 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 DNs of Users
matching the search.AMException
- if there is an internal error in the access
management data store.SSOException
- if the single sign on token is no longer validpublic long getNumberOfServices() throws AMException, SSOException
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 java.util.Set getRegisteredServiceNames() throws AMException, SSOException
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 registerService(java.lang.String serviceName, boolean createTemplate, boolean activate) throws AMException, SSOException
serviceName
- The name of service to be registeredcreateTemplate
- true if to create default templateactivate
- true if to activate the serviceAMException
- if the service does not exist or could not be
registered.SSOException
- if the single sign on token is no longer valid.public void unregisterService(java.lang.String serviceName) throws AMException, SSOException
serviceName
- service name to be unregisteredAMException
- if the service does not exist or could not be
unregistered.SSOException
- if the single sign on token is no longer valid.public void unassignAllPolicies(java.lang.String serviceName, java.util.Set policyDNs) throws AMException, SSOException
serviceName
- service name.policyDNs
- Set of policy DN stringAMException
- 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 modifyAllPolicyTemplates(java.lang.String serviceName, java.util.Set policyDNs) throws AMException, SSOException
policyDN
in given policyDNs
.serviceName
- service name.policyDNs
- Set of policy DN string.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 boolean deleteAllNamedPolicyTemplates(java.lang.String policyDN) throws AMException, SSOException
policyDN
- a policy DN string.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 getAssignedPolicyDNs() 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 boolean isPolicyAssigned(java.lang.String policyDN, java.lang.String serviceName) throws AMException, SSOException
policyDN
is assigned to this
organizational unit or a role.policyDN
- a policy DN.serviceName
- service name.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 boolean orgTemplateExists(java.lang.String serviceName) throws AMException, SSOException
serviceName
- service nameAMException
- 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 assignService(java.lang.String serviceName, java.util.Map attrMap) throws AMException, SSOException
serviceName
- Name of service to be assigned to user.attrMap
- Map of attribute name and values (as a Set) to be setAMException
- if an error is encounters when trying to
access/retrieve data from the data store.SSOException
- if the single sign on token is no longer valid.public void unassignServices(java.util.Set serviceNames) throws AMException, SSOException
unassignServices
in interface AMObject
serviceNames
- Set of service names.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 createEntities(java.lang.String type, java.util.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 createdAMEntity
objectsAMException
- If there is an error when trying to save to
the data storeSSOException
- if the single sign on token is invalid.public java.util.Set createEntities(java.lang.String stype, java.util.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 PairsAMEntity
objects createdAMException
- if an error is encountered when trying to
create entity in the data store.SSOException
- if the single sign on token is no longer validpublic java.util.Set searchEntities(java.lang.String wildcard, int level, java.lang.String eSearchTemplate, java.util.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. If a null is
passed then the default search template for entities
BasicEntitySearch
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.public AMSearchResults searchEntities(java.lang.String wildcard, java.util.Map avPairs, java.lang.String eSearchTemplate, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- 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.public AMSearchResults searchEntities(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter, java.lang.String eSearchTemplate) throws AMException, SSOException
wildcard
- pattern to be used in the search.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.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.public void deleteEntities(java.util.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |