Sun Java System Access Manager 2005Q4 API: Interface AMOrganizationalUnit

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.iplanet.am.sdk
Interface AMOrganizationalUnit

All Superinterfaces:: AMConstants, AMObject

public interface AMOrganizationalUnit
extends AMObject

The AMOrganizationalUnit interface provides methods to manage organizational unit AMOrganizationalUnit objects can be obtained by using AMStoreConnection. A handle to this object can be obtained by using the DN of the object.

          AMStoreConnection amsc = new AMStoreConnection(ssotoken);
          if (amsc.doesEntryExist(oDN)) {
              AMOrganizationalUnit org = amsc.getOrganizationalUnit(oDN);
          }

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

ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER

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, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Method Summary

void assignService(java.lang.String serviceName, java.util.Map attrMap)
          Assign service to the organizational unit.

java.util.Set createAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
          Creates assignable dynamic groups.

java.util.Set createDynamicGroups(java.util.Map dynamicGroups)
          Creates dynamic groups and initializes their attributes.

java.util.Set createEntities(java.lang.String stype, java.util.Map entities)
          Creates entities and initializes their attributes.

java.util.Set createEntities(java.lang.String type, java.util.Set entities)
          Create managed entities in this container.

java.util.Set createFilteredRoles(java.util.Map roles)
          Creates filtered roles.

java.util.Set createFilteredRoles(java.util.Set roles)
          Creates filtered roles.

java.util.Set createGroupContainers(java.util.Map groupContainers)
          Creates group containers and initializes their attributes.

java.util.Set createGroupContainers(java.util.Set groupContainers)
          Creates group containers.

java.util.Set createOrganizations(java.util.Map organizations)
          Creates organizations and initializes their attributes.

java.util.Set createOrganizations(java.util.Set organizations)
          Creates organizations.

java.util.Set createPeopleContainers(java.util.Map peopleContainers)
          Creates people containers and initializes their attributes.

java.util.Set createPeopleContainers(java.util.Set peopleContainers)
          Creates people containers.

java.util.Set createRoles(java.util.Map roles)
          Creates roles.

java.util.Set createRoles(java.util.Set roles)
          Creates roles.

java.util.Set createStaticGroups(java.util.Set groups)
          Creates static groups.

java.util.Set createSubOrganizationalUnits(java.util.Map subOrganizationalUnits)
          Creates sub-organizational units and initializes their attributes.

java.util.Set createSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
          Creates sub-organizational units.

java.util.Set createUsers(java.util.Map users)
          Creates users and initializes their attributes.For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added.

java.util.Set createUsers(java.util.Set users)
          Creates users and initializes their attributes.

boolean deleteAllNamedPolicyTemplates(java.lang.String policyDN)
          Deletes all the named policy templates for this Organizational Unit corresponding to the given policy.

void deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroups)
          Deletes assignable dynamic groups.

void deleteDynamicGroups(java.util.Set dynamicGroups)
          Deletes dynamic groups.

void deleteEntities(java.util.Set resources)
          Deletes a set of resources in this people container.

void deleteFilteredRoles(java.util.Set roles)
          Deletes filtered roles.

void deleteGroupContainers(java.util.Set groupContainers)
          Deletes group containers.

void deleteOrganizations(java.util.Set organizations)
          Deletes organizations

void deletePeopleContainers(java.util.Set peopleContainers)
          Creates people containers and initializes their attributes.

void deleteRoles(java.util.Set roles)
          Deletes roles.

void deleteStaticGroups(java.util.Set groups)
          Deletes static groups.

void deleteSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
          Deletes sub organizational units

void deleteUsers(java.util.Set users)
          Deletes users from this organizational unit.

java.util.Set getAssignableDynamicGroups(int level)
          Returns the assignable dynamic groups within the specified level.

java.util.Set getAssignedPolicyDNs()
          Returns all the assigned policies for this organizational unit.

java.util.Set getDynamicGroups(int level)
          Gets the dynamic groups within the specified level.

java.util.Set getFilteredRoles(int level)
          Gets the filtered roles within the specified level.

java.util.Set getGroupContainers(int level)
          Gets the group containers within the specified level.

long getNumberOfAssignableDynamicGroups(int level)
          Gets number of assignable dynamic groups within the specified level.

long getNumberOfDynamicGroups(int level)
          Gets number of dynamic groups within the specified level.

long getNumberOfFilteredRoles(int level)
          Gets number of filtered roles within the specified level.

long getNumberOfGroupContainers(int level)
          Gets number of group containers within the specified level.

long getNumberOfOrganizations(int level)
          Gets number of organizations within the specified level.

long getNumberOfPeopleContainers(int level)
          Gets number of people containers within the specified level.

long getNumberOfRoles(int level)
          Gets number of roles within the specified level.

long getNumberOfServices()
          Returns the number of services.

long getNumberOfStaticGroups(int level)
          Gets number of static groups within the specified level.

long getNumberOfSubOrganizationalUnits(int level)
          Gets number of sub organizational units within the specified level.

long getNumberOfUsers(int level)
          Gets number of users within the specified level.

AMOrganization getOrganization(java.lang.String dn)
          Gets the organization by DN

java.util.Set getOrganizations(int level)
          Gets the organizations within the specified level.

java.util.Set getPeopleContainers(int level)
          Gets the people containers within the specified level.

java.util.Set getRegisteredServiceNames()
          Gets the names of registered services.

java.util.Set getRoles(int level)
          Gets the roles within the specified level.

java.util.Set getStaticGroups(int level)
          Gets the static groups within the specified level.

AMOrganizationalUnit getSubOrganizationalUnit(java.lang.String dn)
          Gets the sub-organizational unit by DN

java.util.Set getSubOrganizationalUnits(int level)
          Gets the sub organizational units within the specified level.

java.util.Set getSupportedTypes()
          Returns a set of the supported entity names in this container.

java.util.Set getUserDNs()
          Gets the names (DNs) of users in the organizational unit.

boolean isPolicyAssigned(java.lang.String policyDN, java.lang.String serviceName)
          Returns true if a policyDN is assigned to this organizational unit or a role.

void modifyAllPolicyTemplates(java.lang.String serviceName, java.util.Set policyDNs)
          Modifies all the templates under this organizational unit that contain any policyDN in given policyDNs.

boolean orgTemplateExists(java.lang.String serviceName)
          Returns true if an organizational template exists for the service.

void registerService(java.lang.String serviceName, boolean createTemplate, boolean activate)
          Register a service for this organizational unit.

AMSearchResults searchAllRoles(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for all roles in this organizational unit using wildcards.

java.util.Set searchAllRoles(java.lang.String wildcard, int level)
          Searches for all roles in this organizational unit using wildcards.

AMSearchResults searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for all roles in this organizational unit using wildcards and attribute values.

java.util.Set searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for all roles in this organizational unit using wildcards and attribute values.

AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for assignable dynamic groups in this organizational unit using wildcards.

java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard, int level)
          Searches for assignable dynamic groups in this organizational unit using wildcards.

AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values.

java.util.Set searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values.

AMSearchResults searchDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for dynamic groups in this organization unit using wildcards.

java.util.Set searchDynamicGroups(java.lang.String wildcard, int level)
          Searches for dynamic groups in this organization unit using wildcards.

AMSearchResults searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for dynamic groups in this organization unit using wildcards and attribute values.

java.util.Set searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for dynamic groups in this organization unit using wildcards and attribute values.

AMSearchResults searchEntities(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter, java.lang.String eSearchTemplate)
          Searches for entities in this container using wildcards and a filter.

java.util.Set searchEntities(java.lang.String wildcard, int level, java.lang.String eSearchTemplate, java.util.Map avPairs)
          Searches for resources in this organization using wildcards and attribute values.

AMSearchResults searchEntities(java.lang.String wildcard, java.util.Map avPairs, java.lang.String eSearchTemplate, AMSearchControl searchControl)
          Searches for resources in this people container using wildcards and attribute values.

AMSearchResults searchFilteredRoles(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for filtered roles in this organization using wildcards.

java.util.Set searchFilteredRoles(java.lang.String wildcard, int level)
          Searches for filtered roles in this organization using wildcards.

AMSearchResults searchFilteredRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for filtered roles in this organization using wildcards and attribute values.

java.util.Set searchFilteredRoles(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for filtered roles in this organization using wildcards and attribute values.

AMSearchResults searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for group containers in this organizational unit using wildcards and attribute values.

java.util.Set searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for group containers in this organizational unit using wildcards and attribute values.

AMSearchResults searchGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for groups in this organizational unit using wildcards and attribute values.

java.util.Set searchGroups(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for groups in this organizational unit using wildcards and attribute values.

AMSearchResults searchOrganizations(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for organizations in this organizational unit using wildcards.

java.util.Set searchOrganizations(java.lang.String wildcard, int level)
          Searches for organizations in this organizational unit using wildcards.

AMSearchResults searchOrganizations(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for organizations in this organizational unit using wildcards and attribute values.

java.util.Set searchOrganizations(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for organizations in this organizational unit using wildcards and attribute values.

AMSearchResults searchPeopleContainers(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for people containers in this organizational unit using wildcards and attribute values.

java.util.Set searchPeopleContainers(java.lang.String wildcard, int level)
          Searches for people containers in this organizational unit using wildcards and attribute values.

AMSearchResults searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for people containers in this organizational unit using wildcards * and * attribute values.

java.util.Set searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for people containers in this organizational unit using wildcards * and * attribute values.

AMSearchResults searchRoles(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for roles in this organizational unit using wildcards.

java.util.Set searchRoles(java.lang.String wildcard, int level)
          Searches for roles in this organizational unit using wildcards.

AMSearchResults searchRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for roles in this organizational unit using wildcards and attribute values.

java.util.Set searchRoles(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for roles in this organizational unit using wildcards and attribute values.

AMSearchResults searchStaticGroups(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for static groups in this organizational unit using wildcards.

java.util.Set searchStaticGroups(java.lang.String wildcard, int level)
          Searches for static groups in this organizational unit using wildcards.

AMSearchResults searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for static groups in this organizational unit using wildcards and attribute values.

java.util.Set searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for static groups in this organizational unit using wildcards and attribute values.

AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for sub organizational units in this organizational unit using wildcards.

java.util.Set searchSubOrganizationalUnits(java.lang.String wildcard, int level)
          Searches for sub organizational units in this organizational unit using wildcards.

AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for sub organizational units in this organizational unit using wildcards and attribute values.

java.util.Set searchSubOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for sub organizational units in this organizational unit using wildcards and attribute values.

AMSearchResults searchUsers(AMSearchControl searchControl, java.lang.String avfilter)
          Searches for users in this organization attribute values.

AMSearchResults searchUsers(java.lang.String wildcard, AMSearchControl searchControl)
          Searches for users in this organizational unit using wildcards and attribute values.

AMSearchResults searchUsers(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter)
          Searches for users in this organizational unit using wildcards and filter.

java.util.Set searchUsers(java.lang.String wildcard, int level)
          Searches for users in this organizational unit using wildcards and attribute values.

AMSearchResults searchUsers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)
          Searches for users in this organizational unit using wildcards and attribute values.

java.util.Set searchUsers(java.lang.String wildcard, java.util.Map avPairs, int level)
          Searches for users in this organizational unit using wildcards and attribute values.

void setSupportedTypes(java.util.Set sTypes)
          Sets the list of supported types for this container.

void unassignAllPolicies(java.lang.String serviceName, java.util.Set policyDNs)
          Unassigns the given policies from this organizational unit and its roles.

void unassignServices(java.util.Set serviceNames)
          Unassigns services from the organizational unit.

void unregisterService(java.lang.String serviceName)
          Unregister a service for this organizational unit.

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

createOrganizations

public java.util.Set createOrganizations(java.util.Set organizations)
                                  throws AMException,
                                         SSOException

Creates organizations.

Parameters:: organizations - The set of organizations names to be created.
Returns:: Set set of 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

createOrganizations

public java.util.Set createOrganizations(java.util.Map organizations)
                                  throws AMException,
                                         SSOException

Creates organizations and initializes their attributes.

Parameters:: organizations - Map where the key is the name of the organization, and the value is a Map to represent Attribute-Value Pairs
Returns:: Set set of 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

deleteOrganizations

public void deleteOrganizations(java.util.Set organizations)
                         throws AMException,
                                SSOException

Deletes organizations

Parameters:: organizations - The set of organizations 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.

getOrganization

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

Gets the organization by DN

Parameters:: dn - DN
Returns:: The 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.

getOrganizations

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

Gets the organizations within the specified level.

Parameters:: level - The search level starting from the organizational unit.
Returns:: The Set of 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.

getNumberOfOrganizations

public long getNumberOfOrganizations(int level)
                              throws AMException,
                                     SSOException

Gets number of organizations within the specified level.

Parameters:: level - The search level starting from the organizational unit.
Returns:: Number of 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.

searchOrganizations

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

Searches for organizations in this organizational unit 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 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

searchOrganizations

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

Searches for organizations in this organizational unit 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 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

searchOrganizations

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

Searches for organizations in this organizational unit 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 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 organizations; level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
Returns:: Set Set of DNs of 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

searchOrganizations

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

Parameters:: wildcard - wildcard pattern to be used in the search.; avPairs - attribute-value pairs to match when searching organizations.; searchControl - specifies the search scope to be used, VLV ranges etc.
Returns:: AMSearchResults which contains a Set of DNs of 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.

createSubOrganizationalUnits

public java.util.Set createSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
                                           throws AMException,
                                                  SSOException

Creates sub-organizational units.

Parameters:: subOrganizationalUnits - The set of sub-organizational units names to be created.
Returns:: Set set of sub organizational unit 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

createSubOrganizationalUnits

public java.util.Set createSubOrganizationalUnits(java.util.Map subOrganizationalUnits)
                                           throws AMException,
                                                  SSOException

Creates sub-organizational units and initializes their attributes.

Parameters:: subOrganizationalUnits - Map where the key is the name of the sub organizational unit, and the value is a Map to represent Attribute-Value Pairs.
Returns:: Set set of sub organizational unit 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

deleteSubOrganizationalUnits

public void deleteSubOrganizationalUnits(java.util.Set subOrganizationalUnits)
                                  throws AMException,
                                         SSOException

Deletes sub organizational units

Parameters:: subOrganizationalUnits - The set of sub 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

getSubOrganizationalUnit

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

Gets the sub-organizational unit by DN

Parameters:: dn - distinguished name.
Returns:: The sub 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

getSubOrganizationalUnits

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

Gets the sub organizational units within the specified level.

Parameters:: level - The search level starting from the organizational unit.
Returns:: Set of sub 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

getNumberOfSubOrganizationalUnits

public long getNumberOfSubOrganizationalUnits(int level)
                                       throws AMException,
                                              SSOException

Gets number of sub organizational units within the specified level.

Parameters:: level - The search level starting from the organizational unit.
Returns:: Number of sub 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

searchSubOrganizationalUnits

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

Searches for sub organizational units in this organizational unit 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 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

searchSubOrganizationalUnits

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

Searches for sub organizational units in this organizational unit 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 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.

searchSubOrganizationalUnits

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

Searches for sub organizational units in this organizational unit 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 organizational units; level - the search level that needs to be used (AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
Returns:: Set Set of DNs of sub 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

searchSubOrganizationalUnits

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

Parameters:: wildcard - wildcard pattern to be used in the search.; avPairs - attribute-value pairs to match when searching sub organizational units.; searchControl - specifies the search scope to be used, VLV ranges etc.
Returns:: AMSearchResults which contains a Set of DNs of sub 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 organizational unit.
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 organizational unit.
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; 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 organizational unit 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 organizational unit 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 organizational unit 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

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

Parameters:: wildcard - wildcard pattern to be used in the search.; avPairs - attribute-value pairs to match when searching filtered roles.; searchControl - specifies the search scope to be used, VLV ranges etc.
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 organizational unit 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 organizational unit 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 organizational unit 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

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

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 organizational unit.
Returns:: The 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 organizational unit.
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 organizational unit 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 AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     AMSearchControl searchControl)
                                              throws AMException,
                                                     SSOException

Searches for assignable dynamic groups in this organizational unit 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 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 organizational unit 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

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

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.

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 there is an internal error in the access management 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 unit.
Returns:: The Set of DNs 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

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 unit.
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 unit 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 there is an internal error in the access management 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 unit 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 unit 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 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

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

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

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 organizational unit.
Returns:: The Set of DNs 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

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 organizational unit.
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

searchStaticGroups

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

Searches for static groups in this organizational unit 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 AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException

Searches for static groups in this organizational unit 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 organizational unit 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; 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

Parameters:: wildcard - wildcard pattern to be used in the search.; avPairs - attribute-value pairs to match when searching static groups.; searchControl - specifies the search scope to be used, VLV ranges etc.
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 organizational unit 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 organizational unit 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 - 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 people container objects created.
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

deletePeopleContainers

public void deletePeopleContainers(java.util.Set 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.

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 organizational unit.
Returns:: The 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 organizational unit.
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 organizational unit 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 organizational unit 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 organizational unit 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 - 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

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 GroupContainer 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 groupContainer, and the value is a Map to represent Attribute-Value Pairs.
Returns:: set of GroupContainer 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 organizational unit.
Returns:: The 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 organizational unit.
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 organizational unit 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

Parameters:: 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 there is an internal error in the access management 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 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 there is an internal error in the access management 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

deleteUsers

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

Deletes users from this organizational unit.

Parameters:: users - The set of user DN's to be deleted from the organizational unit.
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

Gets the names (DNs) of users in the organizational unit.

Returns:: Set The names(DNs) of users in the organizational unit.
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

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 organizational unit.
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 organizational unit 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 AMSearchResults searchUsers(java.lang.String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException

Searches for users in this organizational unit 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 organizational unit 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

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 of 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 organizational unit using wildcards and filter. Wildcards can be specified such as a*, *, *a. To further refine the search, filter can be specified so that DNs of users with matching filter 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 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 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 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

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

registerService

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

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

Unregister a service for this organizational unit.

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 organizational unit and its roles.

Parameters:: serviceName - service name.; policyDNs - Set of policy DN string
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.

modifyAllPolicyTemplates

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

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

Parameters:: serviceName - service name.; policyDNs - Set of policy DN string.
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.

deleteAllNamedPolicyTemplates

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

Deletes all the named policy templates for this Organizational Unit 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 templates existed and were 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.

getAssignedPolicyDNs

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

Returns all the assigned policies for this organizational unit.

Returns:: a set of assigned policy DNs
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.

isPolicyAssigned

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

Returns true if a policyDN is assigned to this organizational unit or a role.

Parameters:: policyDN - a policy DN.; serviceName - service name.
Returns:: true if policy is assigned to an organization or role.
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

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

assignService

public void assignService(java.lang.String serviceName,
                          java.util.Map attrMap)
                   throws AMException,
                          SSOException

Assign service to the organizational unit. Also sets the attributes as provided in the map. If the service is already assigned to the user than it sets the attribute-values as defined in the attribute map. Attribute value is validated before being set. Any values for attributes already there are replaced with the ones provided in the attribute map.

Parameters:: serviceName - Name of service to be assigned to user.; attrMap - Map of attribute name and values (as a Set) to be set
Throws:: AMException - if an error is encounters when trying to access/retrieve data from the data store.; SSOException - if the single sign on token is no longer valid.

unassignServices

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

Unassigns services from the organizational unit. 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.

createEntities

public java.util.Set createEntities(java.lang.String type,
                                    java.util.Set entities)
                             throws AMException,
                                    SSOException

Create managed entities in this container. Supported entities, as defined in the configuration service DAI, can be created using this method.

Parameters:: type - Type of entity to be create (For example "user" or "agent"; entities - Set of names for the entities to be created
Returns:: Set of AMEntity objects
Throws:: AMException - If there is an error when trying to save to the data store; SSOException - if the single sign on token is invalid.

createEntities

public java.util.Set createEntities(java.lang.String stype,
                                    java.util.Map entities)
                             throws AMException,
                                    SSOException

Creates entities and initializes their attributes. Supported entities, as defined in the configuration service DAI, can be created using this method.

Parameters:: stype - Type of entity to be create (For example "user" or "agent"; entities - Map where the key is the name of the entity, and the value is a Map to represent Attribute-Value Pairs
Returns:: Set of AMEntity objects created
Throws:: AMException - if an error is encountered when trying to create entity in the data store.; SSOException - if the single sign on token is no longer valid

searchEntities

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

Searches for resources in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK uses the eSearchTemplate, if provided. Otherwise, it uses the BasicEntitySearch template.

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); eSearchTemplate - Name of search template to be used. If a null is passed then the default search template for entities BasicEntitySearch is used.; avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.
Returns:: Set DNs of resources 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.

searchEntities

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

Searches for resources in this people container 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; eSearchTemplate - Name of search template to be used.; searchControl - specifies the search scope to be used, VLV ranges etc.
Returns:: AMSearchResults which contains a Set DNs of resources 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.

searchEntities

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

Searches for entities in this container using wildcards and a filter. Wildcards can be specified such as a*, *, *a. To further refine the search, a filter can be passed, which is used to further qualify the basic entity search filter.

Parameters:: wildcard - pattern to be used in the search.; searchControl - specifies the search scope to be used, VLV ranges etc.; avfilter - this attribute-value pairs filter will be logical AND with user search filter.; eSearchTemplate - Name of search template to be used. If a null is passed then the default search template for entities BasicEntitySearch is used.
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.

deleteEntities

public void deleteEntities(java.util.Set resources)
                    throws AMException,
                           SSOException

Deletes a set of resources in this people container.

Parameters:: resources - The set of resource DNs to be removed.
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.

getSupportedTypes

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

Returns a set of the supported entity names in this container. This will help the application or console determine what kind of entities are stored in this container, and accordingly look for them.

Returns:: Set of names of the supported objects in this container.
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.

setSupportedTypes

public void setSupportedTypes(java.util.Set sTypes)
                       throws AMException,
                              SSOException

Sets the list of supported types for this container.

Parameters:: sTypes - The set of supported entity 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.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Method Summary
`void`	`assignService(java.lang.String serviceName, java.util.Map attrMap)` Assign service to the organizational unit.
`java.util.Set`	`createAssignableDynamicGroups(java.util.Set assignableDynamicGroups)` Creates assignable dynamic groups.
`java.util.Set`	`createDynamicGroups(java.util.Map dynamicGroups)` Creates dynamic groups and initializes their attributes.
`java.util.Set`	`createEntities(java.lang.String stype, java.util.Map entities)` Creates entities and initializes their attributes.
`java.util.Set`	`createEntities(java.lang.String type, java.util.Set entities)` Create managed entities in this container.
`java.util.Set`	`createFilteredRoles(java.util.Map roles)` Creates filtered roles.
`java.util.Set`	`createFilteredRoles(java.util.Set roles)` Creates filtered roles.
`java.util.Set`	`createGroupContainers(java.util.Map groupContainers)` Creates group containers and initializes their attributes.
`java.util.Set`	`createGroupContainers(java.util.Set groupContainers)` Creates group containers.
`java.util.Set`	`createOrganizations(java.util.Map organizations)` Creates organizations and initializes their attributes.
`java.util.Set`	`createOrganizations(java.util.Set organizations)` Creates organizations.
`java.util.Set`	`createPeopleContainers(java.util.Map peopleContainers)` Creates people containers and initializes their attributes.
`java.util.Set`	`createPeopleContainers(java.util.Set peopleContainers)` Creates people containers.
`java.util.Set`	`createRoles(java.util.Map roles)` Creates roles.
`java.util.Set`	`createRoles(java.util.Set roles)` Creates roles.
`java.util.Set`	`createStaticGroups(java.util.Set groups)` Creates static groups.
`java.util.Set`	`createSubOrganizationalUnits(java.util.Map subOrganizationalUnits)` Creates sub-organizational units and initializes their attributes.
`java.util.Set`	`createSubOrganizationalUnits(java.util.Set subOrganizationalUnits)` Creates sub-organizational units.
`java.util.Set`	`createUsers(java.util.Map users)` Creates users and initializes their attributes.For each user the, object classes specified by organization type attribute `iplanet-am-required-services` of the service `iPlanetAMAdminConsoleService` template are added.
`java.util.Set`	`createUsers(java.util.Set users)` Creates users and initializes their attributes.
`boolean`	`deleteAllNamedPolicyTemplates(java.lang.String policyDN)` Deletes all the named policy templates for this Organizational Unit corresponding to the given policy.
`void`	`deleteAssignableDynamicGroups(java.util.Set assignableDynamicGroups)` Deletes assignable dynamic groups.
`void`	`deleteDynamicGroups(java.util.Set dynamicGroups)` Deletes dynamic groups.
`void`	`deleteEntities(java.util.Set resources)` Deletes a set of resources in this people container.
`void`	`deleteFilteredRoles(java.util.Set roles)` Deletes filtered roles.
`void`	`deleteGroupContainers(java.util.Set groupContainers)` Deletes group containers.
`void`	`deleteOrganizations(java.util.Set organizations)` Deletes organizations
`void`	`deletePeopleContainers(java.util.Set peopleContainers)` Creates people containers and initializes their attributes.
`void`	`deleteRoles(java.util.Set roles)` Deletes roles.
`void`	`deleteStaticGroups(java.util.Set groups)` Deletes static groups.
`void`	`deleteSubOrganizationalUnits(java.util.Set subOrganizationalUnits)` Deletes sub organizational units
`void`	`deleteUsers(java.util.Set users)` Deletes users from this organizational unit.
`java.util.Set`	`getAssignableDynamicGroups(int level)` Returns the assignable dynamic groups within the specified level.
`java.util.Set`	`getAssignedPolicyDNs()` Returns all the assigned policies for this organizational unit.
`java.util.Set`	`getDynamicGroups(int level)` Gets the dynamic groups within the specified level.
`java.util.Set`	`getFilteredRoles(int level)` Gets the filtered roles within the specified level.
`java.util.Set`	`getGroupContainers(int level)` Gets the group containers within the specified level.
`long`	`getNumberOfAssignableDynamicGroups(int level)` Gets number of assignable dynamic groups within the specified level.
`long`	`getNumberOfDynamicGroups(int level)` Gets number of dynamic groups within the specified level.
`long`	`getNumberOfFilteredRoles(int level)` Gets number of filtered roles within the specified level.
`long`	`getNumberOfGroupContainers(int level)` Gets number of group containers within the specified level.
`long`	`getNumberOfOrganizations(int level)` Gets number of organizations within the specified level.
`long`	`getNumberOfPeopleContainers(int level)` Gets number of people containers within the specified level.
`long`	`getNumberOfRoles(int level)` Gets number of roles within the specified level.
`long`	`getNumberOfServices()` Returns the number of services.
`long`	`getNumberOfStaticGroups(int level)` Gets number of static groups within the specified level.
`long`	`getNumberOfSubOrganizationalUnits(int level)` Gets number of sub organizational units within the specified level.
`long`	`getNumberOfUsers(int level)` Gets number of users within the specified level.
`AMOrganization`	`getOrganization(java.lang.String dn)` Gets the organization by DN
`java.util.Set`	`getOrganizations(int level)` Gets the organizations within the specified level.
`java.util.Set`	`getPeopleContainers(int level)` Gets the people containers within the specified level.
`java.util.Set`	`getRegisteredServiceNames()` Gets the names of registered services.
`java.util.Set`	`getRoles(int level)` Gets the roles within the specified level.
`java.util.Set`	`getStaticGroups(int level)` Gets the static groups within the specified level.
`AMOrganizationalUnit`	`getSubOrganizationalUnit(java.lang.String dn)` Gets the sub-organizational unit by DN
`java.util.Set`	`getSubOrganizationalUnits(int level)` Gets the sub organizational units within the specified level.
`java.util.Set`	`getSupportedTypes()` Returns a set of the supported entity names in this container.
`java.util.Set`	`getUserDNs()` Gets the names (DNs) of users in the organizational unit.
`boolean`	`isPolicyAssigned(java.lang.String policyDN, java.lang.String serviceName)` Returns true if a `policyDN` is assigned to this organizational unit or a role.
`void`	`modifyAllPolicyTemplates(java.lang.String serviceName, java.util.Set policyDNs)` Modifies all the templates under this organizational unit that contain any `policyDN` in given `policyDNs`.
`boolean`	`orgTemplateExists(java.lang.String serviceName)` Returns true if an organizational template exists for the service.
`void`	`registerService(java.lang.String serviceName, boolean createTemplate, boolean activate)` Register a service for this organizational unit.
`AMSearchResults`	`searchAllRoles(java.lang.String wildcard, AMSearchControl searchControl)` Searches for all roles in this organizational unit using wildcards.
`java.util.Set`	`searchAllRoles(java.lang.String wildcard, int level)` Searches for all roles in this organizational unit using wildcards.
`AMSearchResults`	`searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for all roles in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchAllRoles(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for all roles in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchAssignableDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl)` Searches for assignable dynamic groups in this organizational unit using wildcards.
`java.util.Set`	`searchAssignableDynamicGroups(java.lang.String wildcard, int level)` Searches for assignable dynamic groups in this organizational unit using wildcards.
`AMSearchResults`	`searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchAssignableDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for assignable dynamic groups in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchDynamicGroups(java.lang.String wildcard, AMSearchControl searchControl)` Searches for dynamic groups in this organization unit using wildcards.
`java.util.Set`	`searchDynamicGroups(java.lang.String wildcard, int level)` Searches for dynamic groups in this organization unit using wildcards.
`AMSearchResults`	`searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for dynamic groups in this organization unit using wildcards and attribute values.
`java.util.Set`	`searchDynamicGroups(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for dynamic groups in this organization unit using wildcards and attribute values.
`AMSearchResults`	`searchEntities(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter, java.lang.String eSearchTemplate)` Searches for entities in this container using wildcards and a filter.
`java.util.Set`	`searchEntities(java.lang.String wildcard, int level, java.lang.String eSearchTemplate, java.util.Map avPairs)` Searches for resources in this organization using wildcards and attribute values.
`AMSearchResults`	`searchEntities(java.lang.String wildcard, java.util.Map avPairs, java.lang.String eSearchTemplate, AMSearchControl searchControl)` Searches for resources in this people container using wildcards and attribute values.
`AMSearchResults`	`searchFilteredRoles(java.lang.String wildcard, AMSearchControl searchControl)` Searches for filtered roles in this organization using wildcards.
`java.util.Set`	`searchFilteredRoles(java.lang.String wildcard, int level)` Searches for filtered roles in this organization using wildcards.
`AMSearchResults`	`searchFilteredRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for filtered roles in this organization using wildcards and attribute values.
`java.util.Set`	`searchFilteredRoles(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for filtered roles in this organization using wildcards and attribute values.
`AMSearchResults`	`searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for group containers in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for group containers in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for groups in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchGroups(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for groups in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchOrganizations(java.lang.String wildcard, AMSearchControl searchControl)` Searches for organizations in this organizational unit using wildcards.
`java.util.Set`	`searchOrganizations(java.lang.String wildcard, int level)` Searches for organizations in this organizational unit using wildcards.
`AMSearchResults`	`searchOrganizations(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for organizations in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchOrganizations(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for organizations in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchPeopleContainers(java.lang.String wildcard, AMSearchControl searchControl)` Searches for people containers in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchPeopleContainers(java.lang.String wildcard, int level)` Searches for people containers in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for people containers in this organizational unit using wildcards * and * attribute values.
`java.util.Set`	`searchPeopleContainers(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for people containers in this organizational unit using wildcards * and * attribute values.
`AMSearchResults`	`searchRoles(java.lang.String wildcard, AMSearchControl searchControl)` Searches for roles in this organizational unit using wildcards.
`java.util.Set`	`searchRoles(java.lang.String wildcard, int level)` Searches for roles in this organizational unit using wildcards.
`AMSearchResults`	`searchRoles(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for roles in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchRoles(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for roles in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchStaticGroups(java.lang.String wildcard, AMSearchControl searchControl)` Searches for static groups in this organizational unit using wildcards.
`java.util.Set`	`searchStaticGroups(java.lang.String wildcard, int level)` Searches for static groups in this organizational unit using wildcards.
`AMSearchResults`	`searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for static groups in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchStaticGroups(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for static groups in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchSubOrganizationalUnits(java.lang.String wildcard, AMSearchControl searchControl)` Searches for sub organizational units in this organizational unit using wildcards.
`java.util.Set`	`searchSubOrganizationalUnits(java.lang.String wildcard, int level)` Searches for sub organizational units in this organizational unit using wildcards.
`AMSearchResults`	`searchSubOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for sub organizational units in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchSubOrganizationalUnits(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for sub organizational units in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchUsers(AMSearchControl searchControl, java.lang.String avfilter)` Searches for users in this organization attribute values.
`AMSearchResults`	`searchUsers(java.lang.String wildcard, AMSearchControl searchControl)` Searches for users in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchUsers(java.lang.String wildcard, AMSearchControl searchControl, java.lang.String avfilter)` Searches for users in this organizational unit using wildcards and filter.
`java.util.Set`	`searchUsers(java.lang.String wildcard, int level)` Searches for users in this organizational unit using wildcards and attribute values.
`AMSearchResults`	`searchUsers(java.lang.String wildcard, java.util.Map avPairs, AMSearchControl searchControl)` Searches for users in this organizational unit using wildcards and attribute values.
`java.util.Set`	`searchUsers(java.lang.String wildcard, java.util.Map avPairs, int level)` Searches for users in this organizational unit using wildcards and attribute values.
`void`	`setSupportedTypes(java.util.Set sTypes)` Sets the list of supported types for this container.
`void`	`unassignAllPolicies(java.lang.String serviceName, java.util.Set policyDNs)` Unassigns the given policies from this organizational unit and its roles.
`void`	`unassignServices(java.util.Set serviceNames)` Unassigns services from the organizational unit.
`void`	`unregisterService(java.lang.String serviceName)` Unregister a service for this organizational unit.

com.iplanet.am.sdk Interface AMOrganizationalUnit

createOrganizations

createOrganizations

deleteOrganizations

getOrganization

getOrganizations

getNumberOfOrganizations

searchOrganizations

searchOrganizations

searchOrganizations

searchOrganizations

createSubOrganizationalUnits

createSubOrganizationalUnits

deleteSubOrganizationalUnits

getSubOrganizationalUnit

getSubOrganizationalUnits

getNumberOfSubOrganizationalUnits

searchSubOrganizationalUnits

searchSubOrganizationalUnits

searchSubOrganizationalUnits

searchSubOrganizationalUnits

createRoles

createRoles

deleteRoles

getRoles

getNumberOfRoles

searchRoles

searchRoles

searchRoles

searchRoles

createFilteredRoles

createFilteredRoles

deleteFilteredRoles

getFilteredRoles

getNumberOfFilteredRoles

searchFilteredRoles

searchFilteredRoles

searchFilteredRoles

searchFilteredRoles

searchAllRoles

searchAllRoles

searchAllRoles

searchAllRoles

createAssignableDynamicGroups

deleteAssignableDynamicGroups

getAssignableDynamicGroups

getNumberOfAssignableDynamicGroups

searchAssignableDynamicGroups

searchAssignableDynamicGroups

searchAssignableDynamicGroups

searchAssignableDynamicGroups

createDynamicGroups

deleteDynamicGroups

getDynamicGroups

getNumberOfDynamicGroups

searchDynamicGroups

searchDynamicGroups

searchDynamicGroups

searchDynamicGroups

createStaticGroups

deleteStaticGroups

getStaticGroups

getNumberOfStaticGroups

searchStaticGroups

searchStaticGroups

searchStaticGroups

searchStaticGroups

searchGroups

searchGroups

createPeopleContainers

createPeopleContainers

deletePeopleContainers

getPeopleContainers

getNumberOfPeopleContainers

searchPeopleContainers

searchPeopleContainers

searchPeopleContainers

searchPeopleContainers

createGroupContainers

createGroupContainers

com.iplanet.am.sdk
Interface AMOrganizationalUnit