com.iplanet.am.sdk
Interface AMOrganization

All Superinterfaces:

AMConstants, AMObject

public interface AMOrganization

extends AMObject

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);
          }
 

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

Fields inherited from interface com.iplanet.am.sdk.AMConstants

ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Method Summary

AMGroup	createAssignableDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) Creates assignable dynamic group.
java.util.Set	createAssignableDynamicGroups(java.util.Set assignableDynamicGroups) Creates assignable dynamic groups.
AMGroup	createDynamicGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) Creates dynamic group.
java.util.Set	createDynamicGroups(java.util.Map dynamicGroups) Creates dynamic groups and initializes their attributes.
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.lang.String	createOrganization(java.lang.String orgName, java.lang.String domainName, java.util.Map attrMap, java.util.Map serviceNamesAndAttrs) Creates sub-organizations and initializes their attributes.
java.util.Set	createOrganizationalUnits(java.util.Map organizationalUnits) Creates organizational units and initializes their attributes.
java.util.Set	createOrganizationalUnits(java.util.Set organizationalUnits) Creates organizational units.
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.
AMGroup	createStaticGroup(java.lang.String name, java.util.Map attributes, java.util.Map serviceNameAndAttrs) Creates static group.
java.util.Set	createStaticGroups(java.util.Set groups) Creates static groups.
java.util.Set	createSubOrganizations(java.util.Map subOrganizations) Creates sub-organizations and initializes their attributes.
java.util.Set	createSubOrganizations(java.util.Set subOrganizations) Creates sub-organizations.
AMUser	createUser(java.lang.String uid, java.util.Map attrMap, java.util.Map serviceNameAndAttrs) Create user and initializes the attributes.
java.util.Set	createUsers(java.util.Map users) Creates users and initializes their attributes.
java.util.Set	createUsers(java.util.Set users) Creates users in this organization.
boolean	deleteAllNamedPolicyTemplates(java.lang.String policyDN) Deletes all the named policy templates for this Organization 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	deleteFilteredRoles(java.util.Set roles) Deletes filtered roles.
void	deleteGroupContainers(java.util.Set groupContainers) Deletes group containers.
void	deleteOrganizationalUnits(java.util.Set organizationalUnits) Deletes organizational units
void	deletePeopleContainers(java.util.Set peopleContainers) Deletes people containers.
void	deleteRoles(java.util.Set roles) Deletes roles.
void	deleteStaticGroups(java.util.Set groups) Deletes static groups.
void	deleteSubOrganizations(java.util.Set subOrganizations) Deletes sub organizations.
void	deleteUsers(java.util.Set users) Deletes users from this organization.
java.util.Set	getAssignableDynamicGroups(int level) Returns the assignable dynamic groups within the specified level.
java.util.Set	getAssignedPolicyDNs() Gets all the assigned policies for this Organization
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	getNumberOfOrganizationalUnits(int level) Gets number of organizational units 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	getNumberOfSubOrganizations(int level) Gets number of sub organizations within the specified level.
long	getNumberOfUsers(int level) Gets number of users within the specified level.
AMOrganizationalUnit	getOrganizationalUnit(java.lang.String dn) Gets the organizational unit by DN.
java.util.Set	getOrganizationalUnits(int level) Gets the organizational units 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.
AMOrganization	getSubOrganization(java.lang.String dn) Returns the sub-organization by DN
java.util.Set	getSubOrganizations(int level) Gets the sub organizations within the specified level.
AMUser	getUser(java.lang.String uid, java.lang.String userSearchTemplate) Returns AMUser object of user in this organization (or in sub organizations), whose naming attribute exactly matches with uid.
java.util.Set	getUserDNs() Returns the names (DNs) of users in the organization.
boolean	isPolicyAssigned(java.lang.String policyDN, java.lang.String serviceName) Returns true if a policyDN is assigned to an organization or a role.
void	modifyAllPolicyTemplates(java.lang.String serviceName, java.util.Set policyDNs) Modifies all the templates under this organization 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 organization.
AMSearchResults	searchAllRoles(java.lang.String wildcard, AMSearchControl searchControl) Searches for all roles in this organization using wildcards.
java.util.Set	searchAllRoles(java.lang.String wildcard, int level) Searches for all roles in this organization using wildcards.
AMSearchResults	searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for all roles in this organization using wildcards and attribute values.
AMSearchResults	searchAssignableDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl) Searches for assignable dynamic groups in this organization using wildcards.
java.util.Set	searchAssignableDynamicGroups(java.lang.String wildcard, int level) 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) Searches for assignable dynamic groups in this organization using wildcards.
AMSearchResults	searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) 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) Searches for assignable dynamic groups in this organization using wildcards and attribute values.
AMSearchResults	searchDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl) Searches for dynamic groups in this organization using wildcards.
java.util.Set	searchDynamicGroups(java.lang.String wildcard, int level) 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) Searches for dynamic groups in this organization using wildcards.
AMSearchResults	searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) 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) Searches for dynamic groups in this organization 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 organization 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 organization using wildcards and attribute values.
AMSearchResults	searchGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for groups in this organization using wildcards and attribute values.
AMSearchResults	searchOrganizationalUnits(java.lang.String wildcard, AMSearchControl searchControl) Searches for organizational units in this organization using wildcards.
java.util.Set	searchOrganizationalUnits(java.lang.String wildcard, int level) Searches for organizational units in this organization using wildcards.
AMSearchResults	searchOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for organizational units in this organization using wildcards and attribute values.
AMSearchResults	searchPeopleContainers(java.lang.String wildcard, AMSearchControl searchControl) Searches for people containers in this organization using wildcards and attribute values.
java.util.Set	searchPeopleContainers(java.lang.String wildcard, int level) Searches for people containers in this organization using wildcards and attribute values.
AMSearchResults	searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for people containers in this organization using wildcards and attribute values.
AMSearchResults	searchRoles(java.lang.String wildcard, AMSearchControl searchControl) Searches for roles in this organization using wildcards.
java.util.Set	searchRoles(java.lang.String wildcard, int level) Searches for roles in this organization using wildcards.
AMSearchResults	searchRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for roles in this organization using wildcards and attribute values.
AMSearchResults	searchStaticGroups(java.lang.String wildcard, AMSearchControl searchControl) Searches for static groups in this organization using wildcards.
java.util.Set	searchStaticGroups(java.lang.String wildcard, int level) 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) Searches for static groups in this organization using wildcards.
AMSearchResults	searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) 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) Searches for static groups in this organization using wildcards and attribute values.
AMSearchResults	searchSubOrganizations(java.lang.String wildcard, AMSearchControl searchControl) Searches for sub organizations in this organization using wildcards.
java.util.Set	searchSubOrganizations(java.lang.String wildcard, int level) Searches for sub organizations in this organization using wildcards.
AMSearchResults	searchSubOrganizations(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) Searches for sub organizations in this organization using wildcards and attribute values.
AMSearchResults	searchUsers(AMSearchControl searchControl, java.lang.String avfilter) Searches for users in this organization using attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, AMSearchControl searchControl) Searches for users in this organization using wildcards and attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter) Searches for users in this organization using wildcards and attribute values.
java.util.Set	searchUsers(java.lang.String wildcard, int level) 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) Searches for users in this organization using wildcards and attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl) 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) 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) Searches for users in this organization using wildcards and attribute values.
void	unassignAllPolicies(java.lang.String serviceName, java.util.Set policyDNs) Unassigns the given policies from this organization and its roles.
void	unassignServices(java.util.Set serviceNames) Unassigns services from the organization.
void	unregisterService(java.lang.String serviceName) Unregisters a service for this organization.

Methods inherited from interface com.iplanet.am.sdk.AMObject

addEventListener, assignPolicies, assignServices, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAssignedServices, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getAttributesFromDataStore, getAttributesFromDataStore, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getServiceStatus, getStringAttribute, getTemplate, isExists, modifyService, purge, removeAttributes, removeEventListener, search, setAttributeByteArray, setAttributes, setAttributesByteArray, setServiceStatus, setStringAttribute, store, store, unassignPolicies

Method Detail

createSubOrganizations

public java.util.Set createSubOrganizations(java.util.Set subOrganizations)
                                     throws AMException,
                                            SSOException

Creates sub-organizations.

Parameters:

subOrganizations - The set of sub-organizations names to be created.

Returns:

Set set of sub Organization objects created.

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

createSubOrganizations

public java.util.Set createSubOrganizations(java.util.Map subOrganizations)
                                     throws AMException,
                                            SSOException

Creates sub-organizations and initializes their attributes.

Parameters:

subOrganizations - Map where the key is the name of the sub organization, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set set of sub Organization objects created.

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.

createOrganization

public java.lang.String createOrganization(java.lang.String orgName,
                                           java.lang.String domainName,
                                           java.util.Map attrMap,
                                           java.util.Map serviceNamesAndAttrs)
                                    throws AMException,
                                           SSOException

Creates sub-organizations and initializes their attributes. Initializes service objectclasses and attributes as provided in the serviceNameAndAttrs map.

Parameters:

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

Returns:

DN of organization created.

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.

deleteSubOrganizations

public void deleteSubOrganizations(java.util.Set subOrganizations)
                            throws AMException,
                                   SSOException

Deletes sub organizations.

Parameters:

subOrganizations - The set of sub organization DNs to be deleted.

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

getSubOrganization

public AMOrganization getSubOrganization(java.lang.String dn)
                                  throws AMException,
                                         SSOException

Returns the sub-organization by DN

Parameters:

dn - distinguished name.

Returns:

The sub Organization object

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

getSubOrganizations

public java.util.Set getSubOrganizations(int level)
                                  throws AMException,
                                         SSOException

Gets the sub organizations within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Set of sub organizations DNs within the specified level.

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

getNumberOfSubOrganizations

public long getNumberOfSubOrganizations(int level)
                                 throws AMException,
                                        SSOException

Gets number of sub organizations within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of sub organizations within the specified level.

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

searchSubOrganizations

public java.util.Set searchSubOrganizations(java.lang.String wildcard,
                                            int level)
                                     throws AMException,
                                            SSOException

Searches for sub organizations in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of Sub Organizations matching the search

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

searchSubOrganizations

public AMSearchResults searchSubOrganizations(java.lang.String wildcard,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException

Searches for sub organizations in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of sub Organizations matching the search

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.

searchSubOrganizations

public java.util.Set searchSubOrganizations(java.lang.String wildcard,
                                            java.util.Map avPairs,
                                            int level)
                                     throws AMException,
                                            SSOException

Searches for sub organizations in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of sub organizations with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching sub organizations

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

Returns:

Set Set of DNs of sub organizations matching the search

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

searchSubOrganizations

public AMSearchResults searchSubOrganizations(java.lang.String wildcard,
                                              java.util.Map avPairs,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException

Searches for sub organizations in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of sub organizations with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a Set of DNs of sub organizations matching the search.

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.

createOrganizationalUnits

public java.util.Set createOrganizationalUnits(java.util.Set organizationalUnits)
                                        throws AMException,
                                               SSOException

Creates organizational units.

Parameters:

organizationalUnits - The set of organizational units names to be created.

Returns:

set of sub OrganizationalUnit objects created.

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.

createOrganizationalUnits

public java.util.Set createOrganizationalUnits(java.util.Map organizationalUnits)
                                        throws AMException,
                                               SSOException

Creates organizational units and initializes their attributes.

Parameters:

organizationalUnits - Map where the key is the name of the organizational unit, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set set of OrganizationalUnit objects created.

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

deleteOrganizationalUnits

public void deleteOrganizationalUnits(java.util.Set organizationalUnits)
                               throws AMException,
                                      SSOException

Deletes organizational units

Parameters:

organizationalUnits - The set of organizational units DNs to be deleted.

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.

getOrganizationalUnit

public AMOrganizationalUnit getOrganizationalUnit(java.lang.String dn)
                                           throws AMException,
                                                  SSOException

Gets the organizational unit by DN.

Parameters:

dn - distinguished name.

Returns:

The OrganizationalUnit object

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

getOrganizationalUnits

public java.util.Set getOrganizationalUnits(int level)
                                     throws AMException,
                                            SSOException

Gets the organizational units within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

The Set of organizational units DNs within the specified level.

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

getNumberOfOrganizationalUnits

public long getNumberOfOrganizationalUnits(int level)
                                    throws AMException,
                                           SSOException

Gets number of organizational units within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of organizational units within the specified level.

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

searchOrganizationalUnits

public java.util.Set searchOrganizationalUnits(java.lang.String wildcard,
                                               int level)
                                        throws AMException,
                                               SSOException

Searches for organizational units in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of organizational units matching the search

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

searchOrganizationalUnits

public AMSearchResults searchOrganizationalUnits(java.lang.String wildcard,
                                                 AMSearchControl searchControl)
                                          throws AMException,
                                                 SSOException

Searches for organizational units in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a set of DNs of organizational units matching the search.

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

searchOrganizationalUnits

public java.util.Set searchOrganizationalUnits(java.lang.String wildcard,
                                               java.util.Map avPairs,
                                               int level)
                                        throws AMException,
                                               SSOException

Searches for organizational units in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of organizational units with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching organizational units

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

Returns:

Set Set of DNs of organizational units matching the search

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

searchOrganizationalUnits

public AMSearchResults searchOrganizationalUnits(java.lang.String wildcard,
                                                 java.util.Map avPairs,
                                                 AMSearchControl searchControl)
                                          throws AMException,
                                                 SSOException

Searches for organizational units in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of organizational units with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching organizational units

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a Set of DNs of organizational units matching the search.

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

createRoles

public java.util.Set createRoles(java.util.Set roles)
                          throws AMException,
                                 SSOException

Creates roles.

Parameters:

roles - The set of Roles' names to be created.

Returns:

Set set of Role objects created.

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

createRoles

public java.util.Set createRoles(java.util.Map roles)
                          throws AMException,
                                 SSOException

Creates roles.

Parameters:

roles - Map where the key is the name of the role, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set set of Role objects created.

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

deleteRoles

public void deleteRoles(java.util.Set roles)
                 throws AMException,
                        SSOException

Deletes roles.

Parameters:

roles - The set of roles' DNs to be deleted.

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

getRoles

public java.util.Set getRoles(int level)
                       throws AMException,
                              SSOException

Gets the roles within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

The Set of Roles' DNs within the specified level.

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

getNumberOfRoles

public long getNumberOfRoles(int level)
                      throws AMException,
                             SSOException

Gets number of roles within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of roles within the specified level.

Throws:

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 valid

searchRoles

public java.util.Set searchRoles(java.lang.String wildcard,
                                 int level)
                          throws AMException,
                                 SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of roles matching the search

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

searchRoles

public AMSearchResults searchRoles(java.lang.String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search.

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of roles matching the search.

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

searchRoles

public java.util.Set searchRoles(java.lang.String wildcard,
                                 java.util.Map avPairs,
                                 int level)
                          throws AMException,
                                 SSOException

Searches for roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching roles

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

Returns:

Set Set of DNs of roles matching the search

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

searchRoles

public AMSearchResults searchRoles(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching roles

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a set of DNs of roles matching the search.

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

createFilteredRoles

public java.util.Set createFilteredRoles(java.util.Set roles)
                                  throws AMException,
                                         SSOException

Creates filtered roles.

Parameters:

roles - The set of filtered roles' names to be created.

Returns:

Set set of FilteredRole objects created.

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.

createFilteredRoles

public java.util.Set createFilteredRoles(java.util.Map roles)
                                  throws AMException,
                                         SSOException

Creates filtered roles.

Parameters:

roles - Map where the key is the name of the filtered role, and the value is a Map to represent Attribute-Value Pairs

Returns:

set of FilteredRole objects created.

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.

deleteFilteredRoles

public void deleteFilteredRoles(java.util.Set roles)
                         throws AMException,
                                SSOException

Deletes filtered roles.

Parameters:

roles - The set of filtered roles' DNs to be deleted.

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

getFilteredRoles

public java.util.Set getFilteredRoles(int level)
                               throws AMException,
                                      SSOException

Gets the filtered roles within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

The Set of filtered roles' DNs within the specified level.

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

getNumberOfFilteredRoles

public long getNumberOfFilteredRoles(int level)
                              throws AMException,
                                     SSOException

Gets number of filtered roles within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of filtered roles within the specified level.

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

searchFilteredRoles

public java.util.Set searchFilteredRoles(java.lang.String wildcard,
                                         int level)
                                  throws AMException,
                                         SSOException

Searches for filtered roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of filtered roles matching the search

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

searchFilteredRoles

public AMSearchResults searchFilteredRoles(java.lang.String wildcard,
                                           AMSearchControl searchControl)
                                    throws AMException,
                                           SSOException

Searches for filtered roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of filtered roles matching the search.

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.

searchFilteredRoles

public java.util.Set searchFilteredRoles(java.lang.String wildcard,
                                         java.util.Map avPairs,
                                         int level)
                                  throws AMException,
                                         SSOException

Searches for filtered roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of filtered roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching filtered roles

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

Returns:

Set Set of DNs of filtered roles matching the search

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

searchFilteredRoles

public AMSearchResults searchFilteredRoles(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           AMSearchControl searchControl)
                                    throws AMException,
                                           SSOException

Searches for filtered roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of filtered roles with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a set of DNs of filtered roles matching the search.

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.

searchAllRoles

public java.util.Set searchAllRoles(java.lang.String wildcard,
                                    int level)
                             throws AMException,
                                    SSOException

Searches for all roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set of DNs of all roles matching the search

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

searchAllRoles

public AMSearchResults searchAllRoles(java.lang.String wildcard,
                                      AMSearchControl searchControl)
                               throws AMException,
                                      SSOException

Searches for all roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a Set of DNs of all roles matching the search.

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.

searchAllRoles

public java.util.Set searchAllRoles(java.lang.String wildcard,
                                    java.util.Map avPairs,
                                    int level)
                             throws AMException,
                                    SSOException

Searches for all roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of all roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching all roles

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

Returns:

Set of DNs of all roles matching the search

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

searchAllRoles

public AMSearchResults searchAllRoles(java.lang.String wildcard,
                                      java.util.Map avPairs,
                                      AMSearchControl searchControl)
                               throws AMException,
                                      SSOException

Searches for all roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of all roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching all roles

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of all roles matching the search.

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.

createAssignableDynamicGroups

public java.util.Set createAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
                                            throws AMException,
                                                   SSOException

Creates assignable dynamic groups.

Parameters:

assignableDynamicGroups - The set of assignable dynamic groups's names to be created.

Returns:

set of AssignableDynamicGroup objects created.

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.

createAssignableDynamicGroup

public AMGroup createAssignableDynamicGroup(java.lang.String name,
                                            java.util.Map attributes,
                                            java.util.Map serviceNameAndAttrs)
                                     throws AMException,
                                            SSOException

Creates assignable dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

name - of group to be created

attributes - attribute-value pairs to be set

serviceNameAndAttrs - 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

deleteAssignableDynamicGroups

public void deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
                                   throws AMException,
                                          SSOException

Deletes assignable dynamic groups.

Parameters:

assignableDynamicGroups - The set of assignable dynamic groups's DNs to be deleted.

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

getAssignableDynamicGroups

public java.util.Set getAssignableDynamicGroups(int level)
                                         throws AMException,
                                                SSOException

Returns the assignable dynamic groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Set of DNs of AssignableDynamicGroups within the specified level.

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

getNumberOfAssignableDynamicGroups

public long getNumberOfAssignableDynamicGroups(int level)
                                        throws AMException,
                                               SSOException

Gets number of assignable dynamic groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of assignable dynamic groups within the specified level.

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

searchAssignableDynamicGroups

public java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard,
                                                   int level)
                                            throws AMException,
                                                   SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of assignable dynamic groups matching the search

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

searchAssignableDynamicGroups

public java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard,
                                                   int level,
                                                   java.lang.String groupSearchTemplate,
                                                   java.util.Map avPairs)
                                            throws AMException,
                                                   SSOException

Searches for assignable dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. Otherwise the default search template is used.

Parameters:

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.

Returns:

Set of DNs of assignable dynamic groups matching the search.

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.

searchAssignableDynamicGroups

public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     AMSearchControl searchControl)
                                              throws AMException,
                                                     SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of assignable dynamic groups matching the search.

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.

searchAssignableDynamicGroups

public java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard,
                                                   java.util.Map avPairs,
                                                   int level)
                                            throws AMException,
                                                   SSOException

Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching assignable dynamic groups

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

Returns:

Set Set of DNs of assignable dynamic groups matching the search

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

searchAssignableDynamicGroups

public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     java.util.Map avPairs,
                                                     AMSearchControl searchControl)
                                              throws AMException,
                                                     SSOException

Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching assignable dynamic groups.

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of assignable dynamic groups matching the search.

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.

searchAssignableDynamicGroups

public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     java.util.Map avPairs,
                                                     java.lang.String groupSearchTemplate,
                                                     AMSearchControl searchControl)
                                              throws AMException,
                                                     SSOException

Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching assignable dynamic groups

groupSearchTemplate - Name of search template to be used to perform

searchControl - specifies the search scope to be used, VLV ranges etc., the search.

Returns:

AMSearchResults which contains a set of DNs of assignable dynamic groups matching the search.

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.

createDynamicGroups

public java.util.Set createDynamicGroups(java.util.Map dynamicGroups)
                                  throws AMException,
                                         SSOException

Creates dynamic groups and initializes their attributes.

Parameters:

dynamicGroups - Map where the key is the name of the dynamic group, and the value is a Map to represent Attribute-Value Pairs.

Returns:

Set of AMDynamicGroup objects created

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.

createDynamicGroup

public AMGroup createDynamicGroup(java.lang.String name,
                                  java.util.Map attributes,
                                  java.util.Map serviceNameAndAttrs)
                           throws AMException,
                                  SSOException

Creates dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

name - of group to be created

attributes - to be set in group

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

deleteDynamicGroups

public void deleteDynamicGroups(java.util.Set dynamicGroups)
                         throws AMException,
                                SSOException

Deletes dynamic groups.

Parameters:

dynamicGroups - The set of dynamic groups's DNs to be deleted.

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

getDynamicGroups

public java.util.Set getDynamicGroups(int level)
                               throws AMException,
                                      SSOException

Gets the dynamic groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

The Set of DNs of DynamicGroups within the specified level.

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

getNumberOfDynamicGroups

public long getNumberOfDynamicGroups(int level)
                              throws AMException,
                                     SSOException

Gets number of dynamic groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of dynamic groups within the specified level.

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

searchDynamicGroups

public java.util.Set searchDynamicGroups(java.lang.String wildcard,
                                         int level)
                                  throws AMException,
                                         SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of dynamic groups matching the search

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

searchDynamicGroups

public java.util.Set searchDynamicGroups(java.lang.String wildcard,
                                         int level,
                                         java.lang.String groupSearchTemplate,
                                         java.util.Map avPairs)
                                  throws AMException,
                                         SSOException

Searches for dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. Otherwise uses the the default GroupSearch template.

Parameters:

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)

Returns:

set of DNs of dynamic groups matching the search.

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.

searchDynamicGroups

public AMSearchResults searchDynamicGroups(java.lang.String wildcard,
                                           AMSearchControl searchControl)
                                    throws AMException,
                                           SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains a set of DNs of dynamic groups matching the search.

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.

searchDynamicGroups

public java.util.Set searchDynamicGroups(java.lang.String wildcard,
                                         java.util.Map avPairs,
                                         int level)
                                  throws AMException,
                                         SSOException

Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of dynamic groups matching the search

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

searchDynamicGroups

public AMSearchResults searchDynamicGroups(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           AMSearchControl searchControl)
                                    throws AMException,
                                           SSOException

Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching dynamic groups

searchControl - specifies the search scope to be used, VLV ranges etc.,

Returns:

AMSearchResults which contains set a of DNs of dynamic groups matching the search.

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.

searchDynamicGroups

public AMSearchResults searchDynamicGroups(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           java.lang.String groupSearchTemplate,
                                           AMSearchControl searchControl)
                                    throws AMException,
                                           SSOException

Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching dynamic groups

groupSearchTemplate - Name of search template to be used to perform the search.

searchControl - specifies the search scope to be used

Returns:

AMSearchResults which contains a Set of DNs of dynamic groups matching the search

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.

createStaticGroups

public java.util.Set createStaticGroups(java.util.Set groups)
                                 throws AMException,
                                        SSOException

Creates static groups.

Parameters:

groups - The set of static groups's names to be created.

Returns:

set of AMStaticGroup objects created.

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.

createStaticGroup

public AMGroup createStaticGroup(java.lang.String name,
                                 java.util.Map attributes,
                                 java.util.Map serviceNameAndAttrs)
                          throws AMException,
                                 SSOException

Creates static group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.

Parameters:

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

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.

deleteStaticGroups

public void deleteStaticGroups(java.util.Set groups)
                        throws AMException,
                               SSOException

Deletes static groups.

Parameters:

groups - The set of static groups's DNs to be deleted.

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

AMException - if an error is encountered when trying to access/retrieve data from the data store.

getStaticGroups

public java.util.Set getStaticGroups(int level)
                              throws AMException,
                                     SSOException

Gets the static groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

The Set of DNs of Groups within the specified level.

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

AMException - if an error is encountered when trying to access/retrieve data from the data store.

getNumberOfStaticGroups

public long getNumberOfStaticGroups(int level)
                             throws AMException,
                                    SSOException

Gets number of static groups within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of static groups within the specified level.

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.

AMException - if an error is encountered when trying to access/retrieve data from the data store.

searchStaticGroups

public java.util.Set searchStaticGroups(java.lang.String wildcard,
                                        int level)
                                 throws AMException,
                                        SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set Set of DNs of static groups matching the search

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

searchStaticGroups

public java.util.Set searchStaticGroups(java.lang.String wildcard,
                                        int level,
                                        java.lang.String groupSearchTemplate,
                                        java.util.Map avPairs)
                                 throws AMException,
                                        SSOException

Searches for static groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. If it is null, default search templates are used.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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.

Returns:

Set Set of DNs of static groups matching the search

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

searchStaticGroups

public AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of static groups matching the search.

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.

searchStaticGroups

public java.util.Set searchStaticGroups(java.lang.String wildcard,
                                        java.util.Map avPairs,
                                        int level)
                                 throws AMException,
                                        SSOException

Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching groups

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

Returns:

Set Set of DNs of static groups matching the search

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

searchStaticGroups

public AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          java.util.Map avPairs,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException

Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.

Parameters:

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, VLV ranges etc.

Returns:

AMSearchResults which contains a set of DNs of static groups matching the search.

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.

searchStaticGroups

public AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          java.util.Map avPairs,
                                          java.lang.String groupSearchTemplate,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException

Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a Set of DNs of static groups matching the search.

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.

searchGroups

public java.util.Set searchGroups(java.lang.String wildcard,
                                  java.util.Map avPairs,
                                  int level)
                           throws AMException,
                                  SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching groups

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

Returns:

Set DNs of groups matching the search

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

searchGroups

public AMSearchResults searchGroups(java.lang.String wildcard,
                                    java.util.Map avPairs,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException

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

Parameters:

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.

Returns:

AMSearchResults which contains set a of DNs of groups matching the search.

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.

createPeopleContainers

public java.util.Set createPeopleContainers(java.util.Set peopleContainers)
                                     throws AMException,
                                            SSOException

Creates people containers.

Parameters:

peopleContainers - The set of people containers' names to be created

Returns:

set of PeopleContainer objects created.

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.

createPeopleContainers

public java.util.Set createPeopleContainers(java.util.Map peopleContainers)
                                     throws AMException,
                                            SSOException

Creates people containers and initializes their attributes.

Parameters:

peopleContainers - Map where the key is the name of the people container, and the value is a Map to represent attribute-value pairs.

Returns:

set of PeopleContainer objects created.

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.

deletePeopleContainers

public void deletePeopleContainers(java.util.Set peopleContainers)
                            throws AMException,
                                   SSOException

Deletes people containers.

Parameters:

peopleContainers - The set of people containers' DN to be deleted.

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

getPeopleContainers

public java.util.Set getPeopleContainers(int level)
                                  throws AMException,
                                         SSOException

Gets the people containers within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Set of people containers within the specified level.

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

getNumberOfPeopleContainers

public long getNumberOfPeopleContainers(int level)
                                 throws AMException,
                                        SSOException

Gets number of people containers within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

long Number of people containers within the specified level.

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

searchPeopleContainers

public java.util.Set searchPeopleContainers(java.lang.String wildcard,
                                            int level)
                                     throws AMException,
                                            SSOException

Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set DNs of people containers matching the search

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

searchPeopleContainers

public AMSearchResults searchPeopleContainers(java.lang.String wildcard,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException

Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.

Parameters:

wildcard - wildcard pattern to be used in the search.

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set DNs of people containers matching the search.

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.

searchPeopleContainers

public java.util.Set searchPeopleContainers(java.lang.String wildcard,
                                            java.util.Map avPairs,
                                            int level)
                                     throws AMException,
                                            SSOException

Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of people containers with matching attribute-value pairs will be returned.

Parameters:

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

Returns:

Set DNs of people containers matching the search

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

searchPeopleContainers

public AMSearchResults searchPeopleContainers(java.lang.String wildcard,
                                              java.util.Map avPairs,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException

Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of people containers with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a set DNs of people containers matching the search.

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.

createGroupContainers

public java.util.Set createGroupContainers(java.util.Set groupContainers)
                                    throws AMException,
                                           SSOException

Creates group containers.

Parameters:

groupContainers - The set of group containers' names to be created.

Returns:

set of group container objects created.

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.

createGroupContainers

public java.util.Set createGroupContainers(java.util.Map groupContainers)
                                    throws AMException,
                                           SSOException

Creates group containers and initializes their attributes.

Parameters:

groupContainers - Map where the key is the name of the group container, and the value is a Map to represent attribute-value pairs.

Returns:

set of group container objects created.

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.

deleteGroupContainers

public void deleteGroupContainers(java.util.Set groupContainers)
                           throws AMException,
                                  SSOException

Deletes group containers.

Parameters:

groupContainers - The set of group containers' DN to be deleted.

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

getGroupContainers

public java.util.Set getGroupContainers(int level)
                                 throws AMException,
                                        SSOException

Gets the group containers within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

set of group containers within the specified level.

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

getNumberOfGroupContainers

public long getNumberOfGroupContainers(int level)
                                throws AMException,
                                       SSOException

Gets number of group containers within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

long Number of group containers within the specified level.

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

searchGroupContainers

public java.util.Set searchGroupContainers(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           int level)
                                    throws AMException,
                                           SSOException

Searches for group containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of group containers with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching group containers

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

Returns:

Set DNs of group containers matching the search

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

searchGroupContainers

public AMSearchResults searchGroupContainers(java.lang.String wildcard,
                                             java.util.Map avPairs,
                                             AMSearchControl searchControl)
                                      throws AMException,
                                             SSOException

Searches for group containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of group containers with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a set DNs of group containers matching the search.

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.

createUsers

public java.util.Set createUsers(java.util.Set users)
                          throws AMException,
                                 SSOException

Creates users in this organization. For each user the, object classes specified by organization type attribute 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.

Parameters:

users - The set of user names to be created in this organization.

Returns:

Set Set of User objects created

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

createUsers

public java.util.Set createUsers(java.util.Map users)
                          throws AMException,
                                 SSOException

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. If a corresponding template does not exist, the default values are picked up from schema.

Parameters:

users - Map where the key is the name of the user, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set Set of User objects created

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

createUser

public AMUser createUser(java.lang.String uid,
                         java.util.Map attrMap,
                         java.util.Map serviceNameAndAttrs)
                  throws AMException,
                         SSOException

Create user and initializes the attributes. For each user the, object classes specified by organization type attribute 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.

Parameters:

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.

Returns:

AMUser object of newly created user.

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

deleteUsers

public void deleteUsers(java.util.Set users)
                 throws AMException,
                        SSOException

Deletes users from this organization.

Parameters:

users - The set of user DN's to be deleted from the organization.

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.

getUserDNs

public java.util.Set getUserDNs()
                         throws AMException,
                                SSOException

Returns the names (DNs) of users in the organization.

Returns:

Set The names(DNs) of users in the organization.

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

getUser

public AMUser getUser(java.lang.String uid,
                      java.lang.String userSearchTemplate)
               throws AMException,
                      SSOException

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

Parameters:

uid - naming attribute value for user.

userSearchTemplate - search template.

Returns:

AMUser object of user found.

Throws:

AMException -

SSOException -

getNumberOfUsers

public long getNumberOfUsers(int level)
                      throws AMException,
                             SSOException

Gets number of users within the specified level.

Parameters:

level - The search level starting from the organization.

Returns:

Number of users within the specified level.

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

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard,
                                 int level)
                          throws AMException,
                                 SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search

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

Returns:

Set DNs of Users matching the search

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

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard,
                                 int level,
                                 java.lang.String userSearchTemplate,
                                 java.util.Map avPairs)
                          throws AMException,
                                 SSOException

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK users the userSearchTemplate, if provided. Otherwise, it uses the BasicUserSearchTemplate. Any %U in the search template are replaced with the wildcard.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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.

Returns:

Set DNs of Users matching the search

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.

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

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

Parameters:

wildcard - wildcard pattern to be used in the search.

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set DNs of users matching the search.

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.

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard,
                                 java.util.Map avPairs,
                                 int level)
                          throws AMException,
                                 SSOException

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

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

Returns:

Set DNs of Users matching the search

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

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

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

Returns:

AMSearchResults which contains a set DNs of users matching the search.

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.

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   java.lang.String userSearchTemplate,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

userSearchTemplate - Name of user search template to be used.

searchControl - specifies the search scope to be used, VLV ranges etc.

Returns:

AMSearchResults which contains a set DNs of users matching the search.

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.

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException

Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a Set DNs of users matching the search.

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.

searchUsers

public AMSearchResults searchUsers(AMSearchControl searchControl,
                                   java.lang.String avfilter)
                            throws AMException,
                                   SSOException

Searches for users in this organization using attribute values. Wildcards such as can be specified for the attribute values. The DNs of users with matching attribute-value pairs will be returned.

Parameters:

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.

Returns:

AMSearchResults which contains a set of DNs of users matching the search.

Throws:

AMException - if there is an internal error in the access management data store

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

getNumberOfServices

public long getNumberOfServices()
                         throws AMException,
                                SSOException

Returns the number of services.

Returns:

number of services.

Throws:

AMException - if there is an internal error in the access management data store

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

getRegisteredServiceNames

public java.util.Set getRegisteredServiceNames()
                                        throws AMException,
                                               SSOException

Gets the names of registered services.

Returns:

The Set of the names of registered services.

Throws:

AMException - if there is an internal error in the access management data store

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

registerService

public void registerService(java.lang.String serviceName,
                            boolean createTemplate,
                            boolean activate)
                     throws AMException,
                            SSOException

Register a service for this organization.

Parameters:

serviceName - The name of service to be registered

createTemplate - true if to create default template

activate - true if to activate the service

Throws:

AMException - if the service does not exist or could not be registered.

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

unregisterService

public void unregisterService(java.lang.String serviceName)
                       throws AMException,
                              SSOException

Unregisters a service for this organization.

Parameters:

serviceName - service name to be unregistered.

Throws:

AMException - if the service does not exist or could not be unregistered.

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

unassignAllPolicies

public void unassignAllPolicies(java.lang.String serviceName,
                                java.util.Set policyDNs)
                         throws AMException,
                                SSOException

Unassigns the given policies from this organization and its roles.

Parameters:

serviceName - service name.

policyDNs - Set of policy DN string.

Throws:

AMException - if there is an internal problem with access management data store.

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

modifyAllPolicyTemplates

public void modifyAllPolicyTemplates(java.lang.String serviceName,
                                     java.util.Set policyDNs)
                              throws AMException,
                                     SSOException

Modifies all the templates under this organization that contain any policyDN in given policyDNs.

Parameters:

serviceName - service name.

policyDNs - Set of policy DN string

Throws:

AMException - if there is an internal problem with access management data store.

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

deleteAllNamedPolicyTemplates

public boolean deleteAllNamedPolicyTemplates(java.lang.String policyDN)
                                      throws AMException,
                                             SSOException

Deletes all the named policy templates for this Organization corresponding to the given policy. This includes organizational based and role based policy templates. This is a convenience method.

Parameters:

policyDN - a policy DN string

Returns:

true if policy templates were found and deleted.

Throws:

AMException - if there is an internal problem with access management data store.

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

getAssignedPolicyDNs

public java.util.Set getAssignedPolicyDNs()
                                   throws AMException,
                                          SSOException

Gets all the assigned policies for this Organization

Returns:

Set a set of assigned policy DNs

Throws:

AMException - if there is an internal problem with access management data store.

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

isPolicyAssigned

public boolean isPolicyAssigned(java.lang.String policyDN,
                                java.lang.String serviceName)
                         throws AMException,
                                SSOException

Returns true if a policyDN is assigned to an organization or a role.

Parameters:

policyDN - a policy DN string

serviceName - service name

Returns:

true if policy is assigned to an organization or role.

Throws:

AMException - if there is an internal error in the access management data store

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

orgTemplateExists

public boolean orgTemplateExists(java.lang.String serviceName)
                          throws AMException,
                                 SSOException

Returns true if an organizational template exists for the service.

Parameters:

serviceName - service name

Returns:

true if the organizational template exists.

Throws:

AMException - if there is an internal error in the access management data store

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

unassignServices

public void unassignServices(java.util.Set serviceNames)
                      throws AMException,
                             SSOException

Unassigns services from the organization. Also removes service specific attributes, if defined in the user entry.

Specified by:

unassignServices in interface AMObject

Parameters:

serviceNames - Set of service names

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