com.netegrity.llsdk6.imsapi.managedobject
Interface ProvisioningRole

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, Role, java.io.Serializable

public interface ProvisioningRole
extends Role

Provides access to the attributes in an eTrust Admin ProvisioningRole managed object through the methods inherited from the base interface Role. Also provides access to role management methods.

Note: This managed object requires an instance of eTrust Admin Directory.

An eTrust Admin provisioning role contains one or more eTrust Admin provisioning policies. When a user is assigned to a provisioning role, some of the attributes in the user's eTrust Admin accounts are defined by the policies in the role being assigned.

Note: Provisioning roles do not have any associated Identity Manager tasks. Attempts to add tasks to this type of role are ignored. Enumerating tasks for this role always returns an empty list.

Attribute Persistence

Identity Manager allows you to associate eTrust Admin provisioning roles with eTrust Admin provisioning policies.

To persist any changes you make to the attributes of a ProvisioningRole managed object, use the modify... methods in ProvisioningRole, or use the modifyObject() method used to persist attributes in any Identity Manager managed object retrieved through a provider.

Since:

Identity Manager 8.1

See Also:

Account, ManagedObject, ProvisioningPolicy

Nested Class Summary

Nested classes/interfaces inherited from interface com.netegrity.llsdk6.imsapi.managedobject.Role

Role.CustomFieldId

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	ACCOUNT_TEMPLATE_HANDLES The role object's account template handles
static java.lang.String	COMMENTS
static java.lang.String	COMMENTS_4_UI Comments' field name for UI usage
static java.lang.String	CUSTOMFIELDNAME
static java.lang.String	DEPARTMENT
static java.lang.String	DEPARTMENT_4_UI Departments's field name for UI usage
static java.lang.String	DESCRIPTION_4_UI Description's field name for UI usage
static int	MAXCUSTOMFIELDS
static java.lang.String	NAME_4_UI Name's field name for UI usage
static java.lang.String	NESTED_ROLE_HANDLES The role object's nested (child) roles
static java.lang.String	NESTED_ROLES
static java.lang.String	NESTING_ROLE_HANDLES The role object's nesting (parent) roles
static java.lang.String	NESTING_ROLES
static java.lang.String	NESTING_ROLES_4_UI

Fields inherited from interface com.netegrity.llsdk6.imsapi.managedobject.Role

ASSIGNABLE, ASSIGNMENT_TYPE, CONSTRAINT, CONSTRAINT_TYPE, DELEGATABLE, DESCRIPTION, ENABLED, FRIENDLY_NAME, VERSION

Method Summary

java.util.Vector	addProvisioningPolicies(ProvisioningPolicy[] newProvisioningPolicies, java.lang.String operationID) Adds one or more provisioning policies to this provisioning role.
void	clearProvisioningPolicies() Deprecated. In r12.
java.util.Vector	clearProvisioningPolicies(java.lang.String operationID) Removes all the provisioning policies from this provisioning role.
void	delete(boolean deletePSOnly, java.lang.String operationId) Delete the Provisioning Role.
java.util.Vector	delete(java.lang.String operationId) Delete provisioning role using the operation id.
boolean	doesRoleContainMembers() Does the role contain any members
boolean	exists() Indicates whether the provisioning role exists in Identity Manager or whether it exists only as an eTrust Admin object.
java.util.Vector	getAssignedPolicies()
java.util.Vector	getAssignedResources() Returns a user who has been assigned a member but not yet persisted.
java.util.Vector[]	getCustomFields() Returns the provisioning role's custom attributes.
java.lang.Object	getIAMHandle() Returns the unique IAMHandle for this role.
java.lang.Object	getIAMRole(IAMSession iamsession) Returns the associated IAMRole for the role and the specified IAMSession.
java.util.Vector<ProvisioningRole>	getNestedRoles() Retrieves all nested roles for this provisioning role.
java.util.Vector<ProvisioningRole>	getNestedRoles(boolean wantFullRoleChains)
java.util.Vector	getNestedRoles(boolean rolesonlywithimstubs, boolean wantFullRoleChains) This method returns the nested roles for this object.
java.util.Vector<ProvisioningRole>	getNestedRolesRecursive(boolean wantFullRoleChains) Retrieves all nested roles for this provisioning role recursively at all levels.
java.util.Vector<ProvisioningRole>	getNestingRoles() Retrieves all nesting roles for this provisioning role.
java.util.Vector<ProvisioningRole>	getNestingRoles(boolean wantFullRoleChains)
java.util.Vector<ProvisioningRole>	getNestingRolesRecursive(boolean wantFullRoleChains) Retrieves all nesting roles for this provisioning role recursively at all levels.
java.util.Vector	getProvisioningPolicies() Retrieves all the provisioning policies assigned to this provisioning role.
java.util.Vector	getProvisioningPolicies(AttributeRightsCollection arc)
java.util.Vector	getRevokedPolicies() Returns template which has been assigned but not yet persisted.
java.util.Vector	getRevokedResources() Returns a user who has been revoked as role member but not yet persisted.
java.lang.String	getRoleComments() Returns any comment that may be associated with this provisioning role.
java.lang.String	getRoleCustomFieldValue(int customFieldIndex) Retrieves the specified custom field value
java.util.Vector	getRoleCustomFieldValues(int customFieldIndex) Retrieves the specified custom field's values
java.lang.String	getRoleDepartment() Retrieves the name of the department to which the provisioning role belongs.
java.lang.String	getRoleDescription() Retrieves the description of this provisioning role.
java.util.Vector<User>	getUsersInRole(java.util.Enumeration<java.lang.String> attribs) Retrieves all users who are members of a given role
java.util.Vector<User>	getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs) Retrieve all users who are members of a role and members of any roles indirectly due to nesting
java.util.Vector<User>	getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs, boolean wantFullUserRoleChains) Retrieve all users who are members of a role and members of any roles indirectly due to nesting
java.util.Vector<User>	getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs, boolean wantFullUserRoleChains, boolean wantDirect)
java.util.Vector<User>	getUsersInRoleRecursive(java.util.Vector<ProvisioningRole> nestingRoles, java.util.Enumeration<java.lang.String> attribs, boolean wantFullUserRoleChains, boolean wantDirect)
java.lang.Object	modifyObject(java.util.Hashtable extraProps, java.lang.String opId, java.util.Vector returnMessage)
java.util.Vector	modifyObject(ProvisioningPolicy[] policiesToAssign, ProvisioningPolicy[] policiesToUnassign, java.lang.String operationID) Specifies the complete set of provisioning policies to assign to this provisioning role, and immediately commits the assignments to the data store.
java.util.Vector	modifyObject(ProvisioningRole[] newNestedRoles, java.lang.String operationID) Specifies one or more nested roles to associate with this provisioning role, and immediately commits the associations to the data store.
java.lang.Object	modifyPolicyStoreRoleObject() Creates or updates the policy store role object and all associated Identity Manager role policies.
java.util.Vector	removeProvisioningPolicies(ProvisioningPolicy[] ProvisioningPolicies, java.lang.String operationID) Removes one or more provisioning policies from this provisioning role.
void	setAssignedPolicy(ProvisioningPolicy policy) Sets a template on the role
void	setAssignedResource(User user) Sets a user as assigned to role
void	setNestedRoles(ProvisioningRole[] nestedRoles) Add roles as nested members of the role
void	setNestedRolesToRemove(ProvisioningRole[] nestedRoles) Remove roles as nested members of the role
void	setRevokedPolicy(ProvisioningPolicy policy) Sets a template on the role
void	setRevokedResource(User user) Sets a user revocation from a role
void	setRoleComments(java.lang.String newComments) Sets a user-defined comment for the provisioning role.
void	setRoleCustomFieldValue(int customFieldIndex, java.lang.String value) Sets the specified custom field value
void	setRoleCustomFieldValues(int customFieldIndex, java.util.Vector values) Sets the specified custom field
void	setRoleDepartment(java.lang.String newDepartment) Sets the name of the department to which the provisioning role belongs.
void	setRoleDescription(java.lang.String newDescription) Sets the description of this provisioning role.

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.Role

addTasks, clearAdminPolicies, clearMembershipPolicies, clearTasks, createAdminPolicy, createAdminPolicy, createMembershipPolicy, createMembershipPolicy, createMembershipPolicy, enableRole, getAdministrators, getAdministrators, getAdminPolicies, getAllowDuplicateCustom, getChangeActions, getCustomField, getMembers, getMembers, getMembers, getMembershipPolicies, getOwners, getOwners, getTasks, isRoleAdminAssignable, isRoleAssignable, isRoleEnabled, modifyObject, removeTasks, setAllowDuplicateCustom, setChangeActions, setChangeActions, setCustomField, setFriendlyName, setRoleAdminAssignable, setRoleAssignable

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

NAME_4_UI

static final java.lang.String NAME_4_UI

Name's field name for UI usage

See Also:

Constant Field Values

DESCRIPTION_4_UI

static final java.lang.String DESCRIPTION_4_UI

Description's field name for UI usage

See Also:

Constant Field Values

COMMENTS_4_UI

static final java.lang.String COMMENTS_4_UI

Comments' field name for UI usage

See Also:

Constant Field Values

DEPARTMENT_4_UI

static final java.lang.String DEPARTMENT_4_UI

Departments's field name for UI usage

See Also:

Constant Field Values

NESTING_ROLES_4_UI

static final java.lang.String NESTING_ROLES_4_UI

See Also:

Constant Field Values

COMMENTS

static final java.lang.String COMMENTS

See Also:

Constant Field Values

DEPARTMENT

static final java.lang.String DEPARTMENT

See Also:

Constant Field Values

CUSTOMFIELDNAME

static final java.lang.String CUSTOMFIELDNAME

See Also:

Constant Field Values

ACCOUNT_TEMPLATE_HANDLES

static final java.lang.String ACCOUNT_TEMPLATE_HANDLES

The role object's account template handles

See Also:

Constant Field Values

NESTED_ROLE_HANDLES

static final java.lang.String NESTED_ROLE_HANDLES

The role object's nested (child) roles

See Also:

Constant Field Values

NESTING_ROLE_HANDLES

static final java.lang.String NESTING_ROLE_HANDLES

The role object's nesting (parent) roles

See Also:

Constant Field Values

NESTED_ROLES

static final java.lang.String NESTED_ROLES

See Also:

Constant Field Values

NESTING_ROLES

static final java.lang.String NESTING_ROLES

See Also:

Constant Field Values

MAXCUSTOMFIELDS

static final int MAXCUSTOMFIELDS

See Also:

Constant Field Values

Method Detail

getRoleDescription

java.lang.String getRoleDescription()

Retrieves the description of this provisioning role.

Specified by:

getRoleDescription in interface Role

Returns:

The provisioning role's description.

setRoleDescription

void setRoleDescription(java.lang.String newDescription)

Sets the description of this provisioning role.

Specified by:

setRoleDescription in interface Role

Parameters:

newDescription - The new description of the provisioning role.

getRoleComments

java.lang.String getRoleComments()

Returns any comment that may be associated with this provisioning role.

Returns:

A comment associated with the provisioning role.

setRoleComments

void setRoleComments(java.lang.String newComments)

Sets a user-defined comment for the provisioning role. A comment is any piece of information that has meaning to your particular site but that is not represented by any other role attribute.

Parameters:

newComments - The new comment for the provisioning role.

getRoleDepartment

java.lang.String getRoleDepartment()

Retrieves the name of the department to which the provisioning role belongs.

Returns:

The name of the provisioning role's department.

setRoleDepartment

void setRoleDepartment(java.lang.String newDepartment)

Sets the name of the department to which the provisioning role belongs.

Parameters:

newDepartment - The new department name for the provisioning role.

getRoleCustomFieldValue

java.lang.String getRoleCustomFieldValue(int customFieldIndex)
                                         throws JIAMOperationException

Retrieves the specified custom field value

Parameters:

customFieldIndex - The index of the custom field, valid values are 1 to MAXCUSTOMFIELDS.

Returns:

The value for the custom field

Throws:

JIAMOperationException - An error occured retrieving the specified field

setRoleCustomFieldValue

void setRoleCustomFieldValue(int customFieldIndex,
                             java.lang.String value)
                             throws JIAMOperationException

Sets the specified custom field value

Parameters:

customFieldIndex - The index of the custom field. Valid values are 1 to MAXCUSTOMFIELDS.

value - The String value for the custom field

Throws:

JIAMOperationException - An error occured setting the specified field

getRoleCustomFieldValues

java.util.Vector getRoleCustomFieldValues(int customFieldIndex)
                                          throws JIAMOperationException

Retrieves the specified custom field's values

Note: this method should only be used if defining multiple values for custom fields

Parameters:

customFieldIndex - The index of the custom field, valid values are 1 to MAXCUSTOMFIELDS.

Returns:

A Vector of zero or more Strings for the custom field

Throws:

JIAMOperationException - An error occured retrieving the specified field

setRoleCustomFieldValues

void setRoleCustomFieldValues(int customFieldIndex,
                              java.util.Vector values)
                              throws JIAMOperationException

Sets the specified custom field

Note: this method should only be used if defining multiple values for custom fields

Parameters:

customFieldIndex - The index of the custom field. Valid values are 1 to MAXCUSTOMFIELDS.

values - A Vector of zero or more Strings for the custom field

Throws:

JIAMOperationException - An error occured setting the specified field

getIAMHandle

java.lang.Object getIAMHandle()
                              throws JIAMOperationException

Returns the unique IAMHandle for this role.

For information on the role's unique IAMHandle identifier, see the eTrust IAM API Documentation (Javadoc).

Returns:

The role's IAMHandle.

Throws:

JIAMOperationException

getIAMRole

java.lang.Object getIAMRole(IAMSession iamsession)
                            throws JIAMOperationException,
                                   ProvisioningRoleIAMRoleLinkException

Returns the associated IAMRole for the role and the specified IAMSession.

For information on IAMRole and IAMSession objects, see the eTrust IAM API Documentation (Javadoc).

Parameters:

iamsession - The IAMSession object.

Returns:

The IAMRole object.

Throws:

JIAMOperationException

ProvisioningRoleIAMRoleLinkException

doesRoleContainMembers

boolean doesRoleContainMembers()
                               throws com.netegrity.sdk.apiutil.SmApiException

Does the role contain any members

Returns:

true if the role contain members; false otherwise

Throws:

com.netegrity.sdk.apiutil.SmApiException

getNestedRoles

java.util.Vector<ProvisioningRole> getNestedRoles()
                                                  throws DeletedObjectException,
                                                         JIAMOperationException

Retrieves all nested roles for this provisioning role. Nested roles are child objects of the provisioning role.

Returns:

A Vector of the ProvisioningRole objects nested under this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from retrieving the set failed.

getNestedRoles

java.util.Vector<ProvisioningRole> getNestedRoles(boolean wantFullRoleChains)
                                                  throws DeletedObjectException,
                                                         JIAMOperationException

Throws:

DeletedObjectException

JIAMOperationException

getNestedRolesRecursive

java.util.Vector<ProvisioningRole> getNestedRolesRecursive(boolean wantFullRoleChains)
                                                           throws DeletedObjectException,
                                                                  JIAMOperationException

Retrieves all nested roles for this provisioning role recursively at all levels. Nested roles are child objects of the provisioning role.

Returns:

A Vector of the ProvisioningRole objects nested under this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from retrieving the set failed.

getNestingRoles

java.util.Vector<ProvisioningRole> getNestingRoles()
                                                   throws DeletedObjectException,
                                                          JIAMOperationException

Retrieves all nesting roles for this provisioning role. Nesting roles are parent objects of the provisioning role.

Returns:

A Vector of the ProvisioningRole objects nested under this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from retrieving the set failed.

getNestingRoles

java.util.Vector<ProvisioningRole> getNestingRoles(boolean wantFullRoleChains)
                                                   throws DeletedObjectException,
                                                          JIAMOperationException

Throws:

DeletedObjectException

JIAMOperationException

getNestingRolesRecursive

java.util.Vector<ProvisioningRole> getNestingRolesRecursive(boolean wantFullRoleChains)
                                                            throws DeletedObjectException,
                                                                   JIAMOperationException

Retrieves all nesting roles for this provisioning role recursively at all levels. Nesting roles are parent objects of the provisioning role.

Returns:

A Vector of the ProvisioningRole objects nested under this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from retrieving the set failed.

getUsersInRole

java.util.Vector<User> getUsersInRole(java.util.Enumeration<java.lang.String> attribs)
                                      throws SmApiException

Retrieves all users who are members of a given role

Parameters:

attribs -

Returns:

Throws:

SmApiException

getUsersInRoleRecursive

java.util.Vector<User> getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs)
                                               throws DeletedObjectException,
                                                      JIAMOperationException,
                                                      SmApiException

Retrieve all users who are members of a role and members of any roles indirectly due to nesting

Parameters:

attribs -

Returns:

Throws:

DeletedObjectException

JIAMOperationException

SmApiException

getUsersInRoleRecursive

java.util.Vector<User> getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs,
                                               boolean wantFullUserRoleChains)
                                               throws DeletedObjectException,
                                                      JIAMOperationException,
                                                      SmApiException

Retrieve all users who are members of a role and members of any roles indirectly due to nesting

Parameters:

attribs - Requested attributes

wantFullUserRoleChains - Controls whether full role path should be calculated for each user

Returns:

Throws:

DeletedObjectException

JIAMOperationException

SmApiException

getUsersInRoleRecursive

java.util.Vector<User> getUsersInRoleRecursive(java.util.Enumeration<java.lang.String> attribs,
                                               boolean wantFullUserRoleChains,
                                               boolean wantDirect)
                                               throws DeletedObjectException,
                                                      JIAMOperationException,
                                                      SmApiException

Throws:

DeletedObjectException

JIAMOperationException

SmApiException

getUsersInRoleRecursive

java.util.Vector<User> getUsersInRoleRecursive(java.util.Vector<ProvisioningRole> nestingRoles,
                                               java.util.Enumeration<java.lang.String> attribs,
                                               boolean wantFullUserRoleChains,
                                               boolean wantDirect)
                                               throws DeletedObjectException,
                                                      JIAMOperationException,
                                                      SmApiException

Throws:

DeletedObjectException

JIAMOperationException

SmApiException

setNestedRoles

void setNestedRoles(ProvisioningRole[] nestedRoles)

Add roles as nested members of the role

Parameters:

nestedRoles - Roles to add

setNestedRolesToRemove

void setNestedRolesToRemove(ProvisioningRole[] nestedRoles)

Remove roles as nested members of the role

Parameters:

nestedRoles - Roes to remove

getProvisioningPolicies

java.util.Vector getProvisioningPolicies()
                                         throws DeletedObjectException,
                                                JIAMOperationException

Retrieves all the provisioning policies assigned to this provisioning role.

Returns:

A Vector of the ProvisioningPolicy objects assigned to this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from retrieving the set failed.

getProvisioningPolicies

java.util.Vector getProvisioningPolicies(AttributeRightsCollection arc)
                                         throws DeletedObjectException,
                                                JIAMOperationException

Throws:

DeletedObjectException

JIAMOperationException

addProvisioningPolicies

java.util.Vector addProvisioningPolicies(ProvisioningPolicy[] newProvisioningPolicies,
                                         java.lang.String operationID)
                                         throws DeletedObjectException,
                                                NoSuchObjectException,
                                                JIAMOperationException

Adds one or more provisioning policies to this provisioning role. Any existing provisioning policies remain assigned to the role.

Parameters:

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

newProvisioningPolicies - An array of ProvisioningPolicy objects to assign to this provisioning role's collection.

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

NoSuchObjectException - If one of the provisioning policies specified does not exist

JIAMOperationException - If a JIAM operation resulting from adding policies failed.

removeProvisioningPolicies

java.util.Vector removeProvisioningPolicies(ProvisioningPolicy[] ProvisioningPolicies,
                                            java.lang.String operationID)
                                            throws DeletedObjectException,
                                                   NoSuchObjectException,
                                                   JIAMOperationException

Removes one or more provisioning policies from this provisioning role.

Note: If the specified provisioning policies include some policies that are associated with the role and other policies that are not, the associated provisioning policies will be removed successfully, and no exception will be thrown.

Parameters:

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

ProvisioningPolicies - An array of the ProvisioningPolicy objects to remove from this provisioning role's collection.

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

NoSuchObjectException - If one of the provisioning policies specified does not exist

JIAMOperationException - If a JIAM operation resulting from removing policies failed.

clearProvisioningPolicies

void clearProvisioningPolicies()
                               throws DeletedObjectException,
                                      JIAMOperationException

Deprecated. In r12.

Removes all the provisioning policies from this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from clearing all policies failed.

clearProvisioningPolicies

java.util.Vector clearProvisioningPolicies(java.lang.String operationID)
                                           throws DeletedObjectException,
                                                  JIAMOperationException

Removes all the provisioning policies from this provisioning role.

Returns:

JIAM Operation return message from admin server in case of a success.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

JIAMOperationException - If a JIAM operation resulting from clearing all policies failed.

modifyObject

java.util.Vector modifyObject(ProvisioningPolicy[] policiesToAssign,
                              ProvisioningPolicy[] policiesToUnassign,
                              java.lang.String operationID)
                              throws SmApiException

Specifies the complete set of provisioning policies to assign to this provisioning role, and immediately commits the assignments to the data store.

This method should only be used on ProvisioningRole objects retrieved through ProvisioningRoleProvider.

In addition to committing the specified policy assignments to the data store, this method commits any other changes that might have been made to the ProvisioningRole object.

The provisioning policies passed into this method represent the complete set of policies that will be currently assigned to this role. Any existing policy assignments will be removed. If you pass an empty array, the role will have no policy assignments.

To add one or more policies to the existing set of policies assigned to this role, without removing any of the existing policy assignments, call addProvisioningPolicies().

Note: This method immediately persists changes to the data store. All Identity Manager data and security checks are bypassed.

Parameters:

policiesToAssign - An array of the ProvisioningPolicy objects to assign to this provisioning role.

policiesToUnassign - An array of the ProvisioningPolicy objects to unassign from this provisioning role.

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

NoSessionException - If this object represents a Role that is not connected to a session (i.e. isConnected() would return false).

SmApiException

modifyObject

java.util.Vector modifyObject(ProvisioningRole[] newNestedRoles,
                              java.lang.String operationID)
                              throws SmApiException

Specifies one or more nested roles to associate with this provisioning role, and immediately commits the associations to the data store.

This method should only be used on ProvisioningRole objects retrieved through ProvisioningRoleProvider.

In addition to committing the specified nested role associations to the data store, this method commits any other changes that might have been made to the ProvisioningRole object.

Note: This method immediately persists changes to the data store. All Identity Manager data and security checks are bypassed.

Parameters:

newNestedRoles - An array of the ProvisioningRole objects to nest under this provisioning role.

operationID - Operation ID to be used for the JIAM commit operation. Ideally this should be derived from the IM eventID using ProvisioningDefinitionImpl.getIMOperationId() .

Returns:

JIAM message;

Throws:

DeletedObjectException - If this object represents a Role that has already been deleted

NoSessionException - If this object represents a Role that is not connected to a session (i.e. isConnected() would return false).

SmApiException

modifyObject

java.lang.Object modifyObject(java.util.Hashtable extraProps,
                              java.lang.String opId,
                              java.util.Vector returnMessage)
                              throws SmApiException

Throws:

SmApiException

modifyPolicyStoreRoleObject

java.lang.Object modifyPolicyStoreRoleObject()
                                             throws SmApiException

Creates or updates the policy store role object and all associated Identity Manager role policies.

Throws:

SmApiException - Occurs persisting the IM policy store object or the policies

exists

boolean exists()

Indicates whether the provisioning role exists in Identity Manager or whether it exists only as an eTrust Admin object.

Returns:

boolean true if the provisioning role exists in Identity Manager.

delete

void delete(boolean deletePSOnly,
            java.lang.String operationId)
            throws SmApiException

Delete the Provisioning Role. This method is primarly used to support Inbound Synchronization for the deletion of Provisioning Roles.

Parameters:

deletePSOnly - A boolean that indicates the disposition of the delete: true - delete the Provisioning role from the Policy Store ONLY! false - delete the Provisioning Role form the Policy store and from the Provisioning Server; that same as invoking (@link com.netegrity.llsdk6.imsapi.managedobject.ProvisioningRole#delete() delete()).

Throws:

SmApiException - Thorwn if any error encountered during the deletion of the Provisioning Role.

delete

java.util.Vector delete(java.lang.String operationId)
                        throws SmApiException

Delete provisioning role using the operation id.

Parameters:

operationId -

Returns:

The return message that the provisioning server sends is stored in this vector.

Throws:

SmApiException

getCustomFields

java.util.Vector[] getCustomFields()

Returns the provisioning role's custom attributes. Though the managed object _properties map holds the custom attributes, they are stored in the well known name "customfield". In order to get the data with its alias this map will provide that data.

Returns:

getNestedRoles

java.util.Vector getNestedRoles(boolean rolesonlywithimstubs,
                                boolean wantFullRoleChains)
                                throws JIAMOperationException

This method returns the nested roles for this object. If the flag is set, it will check the IM side for the stubs and return only those roles that have stubs. For returning all the roles, use getNestedRoles().

Parameters:

rolesonlywithimstubs -

Returns:

Nested Roles.

Throws:

SmApiException

JIAMOperationException

getAssignedResources

java.util.Vector getAssignedResources()

Returns a user who has been assigned a member but not yet persisted.

Returns:

Vector assignedResources

setAssignedResource

void setAssignedResource(User user)

Sets a user as assigned to role

Parameters:

User -

getRevokedResources

java.util.Vector getRevokedResources()

Returns a user who has been revoked as role member but not yet persisted.

Returns:

Vector assignedResources

setRevokedResource

void setRevokedResource(User user)

Sets a user revocation from a role

Parameters:

User -

getAssignedPolicies

java.util.Vector getAssignedPolicies()

setAssignedPolicy

void setAssignedPolicy(ProvisioningPolicy policy)

Sets a template on the role

Parameters:

User -

getRevokedPolicies

java.util.Vector getRevokedPolicies()

Returns template which has been assigned but not yet persisted.

Returns:

Vector assignedResources

setRevokedPolicy

void setRevokedPolicy(ProvisioningPolicy policy)

Sets a template on the role

Parameters:

User -