|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides methods to manage organization.
AMOrganization
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)) { AMOrganization org = amsc.getOrganization(oDN); }
Field Summary |
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 | |
AMGroup |
createAssignableDynamicGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Deprecated. Creates assignable dynamic group. |
java.util.Set |
createAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
Deprecated. Creates assignable dynamic groups. |
AMGroup |
createDynamicGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Deprecated. Creates dynamic group. |
java.util.Set |
createDynamicGroups(java.util.Map dynamicGroups)
Deprecated. Creates dynamic groups and initializes their attributes. |
java.util.Set |
createEntities(int type,
java.util.Map entityNamesAndAttrs)
Deprecated. Creates the entities of the given type. |
java.util.Set |
createEntities(int type,
java.util.Set entityNames)
Deprecated. This method creates the entities of the given type. |
java.util.Set |
createFilteredRoles(java.util.Map roles)
Deprecated. Creates filtered roles. |
java.util.Set |
createFilteredRoles(java.util.Set roles)
Deprecated. Creates filtered roles. |
java.util.Set |
createGroupContainers(java.util.Map groupContainers)
Deprecated. Creates group containers and initializes their attributes. |
java.util.Set |
createGroupContainers(java.util.Set groupContainers)
Deprecated. Creates group containers. |
java.lang.String |
createOrganization(java.lang.String orgName,
java.lang.String domainName,
java.util.Map attrMap,
java.util.Map serviceNamesAndAttrs)
Deprecated. Creates sub-organizations and initializes their attributes. |
java.util.Set |
createOrganizationalUnits(java.util.Map organizationalUnits)
Deprecated. Creates organizational units and initializes their attributes. |
java.util.Set |
createOrganizationalUnits(java.util.Set organizationalUnits)
Deprecated. Creates organizational units. |
java.util.Set |
createPeopleContainers(java.util.Map peopleContainers)
Deprecated. Creates people containers and initializes their attributes. |
java.util.Set |
createPeopleContainers(java.util.Set peopleContainers)
Deprecated. Creates people containers. |
java.util.Set |
createRoles(java.util.Map roles)
Deprecated. Creates roles. |
java.util.Set |
createRoles(java.util.Set roles)
Deprecated. Creates roles. |
AMGroup |
createStaticGroup(java.lang.String name,
java.util.Map attributes,
java.util.Map serviceNameAndAttrs)
Deprecated. Creates static group. |
java.util.Set |
createStaticGroups(java.util.Set groups)
Deprecated. Creates static groups. |
java.util.Set |
createSubOrganizations(java.util.Map subOrganizations)
Deprecated. Creates sub-organizations and initializes their attributes. |
java.util.Set |
createSubOrganizations(java.util.Set subOrganizations)
Deprecated. Creates sub-organizations. |
AMUser |
createUser(java.lang.String uid,
java.util.Map attrMap,
java.util.Map serviceNameAndAttrs)
Deprecated. Create user and initializes the attributes. |
java.util.Set |
createUsers(java.util.Map users)
Deprecated. Creates users and initializes their attributes. |
java.util.Set |
createUsers(java.util.Set users)
Deprecated. Creates users in this organization. |
boolean |
deleteAllNamedPolicyTemplates(java.lang.String policyDN)
Deprecated. Deletes all the named policy templates for this Organization corresponding to the given policy. |
void |
deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
Deprecated. Deletes assignable dynamic groups. |
void |
deleteDynamicGroups(java.util.Set dynamicGroups)
Deprecated. Deletes dynamic groups. |
void |
deleteEntities(int type,
java.util.Set entityDNs)
Deprecated. Deletes the entities whose fully-qualified distinguished names are provided in the set below. |
void |
deleteFilteredRoles(java.util.Set roles)
Deprecated. Deletes filtered roles. |
void |
deleteGroupContainers(java.util.Set groupContainers)
Deprecated. Deletes group containers. |
void |
deleteOrganizationalUnits(java.util.Set organizationalUnits)
Deprecated. Deletes organizational units |
void |
deletePeopleContainers(java.util.Set peopleContainers)
Deprecated. Deletes people containers. |
void |
deleteRoles(java.util.Set roles)
Deprecated. Deletes roles. |
void |
deleteStaticGroups(java.util.Set groups)
Deprecated. Deletes static groups. |
void |
deleteSubOrganizations(java.util.Set subOrganizations)
Deprecated. Deletes sub organizations. |
void |
deleteUsers(java.util.Set users)
Deprecated. Deletes users from this organization. |
java.util.Set |
getAssignableDynamicGroups(int level)
Deprecated. Returns the assignable dynamic groups within the specified level. |
java.util.Set |
getAssignedPolicyDNs()
Deprecated. Gets all the assigned policies for this Organization |
java.util.Set |
getDynamicGroups(int level)
Deprecated. Gets the dynamic groups within the specified level. |
java.util.Set |
getFilteredRoles(int level)
Deprecated. Gets the filtered roles within the specified level. |
java.util.Set |
getGroupContainers(int level)
Deprecated. Gets the group containers within the specified level. |
long |
getNumberOfAssignableDynamicGroups(int level)
Deprecated. Gets number of assignable dynamic groups within the specified level. |
long |
getNumberOfDynamicGroups(int level)
Deprecated. Gets number of dynamic groups within the specified level. |
long |
getNumberOfFilteredRoles(int level)
Deprecated. Gets number of filtered roles within the specified level. |
long |
getNumberOfGroupContainers(int level)
Deprecated. Gets number of group containers within the specified level. |
long |
getNumberOfOrganizationalUnits(int level)
Deprecated. Gets number of organizational units within the specified level. |
long |
getNumberOfPeopleContainers(int level)
Deprecated. Gets number of people containers within the specified level. |
long |
getNumberOfRoles(int level)
Deprecated. Gets number of roles within the specified level. |
long |
getNumberOfServices()
Deprecated. Returns the number of services. |
long |
getNumberOfStaticGroups(int level)
Deprecated. Gets number of static groups within the specified level. |
long |
getNumberOfSubOrganizations(int level)
Deprecated. Gets number of sub organizations within the specified level. |
long |
getNumberOfUsers(int level)
Deprecated. Gets number of users within the specified level. |
AMOrganizationalUnit |
getOrganizationalUnit(java.lang.String dn)
Deprecated. Gets the organizational unit by DN. |
java.util.Set |
getOrganizationalUnits(int level)
Deprecated. Gets the organizational units within the specified level. |
java.util.Set |
getPeopleContainers(int level)
Deprecated. Gets the people containers within the specified level. |
java.util.Set |
getRegisteredServiceNames()
Deprecated. Gets the names of registered services. |
java.util.Set |
getRoles(int level)
Deprecated. Gets the roles within the specified level. |
java.util.Set |
getStaticGroups(int level)
Deprecated. Gets the static groups within the specified level. |
AMOrganization |
getSubOrganization(java.lang.String dn)
Deprecated. Returns the sub-organization by DN |
java.util.Set |
getSubOrganizations(int level)
Deprecated. Gets the sub organizations within the specified level. |
AMUser |
getUser(java.lang.String uid,
java.lang.String userSearchTemplate)
Deprecated. Returns AMUser object of user in this organization
(or in sub organizations), whose naming attribute exactly matches with
uid . |
java.util.Set |
getUserDNs()
Deprecated. Returns the names (DNs) of users in the organization. |
boolean |
isActivated()
Deprecated. Returns true if the organization is activated. |
boolean |
isPolicyAssigned(java.lang.String policyDN,
java.lang.String serviceName)
Deprecated. Returns true if a policyDN is assigned to an organization or
a role. |
void |
modifyAllPolicyTemplates(java.lang.String serviceName,
java.util.Set policyDNs)
Deprecated. Modifies all the templates under this organization that contain any policyDN in given policyDNs . |
boolean |
orgTemplateExists(java.lang.String serviceName)
Deprecated. Returns true if an organizational template exists for the service. |
void |
registerService(java.lang.String serviceName,
boolean createTemplate,
boolean activate)
Deprecated. Register a service for this organization. |
AMSearchResults |
searchAllRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for all roles in this organization using wildcards. |
java.util.Set |
searchAllRoles(java.lang.String wildcard,
int level)
Deprecated. Searches for all roles in this organization using wildcards. |
AMSearchResults |
searchAllRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for all roles in this organization using wildcards and attribute values. |
java.util.Set |
searchAllRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for all roles in this organization using wildcards and attribute values. |
AMSearchResults |
searchAssignableDynamicGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
int level)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards. |
AMSearchResults |
searchAssignableDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards and attribute values. |
java.util.Set |
searchAssignableDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchAssignableDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
java.lang.String groupSearchTemplate,
AMSearchControl searchControl)
Deprecated. Searches for assignable dynamic groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchDynamicGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for dynamic groups in this organization using wildcards. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
int level)
Deprecated. Searches for dynamic groups in this organization using wildcards. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Deprecated. Searches for dynamic groups in this organization using wildcards. |
AMSearchResults |
searchDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for dynamic groups in this organization using wildcards and attribute values. |
java.util.Set |
searchDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for dynamic groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchDynamicGroups(java.lang.String wildcard,
java.util.Map avPairs,
java.lang.String groupSearchTemplate,
AMSearchControl searchControl)
Deprecated. Searches for dynamic groups in this organization using wildcards and attribute values. |
java.util.Set |
searchEntities(int type,
java.lang.String wildcard,
int scope,
java.util.Map avPairs)
Deprecated. Searches for entities of the given type. |
AMSearchResults |
searchEntities(int type,
java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl ctrls)
Deprecated. Searches for entities of the given type. |
AMSearchResults |
searchEntities(int type,
java.lang.String wildcard,
java.lang.String avfilter,
AMSearchControl ctrl)
Deprecated. Searches for entities of the given type. |
AMSearchResults |
searchFilteredRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for filtered roles in this organization using wildcards. |
java.util.Set |
searchFilteredRoles(java.lang.String wildcard,
int level)
Deprecated. Searches for filtered roles in this organization using wildcards. |
AMSearchResults |
searchFilteredRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. 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)
Deprecated. Searches for filtered roles in this organization using wildcards and attribute values. |
AMSearchResults |
searchGroupContainers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for group containers in this organization using wildcards and attribute values. |
java.util.Set |
searchGroupContainers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for group containers in this organization using wildcards and attribute values. |
AMSearchResults |
searchGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for groups in this organization using wildcards and attribute values. |
java.util.Set |
searchGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchOrganizationalUnits(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for organizational units in this organization using wildcards. |
java.util.Set |
searchOrganizationalUnits(java.lang.String wildcard,
int level)
Deprecated. Searches for organizational units in this organization using wildcards. |
AMSearchResults |
searchOrganizationalUnits(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for organizational units in this organization using wildcards and attribute values. |
java.util.Set |
searchOrganizationalUnits(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for organizational units in this organization using wildcards and attribute values. |
AMSearchResults |
searchPeopleContainers(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for people containers in this organization using wildcards and attribute values. |
java.util.Set |
searchPeopleContainers(java.lang.String wildcard,
int level)
Deprecated. Searches for people containers in this organization using wildcards and attribute values. |
AMSearchResults |
searchPeopleContainers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for people containers in this organization using wildcards and attribute values. |
java.util.Set |
searchPeopleContainers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for people containers in this organization using wildcards and attribute values. |
AMSearchResults |
searchRoles(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for roles in this organization using wildcards. |
java.util.Set |
searchRoles(java.lang.String wildcard,
int level)
Deprecated. Searches for roles in this organization using wildcards. |
AMSearchResults |
searchRoles(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for roles in this organization using wildcards and attribute values. |
java.util.Set |
searchRoles(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for roles in this organization using wildcards and attribute values. |
AMSearchResults |
searchStaticGroups(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for static groups in this organization using wildcards. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
int level)
Deprecated. Searches for static groups in this organization using wildcards. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
int level,
java.lang.String groupSearchTemplate,
java.util.Map avPairs)
Deprecated. Searches for static groups in this organization using wildcards. |
AMSearchResults |
searchStaticGroups(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for static groups in this organization using wildcards and attribute values. |
java.util.Set |
searchStaticGroups(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for static groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchStaticGroups(java.lang.String wildcard,
java.util.Map avPairs,
java.lang.String groupSearchTemplate,
AMSearchControl searchControl)
Deprecated. Searches for static groups in this organization using wildcards and attribute values. |
AMSearchResults |
searchSubOrganizations(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for sub organizations in this organization using wildcards. |
java.util.Set |
searchSubOrganizations(java.lang.String wildcard,
int level)
Deprecated. Searches for sub organizations in this organization using wildcards. |
AMSearchResults |
searchSubOrganizations(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for sub organizations in this organization using wildcards and attribute values. |
java.util.Set |
searchSubOrganizations(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for sub organizations in this organization using wildcards and attribute values. |
AMSearchResults |
searchUsers(AMSearchControl searchControl,
java.lang.String avfilter)
Deprecated. Searches for users in this organization using attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
AMSearchControl searchControl)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
AMSearchControl searchControl,
java.lang.String avfilter)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard,
int level)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard,
int level,
java.lang.String userSearchTemplate,
java.util.Map avPairs)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
AMSearchControl searchControl)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
AMSearchResults |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
java.lang.String userSearchTemplate,
AMSearchControl searchControl)
Deprecated. Searches for users in this organization using wildcards and attribute values. |
void |
unassignAllPolicies(java.lang.String serviceName,
java.util.Set policyDNs)
Deprecated. Unassigns the given policies from this organization and its roles. |
void |
unassignServices(java.util.Set serviceNames)
Deprecated. Unassigns services from the organization. |
void |
unregisterService(java.lang.String serviceName)
Deprecated. Unregisters a service for this organization. |
Method Detail |
public java.util.Set createSubOrganizations(java.util.Set subOrganizations) throws AMException, SSOException
subOrganizations
- The set of sub-organizations names to be 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 createSubOrganizations(java.util.Map subOrganizations) throws AMException, SSOException
subOrganizations
- Map where the key is the name of the
sub organization, 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.public java.lang.String createOrganization(java.lang.String orgName, java.lang.String domainName, java.util.Map attrMap, java.util.Map serviceNamesAndAttrs) throws AMException, SSOException
objectclasses
and attributes as provided
in the serviceNameAndAttrs
map.
orgName
- name of organization to be created under this
organization.domainName
- name of the domain
(example sun.com, iplanet.com
).attrMap
- Map of attribute-value pairs to be set on the entry.serviceNamesAndAttrs
- Map of service names and attribute-values
for that service to be set in the organization entry.
serviceNameAndAttrs
has service names keys and
map of attribute-values (values are in a Set).
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 deleteSubOrganizations(java.util.Set subOrganizations) throws AMException, SSOException
subOrganizations
- The set of sub organization 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 validpublic AMOrganization getSubOrganization(java.lang.String dn) throws AMException, SSOException
dn
- distinguished name.
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 getSubOrganizations(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 store
SSOException
- if the single sign on token is no longer validpublic long getNumberOfSubOrganizations(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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set searchSubOrganizations(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 store
SSOException
- if the single sign on token is no longer validpublic AMSearchResults searchSubOrganizations(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
sub 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 searchSubOrganizations(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
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 store
SSOException
- if the single sign on token is no longer validpublic AMSearchResults searchSubOrganizations(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
organizations.searchControl
- specifies the search scope to be used, VLV
ranges etc.
AMSearchResults
which contains a Set of DNs of sub
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 createOrganizationalUnits(java.util.Set organizationalUnits) throws AMException, SSOException
organizationalUnits
- The set of organizational units names to be
created.
OrganizationalUnit
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 createOrganizationalUnits(java.util.Map organizationalUnits) throws AMException, SSOException
organizationalUnits
- Map where the key is the name of the
organizational unit, and the value is a Map to
represent Attribute-Value Pairs
OrganizationalUnit
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 void deleteOrganizationalUnits(java.util.Set organizationalUnits) throws AMException, SSOException
organizationalUnits
- The set of organizational units 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 AMOrganizationalUnit getOrganizationalUnit(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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set getOrganizationalUnits(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 store
SSOException
- if the single sign on token is no longer validpublic long getNumberOfOrganizationalUnits(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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set searchOrganizationalUnits(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 store
SSOException
- if the single sign on token is no longer validpublic AMSearchResults searchOrganizationalUnits(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
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 searchOrganizationalUnits(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
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 store
SSOException
- if the single sign on token is no longer validpublic AMSearchResults searchOrganizationalUnits(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
organizational unitssearchControl
- specifies the search scope to be used, VLV
ranges etc.,
AMSearchResults
which contains a Set of DNs of
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 store
SSOException
- 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 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 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 store
SSOException
- 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 organization.
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 long getNumberOfRoles(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 store
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 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 store
SSOException
- 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 validpublic 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 store
SSOException
- 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 searchavPairs
- 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 validpublic 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 valid.public 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 Pairs
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 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 store
SSOException
- 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 store
SSOException
- 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 store
SSOException
- 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 store
SSOException
- 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 store
SSOException
- 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
- 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 store
SSOException
- 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 searchsearchControl
- 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 store
SSOException
- 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 searchavPairs
- 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 store.
SSOException
- if the single sign on token is no longer valid.public AMGroup createAssignableDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
serviceNameAndAttr
map so that services can be assigned to the group which is just created.
name
- of group to be createdattributes
- attribute-value pairs to be setserviceNameAndAttrs
- service name and attribute map where the map
is like this:
<serviceName><AttrMap>
(attrMap=<attrName><Set of attrvalues>)
AMGroup
object of newly created group.
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.
SSOException
- if the single sign on token is no longer 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 store
SSOException
- 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 organization.
AssignableDynamicGroups
within the
specified level.
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 long getNumberOfAssignableDynamicGroups(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 store
SSOException
- 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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws AMException, SSOException
groupSearchTemplate
, if provided. Otherwise the
default search template is used.
wildcard
- pattern to be used in the search.level
- the search level that needs to be used
(AMConstants.SCOPE_ONE
or
AMConstants.SCOPE_SUB
).groupSearchTemplate
- name of the search template to be used to
perform this search.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 searchAssignableDynamicGroups(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
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 store
SSOException
- 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 groups.searchControl
- 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 valid.public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, java.lang.String groupSearchTemplate, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching assignable
dynamic groupsgroupSearchTemplate
- Name of search template to be used to performsearchControl
- specifies the search scope to be used, VLV
ranges etc.,
the search.
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 valid.public 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 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 AMGroup createDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
serviceNameAndAttr map
so that services can be assigned to the group which is just created.
- Parameters:
name
- of group to be createdattributes
- to be set in groupserviceNameAndAttrs
- service name and attribute map where the map
is like this:
<serviceName><AttrMap>
(attrMap=<attrName><Set of attrvalues>)
- Returns:
AMGroup
object of newly created group.
- Throws:
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.
SSOException
- if the single sign on token is no longer valid.
public void deleteDynamicGroups(java.util.Set dynamicGroups) throws AMException, SSOException
dynamicGroups
- The set of dynamic groups's 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 validpublic java.util.Set getDynamicGroups(int level) throws AMException, SSOException
level
- The search level starting from the organization.
DynamicGroups
within the
specified level.
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 long getNumberOfDynamicGroups(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 store
SSOException
- 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 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, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws AMException, SSOException
groupSearchTemplate
, if provided. Otherwise uses
the the default GroupSearch
template.
wildcard
- pattern to be used in the search.level
- the search level that needs to be used.groupSearchTemplate
- name of the search template to be used to
perform this search.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.
(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, 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 valid.public 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
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 store
SSOException
- if the single sign on token is no longer validpublic 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
groupssearchControl
- specifies the search scope to be used, VLV
ranges etc.,
AMSearchResults
which contains set a 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 AMSearchResults searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, java.lang.String groupSearchTemplate, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching
dynamic groupsgroupSearchTemplate
- Name of search template to be used to perform
the search.searchControl
- specifies the search scope to be used
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 store.
SSOException
- if the single sign on token is no longer valid.public AMGroup createStaticGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) throws AMException, SSOException
serviceNameAndAttr
map
so that services can be assigned to the group which is just created.
name
- of group to be created.attributes
- to be set in group node.serviceNameAndAttrs
- service name and attribute map where the map
is like this:
<serviceName><AttrMap>
(attrMap=<attrName><Set of attrvalues>)
.
AMGroup
object of newly created group.
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.
SSOException
- if the single sign on token is no longer valid.public void 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 store
SSOException
- if the single sign on token is no longer valid
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.public java.util.Set getStaticGroups(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 store
SSOException
- if the single sign on token is no longer valid
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.public long getNumberOfStaticGroups(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 store.
SSOException
- if the single sign on token is no longer valid.
AMException
- if an error is encountered when trying to
access/retrieve data from the data store.public 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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set searchStaticGroups(java.lang.String wildcard, int level, java.lang.String groupSearchTemplate, java.util.Map avPairs) throws AMException, SSOException
groupSearchTemplate
, if provided. If it is null,
default search templates are used.
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE
or
AMConstants.SCOPE_SUB
)groupSearchTemplate
- name of the search template to be used to
perform this search.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 validpublic AMSearchResults searchStaticGroups(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
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 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 store
SSOException
- 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 searchavPairs
- attribute-value pairs to match when searching groupssearchControl
- 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 AMSearchResults searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, java.lang.String groupSearchTemplate, AMSearchControl searchControl) throws AMException, SSOException
wildcard
- wildcard pattern to be used in the search.avPairs
- attribute-value pairs to match when searching
static groups.groupSearchTemplate
- Name of search template to be used to perform
the search.searchControl
- specifies the search scope to be used.
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 store
SSOException
- 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
- The set of people containers' names to be created
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 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.
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 void deletePeopleContainers(java.util.Set peopleContainers) throws AMException, SSOException
peopleContainers
- The set of people containers' DN 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 validpublic java.util.Set getPeopleContainers(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 store
SSOException
- if the single sign on token is no longer validpublic long getNumberOfPeopleContainers(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 store
SSOException
- 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 store
SSOException
- 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
- 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 validpublic AMSearchResults searchPeopleContainers(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 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 valid.public java.util.Set createGroupContainers(java.util.Set groupContainers) throws AMException, SSOException
groupContainers
- The set of group containers' names to be 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
group container, 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.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 store
SSOException
- 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 organization.
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 long getNumberOfGroupContainers(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 store
SSOException
- 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 store
SSOException
- 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
- 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 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 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
- The set of user names to be created in this organization.
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 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 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 validpublic AMUser createUser(java.lang.String uid, java.util.Map attrMap, java.util.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 validpublic void deleteUsers(java.util.Set users) throws AMException, SSOException
users
- The set of user DN's to be deleted from the organization.
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 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 validpublic AMUser getUser(java.lang.String uid, java.lang.String userSearchTemplate) throws AMException, SSOException
AMUser
object of user in this organization
(or in sub organizations), whose naming attribute exactly matches with
uid
. If userSearchTemplate
is not null,
then this search template is used otherwise the
BasicUserSearchTemplate
is used. Any %U
in the
search filter are replaced with uid
. If the search
returns more than one user, an exception is thrown because this is a
violation of the name space constraint.
uid
- naming attribute value for user.userSearchTemplate
- search template.
AMUser
object of user found.
AMException
SSOException
public long getNumberOfUsers(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 store
SSOException
- 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 store
SSOException
- if the single sign on token is no longer validpublic java.util.Set searchUsers(java.lang.String wildcard, int level, java.lang.String userSearchTemplate, java.util.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_SUB
)userSearchTemplate
- Name of search template to be used.
If null is passed then the default search template
BasicUserSearch
will 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.public 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 valid.public 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 store
SSOException
- 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 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 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(java.lang.String wildcard, java.util.Map avPairs, java.lang.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.public 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 of 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 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 getRegisteredServiceNames() throws AMException, SSOException
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 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 service
AMException
- 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 unregistered.
AMException
- 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 string.
AMException
- if there is an internal problem with access
management 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 there is an internal problem with access
management 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 there is an internal problem with access
management data store.
SSOException
- if the single sign on token is no longer valid.public java.util.Set getAssignedPolicyDNs() throws AMException, SSOException
AMException
- if there is an internal problem with access
management 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 an organization or
a role.
policyDN
- a policy DN stringserviceName
- service name
AMException
- if there is an internal error in the access
management data store
SSOException
- if the single sign on token is no longer validpublic boolean orgTemplateExists(java.lang.String serviceName) throws AMException, SSOException
serviceName
- service name
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 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 validpublic java.util.Set createEntities(int type, java.util.Set entityNames) throws AMException, SSOException
DAI
service.
If the specified default container does not exist, then it is created
under the current organization and then the entities are created under
it. If no specified container is specified, then the entities are created
directly under the organization.
type
- Type of entity being created. The types supported by SDK
are configured in the list of Managed Objects in the
DAI
service.entityNames
- Set of names of entities to be created
AMEntity
objects.
AMException
- if an error encountered when trying to set/access
the data store.
SSOException
- if the single sign on token of user is no longer
valid.public java.util.Set createEntities(int type, java.util.Map entityNamesAndAttrs) throws AMException, SSOException
DAI
service. If the
specified default container does not exist, then it is created under
the current organization and then the entities are created under it.
If no specified container is specified, then the entities are created
directly under the organization.
type
- Type of entity being created. The types supported by SDK
are configured in the list of Managed Objects in the
DAI
service.entityNamesAndAttrs
- Map of entity name to a map of attribute
name to a set of values.
AMEntity
objects.
AMException
- if an error encountered when trying to set/access
the data store.
SSOException
- if the single sign on token of user is no longer
valid.public java.util.Set searchEntities(int type, java.lang.String wildcard, int scope, java.util.Map avPairs) throws AMException, SSOException
DAI
service. The map of attribute-value pairs is or-ed
to
the basic search filter along with the wildcard, which is used to
specify the naming attribute in the final search filter.
The search is conducted under the specified container, if it exists.
It the specified container does not exist, then an exception is
thrown.
If there is no specified container, then the search is performed
directly under the organization.
type
- Type of entity being created. The types supported by SDK
are configured in the list of Managed Objects in the
DAI
service.wildcard
- Pattern for naming attribute when performing the search.scope
- Search level that needs to be used
(AMConstants.SCOPE_ONE
or
AMConstants.SCOPE_SUB
).avPairs
- Map of attribute-value pairs.
AMException
- If there is an error trying to access the data store.
SSOException
- If the user's single sign on token is invalid.public AMSearchResults searchEntities(int type, java.lang.String wildcard, java.util.Map avPairs, AMSearchControl ctrls) throws AMException, SSOException
DAI
service. The map of attribute-value pairs is or-ed
to
the basic search filter along with the wildcard, which is used to
specify the naming attribute in the final search filter.
The search is conducted under the specified container, if it exists.
It the specified container does not exist, then an exception is
thrown.
If there is no specified container, then the search is performed
directly under the organization.
type
- The type of entity to be searched. The types are defined
in the list of managed objects in the DAI
service.wildcard
- Pattern for naming attribute when performing the search.avPairs
- Map of attribute-value pairs.ctrls
- Search control object specifying various search parameter.
AMException
- If there is an error trying to access the data store.
SSOException
- If the user's single sign on token is invalid.public AMSearchResults searchEntities(int type, java.lang.String wildcard, java.lang.String avfilter, AMSearchControl ctrl) throws AMException, SSOException
DAI
service. The map of attribute-value pairs is or-ed
to
the basic search filter along with the wildcard, which is used to
specify the naming attribute in the final search filter.
The search is conducted under the specified container, if it exists.
It the specified container does not exist, then an exception is
thrown.
If there is no specified container, then the search is performed
directly under the organization.
type
- The type of entity to be searched. The types are defined
in the list of managed objects in the DAI
service.wildcard
- Pattern for naming attribute when performing the search.avfilter
- Search filter to add to the basic search filter.ctrl
- Search control object specifying various search parameter.
com.iplanet.am.sdk.AMSearchResults
AMException
- If there is an error trying to access the data
store.
SSOException
- If the user's single sign on token is invalid.public void deleteEntities(int type, java.util.Set entityDNs) throws AMException, SSOException
type
- Type of entity being deleted.entityDNs
- Set of the FQDNs
of entities to be
deleted.
AMException
- If there is an error in trying to access the data
store.
SSOException
- If the user's single sign on token is invalid.public boolean isActivated() 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |