Skip navigation links

oracle.iam.rm.inherent.role
Interface InteractiveRoleManager

All Superinterfaces:

InteractiveSession, InteractiveSnapshotSession, RoleManager, SnapshotSession

public interface InteractiveRoleManager

extends InteractiveSnapshotSession, RoleManager

A read/write interface to do management of roles from the database.

Method Summary

void	assignRoleOwner(Role role, Person owner) Set the role's owner.
Approver	createApprover(java.lang.String displayName, java.lang.String membershipRule, java.lang.String status) Creates an ApproverRole.
BusinessRole	createBusinessRole(java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) Creates a new business role.
ITRole	createITRole(java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) Creates a new IT role.
Role	createRole(java.lang.String roleType, java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) Creates a new role of the type specified.
RoleMapping	createRoleMapping(BusinessRole businessRole, ITRole itRole) Maps the specified BusinessRole to the specified ITRole.
SystemRole	createSystemRole(java.lang.String displayName, java.lang.String status) Creates a SystemRole.
Role	getEditableRole(ObjectKey objectKey) Gets the editable version of a Role based on its object key.
RoleGrant	grantRole(Role role, User grantee, ResolutionEngine resolutionEngine) Creates a static role grant.
void	setEligibilityRule(Role role, java.lang.String eligibilityRuleXML) Sets the eligibility rule.
SnapshotObject	setGrantSOCBinding(RoleGrant roleGrant, SnapshotObject objectInHierarchy) Creates a grant-SOC binding.
void	setMembershipRule(Role role, java.lang.String membershipRuleXML) Sets the membership rule.
void	setRoleSOCHierarchy(Role role, java.lang.String socHierarchy, TemporalEngine temporalEngine) Sets the role's SOC hierarchy to the specified hierarchy.

Methods inherited from interface oracle.iam.rm.temporal.InteractiveSnapshotSession

addMixinType, createObject, getEditableSnapshotObject

Methods inherited from interface oracle.iam.rm.temporal.SnapshotSession

canEdit, findObjectKeys, findSnapshotObjects, getObjectType, getObjectType, getSnapshotObject, getTemporalEngine

Methods inherited from interface oracle.iam.rm.temporal.InteractiveSession

addDataChangeListener, getBusinessTransactionID, getChangedObjectTypes, removeDataChangeListener

Methods inherited from interface oracle.iam.rm.inherent.role.RoleManager

findBusinessRoles, findITRoles, findMappedITPrivileges, findMappedITRoles, findRoleOwner, getBusinessRole, getGrantCount, getGrantSOCBindings, getITRole, getRoleGrant, getSocHierarchyType, hasGrantSOCBinding

Methods inherited from interface oracle.iam.rm.temporal.SnapshotSession

canEdit, findObjectKeys, findSnapshotObjects, getObjectType, getObjectType, getSnapshotObject, getTemporalEngine

Method Detail

createRole

Role createRole(java.lang.String roleType,
                java.lang.String displayName,
                java.lang.String membershipRuleXML,
                java.lang.String status)
                throws TemporalException

Creates a new role of the type specified.

Parameters:

roleType - string representing type of the role. Must not be null and must be of a known role type.

displayName - user-friendly name of the role. Must not be null.

membershipRuleXML - optional string containing the membership rule in XML format.

status - string representing status of the role, either active or inactive.

Returns:

A new Role instance.

Throws:

TemporalException - if there was an error creating the object or parsing the XML rule. You can query the underlying cause by calling the Throwable.getCause() method.

createBusinessRole

BusinessRole createBusinessRole(java.lang.String displayName,
                                java.lang.String membershipRuleXML,
                                java.lang.String status)
                                throws TemporalException

Creates a new business role.

Parameters:

displayName - user-friendly name of the role. Must not be null.

membershipRuleXML - optional string containing the membership rule in XML format.

status - status of the role, either active or inactive

Returns:

A new BusinessRole

Throws:

TemporalException - if there was an error creating the object or parsing the XML rule. You can query the underlying cause by calling the Throwable.getCause() method.

setMembershipRule

void setMembershipRule(Role role,
                       java.lang.String membershipRuleXML)
                       throws TemporalException

Sets the membership rule. The membership rule is an XML string that contains a predicate element.

Parameters:

role - existing BusinessRole instance

membershipRuleXML - String containing a predicate XML element

Throws:

TemporalException - if there was an error creating the object or parsing the XML rule. You can query the underlying cause by calling the Throwable.getCause() method.

setEligibilityRule

void setEligibilityRule(Role role,
                        java.lang.String eligibilityRuleXML)
                        throws TemporalException

Sets the eligibility rule. The eligibility rule is an XML string that contains a predicate element.

Parameters:

role - existing ITRole or static BusinessRole instance

eligibilityRuleXML - String containing a predicate XML element

Throws:

TemporalException - if there was an error creating the object or parsing the XML rule. You can query the underlying cause by calling the Throwable.getCause() method.

getEditableRole

Role getEditableRole(ObjectKey objectKey)
                     throws TemporalException

Gets the editable version of a Role based on its object key.

Parameters:

objectKey - key identifying the Role to edit

Returns:

The editable version of a Role

Throws:

TemporalException - if a problem occurs retrieving the Role.

createITRole

ITRole createITRole(java.lang.String displayName,
                    java.lang.String membershipRuleXML,
                    java.lang.String status)
                    throws TemporalException

Creates a new IT role.

Parameters:

displayName - user-friendly name of the role. Must not be null.

membershipRuleXML - optional string containing the membership rule in XML format.

status - status for the role, either active or inactive

Returns:

A new ITRole instance

Throws:

TemporalException - if there was an error creating the object or parsing the XML rule. You can query the underlying cause by calling the Throwable.getCause() method.

grantRole

RoleGrant grantRole(Role role,
                    User grantee,
                    ResolutionEngine resolutionEngine)
                    throws EligibilityRuleException

Creates a static role grant.

Parameters:

role - static role of any type

grantee - User instance

resolutionEngine - ResolutionEngine instance, for determining eligibility

Returns:

A new RoleGrant instance

Throws:

TemporalException - if there was an error creating the role grant

EligibilityRuleException - if the grantee is not eligible for the role

createRoleMapping

RoleMapping createRoleMapping(BusinessRole businessRole,
                              ITRole itRole)
                              throws TemporalException

Maps the specified BusinessRole to the specified ITRole.

Parameters:

businessRole - BusinessRole to map

itRole - ITRole to map

Returns:

New RoleMapping object

Throws:

TemporalException - if there was an error creating the role mapping

assignRoleOwner

void assignRoleOwner(Role role,
                     Person owner)
                     throws TemporalException

Set the role's owner.

Parameters:

role - role to which to assign an owner

owner - person to assign as the role owner

Throws:

TemporalException - if there was an error assigning the role owner

createSystemRole

SystemRole createSystemRole(java.lang.String displayName,
                            java.lang.String status)
                            throws TemporalException

Creates a SystemRole.

Parameters:

displayName - display name for the role

status - status of the role, either active or inactive

Returns:

The newly created SystemRole instance.

Throws:

TemporalException - if a problem occurs creating the SystemRole.

createApprover

Approver createApprover(java.lang.String displayName,
                        java.lang.String membershipRule,
                        java.lang.String status)
                        throws TemporalException

Creates an ApproverRole.

Parameters:

displayName - display name for the role

membershipRule - membership rule XML, roleType, either dynamic if provided, or static

status - status of the role, either active or inactive

Returns:

The newly created ApproverRole instance

Throws:

TemporalException - if a problem occurs creating the ApproverRole.

setRoleSOCHierarchy

void setRoleSOCHierarchy(Role role,
                         java.lang.String socHierarchy,
                         TemporalEngine temporalEngine)
                         throws TemporalException

Sets the role's SOC hierarchy to the specified hierarchy.

Parameters:

role - any role instance

socHierarchy - String containing the name of a hierararchy

temporalEngine - TemporalEngine instance, required for getting the hierarchy root key

Throws:

TemporalException - if there is an error, such as the specified hierarchy does not exist

setGrantSOCBinding

SnapshotObject setGrantSOCBinding(RoleGrant roleGrant,
                                  SnapshotObject objectInHierarchy)

Creates a grant-SOC binding. Throws an exception if the RoleGrant Role does not specify an SOC hierarchy. Also throws an exception if the given SnapshotObject is not in the hierarchy referenced by the RoleGrant Role.

Parameters:

roleGrant - RoleGrant to bind to SOC

objectInHierarchy - SnapshotObject in a hierarchy defining the SOC

Returns:

A new RoleGrant to hiearchy node SOC binding

Throws:

TemporalException - if there was an error creating the grant-SOC binding

Skip navigation links