|
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 ResolutionEngine
A manager-type interface that answers questions about roles.
Method Summary | |
---|---|
oracle.iam.rm.resolution.impl.RoleMembership |
getActiveRoleMembers(Role role, java.util.Set<java.lang.String> userAttributeNames) Returns the set of users who are granted or assigned the role. |
java.util.Set<ObjectKey> |
getAllRolesForUser(SnapshotSession session, User user) Returns a Set of ObjectKeys of all the Roles a User has. |
java.util.List<java.lang.String> |
getKeyAttributes(Role role) Returns a List of key attributes for a role. |
Filter |
getRelativeRoleFilter(Role role, SnapshotObject relativeObject, SnapshotSession session) Returns a Filter that represents all persons who are role holders of a relative dynamic role, (Relative roles are also known as Approver roles. |
java.util.List<RoleGrant> |
getRoleGrants(SnapshotSession session, Role role) Returns a List of grants of the given role. |
Filter |
getRoleMemberFilter(Role role) Returns a Filter that represents all identities included in the members list of the specified role. |
UserRoleAssignment |
getUserRoleAssignment(SnapshotSession session, ObjectKey assigneeKey, Role role) Returns the UserRoleAssignment for a given Role and User's ObjectKey, or null if none is found. |
java.util.Set<UserRoleAssignment> |
getUserRoleAssignments(SnapshotSession session, Role role) Returns a Set of all the user role assignments for a given Role, or an empty set if none are found. |
java.util.Set<UserRoleAssignment> |
getUserRoleAssignments(SnapshotSession session, User assignee) Returns a Set of all the user role assignments for a given User, or an empty set if none are found. |
Filter |
getUserRoleFilter(SnapshotSession session, User user) Returns a Filter that represents all roles held by a person. |
java.util.Set<ObjectKey> |
getUsersAssignedRoles(SnapshotSession session, User user) Returns a Set of the ObjectKeys of the Roles assigned to a given user via the UserRoleAssignment cache (all complex roles). |
java.util.List<Role> |
getUsersBusinessAndITRoles(SnapshotSession session, User user) Returns a list of the specified user's business and IT roles |
java.util.List<BusinessRole> |
getUsersBusinessRoles(SnapshotSession session, User user) Returns a list of the specified user's business roles |
java.util.Set<ObjectKey> |
getUsersGrantedRoles(SnapshotSession session, User user) Returns a Set of the ObjectKeys of the Roles assigned to a given user via RoleGrants. |
boolean |
hasBusinessRole(User user, BusinessRole role, SnapshotSession session) Indicates whether the specified person has the specified business role. |
boolean |
hasITRole(User user, ITRole role, boolean includeMappedITRoles, SnapshotSession session) Indicates whether the specifed user has the specified IT role. |
boolean |
hasITRole(User user, ITRole role, SnapshotSession session) Indicates whether the specififed user has the specified IT role, either through a direct role grant or through business role mapping. |
boolean |
hasRelativeRole(User user, SnapshotObject relativeObject, Role relativeRole, SnapshotSession session) Indicates whether the specified user has a relative role with respect to some relative object. |
boolean |
hasRole(SnapshotSession session, User user, java.util.Set<Role> roleSet) returns true if the user has at least one of the roles in the set. |
boolean |
hasRole(User user, Role role) Indicates whether the specififed user is in the member list of the specified role. |
boolean |
hasRole(User user, Role role, SnapshotSession session) Indicates whether the specified person has the specified role. |
boolean |
hasSystemRole(User user, SystemRole role, SnapshotSession session) Indicates whether the specified user has the specified system role. |
boolean |
isComplexDynamicRole(Role role) Indicates whether the specified role is a complex dynamic role. |
boolean |
isDynamicRole(Role role) Indicates whether the specified role is a dynamic role. |
boolean |
isEligible(User user, Role role) Indicates whether the specified user is eligible to be granted the specified system role. |
boolean |
isEligible(User user, Role role, SnapshotSession session) Indicates whether the specified person is eligible to be a grantee of a role. |
java.util.List<SnapshotObject> |
resolve(Role role) Returns a Set of ObjectKey instances that refer to the holders of a specified role. |
oracle.iam.rm.common.PaginatedResultSet<SnapshotObject> |
resolveRoleMembers(Role role, SnapshotSession session) Resolves a Role producing a PaginatedResultSet that contains the role members. |
oracle.iam.rm.i18n.Formattable |
validateEligibilityRule(java.lang.String rule) Validates a provided role eligibility rule. |
oracle.iam.rm.i18n.Formattable |
validateMembershipRule(java.lang.String rule) Validates a provided role membership rule. |
Method Detail |
---|
boolean isDynamicRole(Role role)
role
- any Role typetrue
if the role is a dynamic role, otherwise false
.boolean isComplexDynamicRole(Role role)
role
- any Role typetrue
if the role is a complex dynamic role, otherwise false
.java.util.List<java.lang.String> getKeyAttributes(Role role)
List
of key attributes for a role. Key attributes are attributes that are referenced in the attribute expressions of the role's membership rule.role
- a simple dynamic roleList
of attribute ID strings.java.util.List<BusinessRole> getUsersBusinessRoles(SnapshotSession session, User user)
user
- The user whose business roles are to be returned.session
- current SnapshotSessionjava.util.List<Role> getUsersBusinessAndITRoles(SnapshotSession session, User user)
user
- The user whose business and IT roles are to be returned.session
- current SnapshotSessionboolean hasRole(User user, Role role)
true
if the person has the role. Uses the default SnapshotSession.user
- identity to checkrole
- Role type to checktrue
if the role member list contains the specified user, otherwise false
.boolean hasRole(User user, Role role, SnapshotSession session)
user
- identity to checkrole
- role to checksession
- current SnapshotSessiontrue
if the role member list contains the specified user, otherwise false
.boolean hasRole(SnapshotSession session, User user, java.util.Set<Role> roleSet)
session
- the current SnapshotSessionuser
- The user who potentially has one of the rolesroleSet
- The set of roles to be tested forboolean hasBusinessRole(User user, BusinessRole role, SnapshotSession session)
user
- identity to checkrole
- business role to checksession
- current SnapshotSessiontrue
false.boolean hasITRole(User user, ITRole role, SnapshotSession session)
user
- any identity to checkrole
- IT role to checksession
- current SnapshotSessiontrue
if the role member list contains the specified user, otherwise false
.boolean hasITRole(User user, ITRole role, boolean includeMappedITRoles, SnapshotSession session)
user
- any identity to checkrole
- IT role to checkincludeMappedITRoles
- if true, search includes mapped IT roles.session
- current SnapshotSessiontrue
if the role member list contains the specified user, otherwise false
.boolean hasRelativeRole(User user, SnapshotObject relativeObject, Role relativeRole, SnapshotSession session)
user
- the subjectrelativeObject
- the relative objectrelativeRole
- a relative rolesession
- current SnapshotSessiontrue
if the user has the relative role, otherwise false
.boolean hasSystemRole(User user, SystemRole role, SnapshotSession session)
user
- User (abstractIdentity) who might have the rolerole
- system rolesession
- current SnapshotSessiontrue
if the role member list contains the user, otherwise false
.boolean isEligible(User user, Role role)
user
- any identity to checkrole
- system role to checktrue
if the user is eligible, otherwise false
.boolean isEligible(User user, Role role, SnapshotSession session)
user
- User (abstractIdentity) who might be the role holder.role
- system rolesession
- current SnapshotSessiontrue
if the user is eligible, otherwise false
.Filter getRoleMemberFilter(Role role)
Filter
that represents all identities included in the members list of the specified role. The filter can be used alone or combined with other filters in a query.role
- any Role typeFilter
that represents the resolved role results.Filter getRelativeRoleFilter(Role role, SnapshotObject relativeObject, SnapshotSession session)
role
- a relative dynamic rolerelativeObject
- the relative objectsession
- current SnapshotSessionoracle.iam.rm.common.PaginatedResultSet<SnapshotObject> resolveRoleMembers(Role role, SnapshotSession session)
role
- any role typesession
- current SnapshotSessionFilter getUserRoleFilter(SnapshotSession session, User user)
session
- current SnapshotSessionuser
- an existing useroracle.iam.rm.resolution.impl.RoleMembership getActiveRoleMembers(Role role, java.util.Set<java.lang.String> userAttributeNames)
role
- Role for which to get membershipsuserAttributeNames
- names of user attributes to be returned with each memberjava.util.Set<ObjectKey> getAllRolesForUser(SnapshotSession session, User user)
session
- SnapshotSessionuser
- User whose roles are to be returnedjava.util.List<RoleGrant> getRoleGrants(SnapshotSession session, Role role)
session
- SnapshotSessionrole
- the whose grants will be returnedjava.util.Set<UserRoleAssignment> getUserRoleAssignments(SnapshotSession session, User assignee)
session
- SnapshotSessionassignee
- User whose user role assignments to returnjava.util.Set<UserRoleAssignment> getUserRoleAssignments(SnapshotSession session, Role role)
session
- SnapshotSessionrole
- Role whose user role assignments to return.UserRoleAssignment getUserRoleAssignment(SnapshotSession session, ObjectKey assigneeKey, Role role)
session
- SnapshotSessionrole
- Role of the user role assignment to returnassigneeKey
- ObjectKey of the User of the user role assignment to returnjava.util.Set<ObjectKey> getUsersAssignedRoles(SnapshotSession session, User user)
session
- SnapshotSessionuser
- User whose assigned roles to returnjava.util.Set<ObjectKey> getUsersGrantedRoles(SnapshotSession session, User user)
session
- SnapshotSessionuser
- User whose granted roles to returnjava.util.List<SnapshotObject> resolve(Role role)
role
- a Roleoracle.iam.rm.i18n.Formattable validateEligibilityRule(java.lang.String rule)
rule
- the rule to validate.Formattable
object representing a problem in the rule or null
if the rule is valid.oracle.iam.rm.i18n.Formattable validateMembershipRule(java.lang.String rule)
rule
- the rule to validate.Formattable
object representing a problem in the rule or null
if the rule is valid.
|
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 |