|
Oracle Role Manager Java API Reference 10g (10.1.4) E12031-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InteractiveRoleManager
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, removeDataChangeListener |
Methods inherited from interface oracle.iam.rm.inherent.role.RoleManager |
---|
findBusinessRoles, findITRoles, 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 |
---|
Role createRole(java.lang.String roleType, java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) throws TemporalException
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
.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.BusinessRole createBusinessRole(java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) throws TemporalException
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
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.void setMembershipRule(Role role, java.lang.String membershipRuleXML) throws TemporalException
role
- existing BusinessRole instancemembershipRuleXML
- String containing a predicate XML elementTemporalException
- 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.void setEligibilityRule(Role role, java.lang.String eligibilityRuleXML) throws TemporalException
role
- existing ITRole or static BusinessRole instanceeligibilityRuleXML
- String containing a predicate XML elementTemporalException
- 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.Role getEditableRole(ObjectKey objectKey) throws TemporalException
Role
based on its object key.objectKey
- key identifying the Role
to editRole
TemporalException
- if a problem occurs retrieving the Role
.ITRole createITRole(java.lang.String displayName, java.lang.String membershipRuleXML, java.lang.String status) throws TemporalException
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
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.RoleGrant grantRole(Role role, User grantee, ResolutionEngine resolutionEngine) throws EligibilityRuleException
role
- static role of any typegrantee
- User instanceresolutionEngine
- ResolutionEngine instance, for determining eligibilityTemporalException
- if there was an error creating the role grantEligibilityRuleException
- if the grantee is not eligible for the roleRoleMapping createRoleMapping(BusinessRole businessRole, ITRole itRole) throws TemporalException
businessRole
- BusinessRole to mapitRole
- ITRole to mapRoleMapping
objectTemporalException
- if there was an error creating the role mappingvoid assignRoleOwner(Role role, Person owner) throws TemporalException
role
- role to which to assign an ownerowner
- person to assign as the role ownerTemporalException
- if there was an error assigning the role ownerSystemRole createSystemRole(java.lang.String displayName, java.lang.String status) throws TemporalException
displayName
- display name for the rolestatus
- status of the role, either active
or inactive
TemporalException
- if a problem occurs creating the SystemRole
.Approver createApprover(java.lang.String displayName, java.lang.String membershipRule, java.lang.String status) throws TemporalException
displayName
- display name for the rolemembershipRule
- membership rule XML, roleType, either dynamic
if provided, or static
status
- status of the role, either active
or inactive
TemporalException
- if a problem occurs creating the ApproverRole
.void setRoleSOCHierarchy(Role role, java.lang.String socHierarchy, TemporalEngine temporalEngine) throws TemporalException
role
- any role instancesocHierarchy
- String containing the name of a hierararchytemporalEngine
- TemporalEngine instance, required for getting the hierarchy root keyTemporalException
- if there is an error, such as the specified hierarchy does not existSnapshotObject setGrantSOCBinding(RoleGrant roleGrant, SnapshotObject objectInHierarchy)
roleGrant
- RoleGrant to bind to SOCobjectInHierarchy
- SnapshotObject in a hierarchy defining the SOCTemporalException
- if there was an error creating the grant-SOC binding
|
Oracle Role Manager Java API Reference 10g (10.1.4) E12031-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |