com.iplanet.am.sdk
Interface AMOrganizationalUnit

All Superinterfaces:

AMConstants, AMObject

public interface AMOrganizationalUnit

extends AMObject

The AMOrganizationalUnit interface provides methods to manage organizational unit

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

ASSIGNABLE_DYNAMIC_GROUP, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNKNOWN_OBJECT_TYPE, USER

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

SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE

Method Summary

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	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 OrganizationalUnit 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	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 suborganizational units
void	deleteUsers(java.util.Set users) Deletes users from this organizational unit.
java.util.Set	getAssignableDynamicGroups(int level) Gets the assignable dynamic groups within the specified level.
java.util.Set	getAssignedPolicyDNs() Gets all the assigned policies for this OrganizationalUnit
java.util.Set	getDynamicGroups(int level) Gets the dynamic groups 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	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() Gets the number of services.
long	getNumberOfStaticGroups(int level) Gets number of static groups within the specified level.
long	getNumberOfSubOrganizationalUnits(int level) Gets number of suborganizational 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 suborganizational units within the specified level.
java.util.Set	getUserDNs() Gets the names (DNs) of users in the organizational unit.
boolean	isPolicyAssigned(java.lang.String policyDN, java.lang.String serviceName) Checks if a policyDN is assigned to this org-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) Checks if an org template exists for the service.
void	registerService(java.lang.String serviceName, boolean createTemplate, boolean activate) Register a service for this organizational unit.
AMSearchResults	searchAssignableDynamicGroups(java.lang.String wildcard, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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	searchGroupContainers(java.lang.String wildcard, java.util.Map avPairs, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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, com.iplanet.am.sdk.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(com.iplanet.am.sdk.AMSearchControl searchControl, java.lang.String avfilter) Searches for users in this organization attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, com.iplanet.am.sdk.AMSearchControl searchControl) Searches for users in this organizational unit using wildcards and attribute values.
AMSearchResults	searchUsers(java.lang.String wildcard, com.iplanet.am.sdk.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, com.iplanet.am.sdk.AMSearchControl searchControl) Searches for users in this organizational unit using wildcards and attribute values.
java.util.Set	searchUsers(java.lang.String wildcard, java.util.Map avPairs, int level) Searches for users in this organizational unit using wildcards and attribute values.
void	unassignAllPolicies(java.lang.String serviceName, java.util.Set policyDNs) Unassigns the given policies from this organizational unit and its roles.
void	unregisterService(java.lang.String serviceName) Unregister a service for this organizational unit.

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

addEventListener, assignPolicies, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getStringAttribute, getTemplate, isExists, removeAttributes, removeEventListener, search, setAttributes, setStringAttribute, 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 sign on 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 sign on 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 sign on 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

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.

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.

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 sign on is no longer valid

searchOrganizations

public AMSearchResults searchOrganizations(java.lang.String wildcard,
                                           com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchOrganizations

public AMSearchResults searchOrganizations(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           com.iplanet.am.sdk.AMSearchControl searchControl)
                                    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 specifed 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

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 sign on 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 OrganizationalUnit objects created.

Throws:

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

SSOException - if the sign on 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 suborganizational unit, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set set of sub OrganizationalUnit objects created.

Throws:

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

SSOException - if the sign on is no longer valid

deleteSubOrganizationalUnits

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

Deletes suborganizational units

Parameters:

subOrganizationalUnits - The set of suborganizational 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 sign on is no longer valid

getSubOrganizationalUnit

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

Gets the sub-organizational unit by DN

Parameters:

dn - DN

Returns:

The sub OrganizationalUnit object

getSubOrganizationalUnits

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

Gets the suborganizational units within the specified level.

Parameters:

level - The search level starting from the organizational unit.

Returns:

The Set of suborganizational units DNs within the specified level.

getNumberOfSubOrganizationalUnits

public long getNumberOfSubOrganizationalUnits(int level)
                                       throws AMException,
                                              SSOException

Gets number of suborganizational units within the specified level.

Parameters:

level - The search level starting from the organizational unit.

Returns:

Number of suborganizational units within the specified level.

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 sign on is no longer valid

searchSubOrganizationalUnits

public AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard,
                                                    com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchSubOrganizationalUnits

public AMSearchResults searchSubOrganizationalUnits(java.lang.String wildcard,
                                                    java.util.Map avPairs,
                                                    com.iplanet.am.sdk.AMSearchControl searchControl)
                                             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 specifed 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

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 sign on 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 sign on 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 sign on 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 sign on 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.

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.

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

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 sign on is no longer valid

searchRoles

public AMSearchResults searchRoles(java.lang.String wildcard,
                                   com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchRoles

public AMSearchResults searchRoles(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   com.iplanet.am.sdk.AMSearchControl searchControl)
                            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 specifed so that DNs of roles with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching roles

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

Returns:

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

Throws:

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

SSOException - if the sign on 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 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 sign on 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 sign on is no longer valid

getAssignableDynamicGroups

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

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

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.

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 sign on is no longer valid

searchAssignableDynamicGroups

public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchAssignableDynamicGroups

public AMSearchResults searchAssignableDynamicGroups(java.lang.String wildcard,
                                                     java.util.Map avPairs,
                                                     com.iplanet.am.sdk.AMSearchControl searchControl)
                                              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 specifed so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

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

Throws:

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

SSOException - if the sign on 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 sign on 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 AM Store

SSOException - if the sign on 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 DynamicGroups within the specified level.

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.

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

Returns:

Set Set of DNs of dynamic groups matching the search

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on is no longer valid

searchDynamicGroups

public AMSearchResults searchDynamicGroups(java.lang.String wildcard,
                                           com.iplanet.am.sdk.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 sign on 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 specifed so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

Set Set of DNs of dynamic groups matching the search

Throws:

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

SSOException - if the sign on is no longer valid

searchDynamicGroups

public AMSearchResults searchDynamicGroups(java.lang.String wildcard,
                                           java.util.Map avPairs,
                                           com.iplanet.am.sdk.AMSearchControl searchControl)
                                    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 specifed so that DNs of dynamic groups with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

AMSearchResults which contains 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 sign on 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 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 sign on 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 sign on 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.

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.

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 sign on is no longer valid

searchStaticGroups

public AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchStaticGroups

public AMSearchResults searchStaticGroups(java.lang.String wildcard,
                                          java.util.Map avPairs,
                                          com.iplanet.am.sdk.AMSearchControl searchControl)
                                   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 specifed 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

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 sign on 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 sign on is no longer valid

searchGroups

public AMSearchResults searchGroups(java.lang.String wildcard,
                                    java.util.Map avPairs,
                                    com.iplanet.am.sdk.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 sign on is no longer valid

createPeopleContainers

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

Creates people containers.

Parameters:

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

Returns:

Set 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 sign on 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 peopleContainer, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set set of PeopleContainer objects created

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on 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 peopleContainer, and the value is a Map to represent Attribute-Value Pairs

Returns:

Set 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 sign on 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 PeopleContainer's within the specified level.

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.

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 sign on is no longer valid

searchPeopleContainers

public AMSearchResults searchPeopleContainers(java.lang.String wildcard,
                                              com.iplanet.am.sdk.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 sign on 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 specifed so that DNs of people containers with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

Set DNs of people containers matching the search

Throws:

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

SSOException - if the sign on is no longer valid

searchPeopleContainers

public AMSearchResults searchPeopleContainers(java.lang.String wildcard,
                                              java.util.Map avPairs,
                                              com.iplanet.am.sdk.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. To further refine the search, attribute-value pairs can be specifed so that DNs of people containers with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

AMSearchResults which contains a Set DNs of people containers matching the search

Throws:

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

SSOException - if the sign on 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 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 sign on 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 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 sign on 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 sign on 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 GroupContainer's within the specified level.

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.

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 specifed 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 sign on is no longer valid

searchGroupContainers

public AMSearchResults searchGroupContainers(java.lang.String wildcard,
                                             java.util.Map avPairs,
                                             com.iplanet.am.sdk.AMSearchControl searchControl)
                                      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 specifed so that DNs of group containers with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

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

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

Returns:

AMSearchResults which contains a Set DNs of group containers matching the search

Throws:

AMException - if there is an internal error in the AM Store

SSOException - if the sign on 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 AM Store

SSOException - if the sign on 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 sign on 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 sign on 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 sign on 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.

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 sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   com.iplanet.am.sdk.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 sign on 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 specifed 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 sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   java.util.Map avPairs,
                                   com.iplanet.am.sdk.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. To further refine the search, attribute-value pairs can be specifed so that DNs of users with matching attribute-value pairs will be returned.

Parameters:

wildcard - wildcard pattern to be used in the search

avPairs - attribute-value pairs to match when searching users

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

Returns:

AMSearchResults which contains a Set 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 sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(java.lang.String wildcard,
                                   com.iplanet.am.sdk.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 specifed 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 & 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 sign on is no longer valid

searchUsers

public AMSearchResults searchUsers(com.iplanet.am.sdk.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 & 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 AM Store

SSOException - if the sign on is no longer valid

getNumberOfServices

public long getNumberOfServices()
                         throws AMException,
                                SSOException

Gets the number of services.

Returns:

int number of services.

getRegisteredServiceNames

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

Gets the names of registered services.

Returns:

The Set of the names of registered services.

registerService

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

Register a service for this organizational unit.

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 sign on is no longer valid.

unregisterService

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

Unregister a service for this organizational unit.

Parameters:

String - serviceName to be unregistered

Throws:

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

SSOException - if the sign on 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 - serviceName

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 sign-on 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 - serviceName

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 sign-on is no longer valid.

deleteAllNamedPolicyTemplates

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

Deletes all the named policy templates for this OrganizationalUnit corresponding to the given policy. This includes Org based and role based policy templates. This is a convienence method.

Parameters:

policyDN - a policy DN string

Returns:

boolean true if templates existed and were deleted. false otherwise

Throws:

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

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

getAssignedPolicyDNs

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

Gets all the assigned policies for this OrganizationalUnit

Returns:

Set 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 sign-on is no longer valid.

isPolicyAssigned

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

Checks if a policyDN is assigned to this org-unit or a role.

Parameters:

policyDN - a policy DN string

serviceName - service name

Returns:

boolean true if policy is assigned to an org or role. false otherwise

orgTemplateExists

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

Checks if an org template exists for the service.

Parameters:

serviceName - service name

Returns:

boolean true if the org template exists. false otherwise