|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RolePolicyEntry
An in-memory representation of a RolePolicy. A RolePolicy provides the ability to define a security policy to determine if a user or group is granted an Application Role on an optional Requested Resource.
Method Summary | |
---|---|
void |
addAppRole(AppRoleEntry appRole) Add an application role to the policy |
void |
addPrincipal(PrincipalEntry principalEntry) Add a principal entry to the role policy. |
void |
addResource(ResourceEntry resource) Add a resource to the Policy. |
void |
addResourceNameExpression(ResourceNameExpression resNameExpr) Add a resource name expression to the policy. |
void |
addRule(PolicyRuleEntry rule) Add a rule to the policy. |
void |
deleteAppRole(AppRoleEntry appRole) Removes an application role from the policy. |
void |
deletePrincipal(PrincipalEntry principalEntry) Remove a principal from the role policy. |
void |
deleteResource(ResourceEntry resource) Remove a resource from the policy. |
void |
deleteResourceNameExpression(ResourceNameExpression resNameExpr) Remove a resource Name expression from the policy. |
void |
deleteRule(java.lang.String ruleName) Remove a role from the policy. |
java.util.Set<AppRoleEntry> |
getAppRoleEntries() Returns Application Roles associated with the Role Policy. |
java.lang.String |
getDescription() Returns the description. |
java.lang.String |
getDisplayName() Returns the display name. |
java.util.List<PrincipalEntry> |
getPrincipals() Returns a list of PrincipalEntry mapped to the ApplicationRoles. |
java.util.List<ResourceNameExpression> |
getResourceNameExpressions() Returns a list resource expressions protected by the policy. |
java.util.List<ResourceEntry> |
getResourceNames() Returns a list of resources protected by the policy. |
java.util.List<PolicyRuleEntry> |
getRules() Get a List of policy rules. |
void |
setDescription(java.lang.String description) Set the description. |
void |
setDisplayName(java.lang.String displayName) Set the display name. |
Method Detail |
---|
java.lang.String getDisplayName()
java.lang.String getDescription()
java.util.Set<AppRoleEntry> getAppRoleEntries() throws PolicyStoreException
PolicyStoreException
- if an error occurs while retrieving the policy definition.java.util.List<PrincipalEntry> getPrincipals() throws PolicyStoreException
PrincipalEntry
mapped to the ApplicationRoles. Returns an empty list if there is no mapping. The returned List is backed by this RolePolicyEntry's internal private principal List. Any modification to the returned List affects the internal private List as well.PolicyStoreException
- if an error occurs while retrieving the policy definition.java.util.List<ResourceEntry> getResourceNames() throws PolicyStoreException
PolicyStoreException
- if an error occurs while retrieving the policy definition.java.util.List<ResourceNameExpression> getResourceNameExpressions() throws PolicyStoreException
PolicyStoreException
- if an error occurs while retrieving the policy definition.java.util.List<PolicyRuleEntry> getRules() throws PolicyStoreException
PolicyStoreException
- if an error occurs while retrieving the rules.void addRule(PolicyRuleEntry rule) throws PolicyStoreException
rule
- to addPolicyStoreException
- if the rule is already part of the policy, or if an attempt is made to define 2 or more rules.void deleteRule(java.lang.String ruleName) throws PolicyStoreException
ruleName
- to delete.PolicyStoreException
- if the ruleName does not exist in the current policy.void setDisplayName(java.lang.String displayName)
void setDescription(java.lang.String description)
void addPrincipal(PrincipalEntry principalEntry) throws PolicyStoreException
principalEntry
- to add to the policyPolicyStoreException
- if principal is already a member of the policy.void deletePrincipal(PrincipalEntry principalEntry) throws PolicyStoreException
principalEntry
- to removePolicyStoreException
- if the principal is not a member of the policy.void addAppRole(AppRoleEntry appRole) throws PolicyStoreException
appRole
- to add to the policyPolicyStoreException
- if the application role is already defined in the policy.void deleteAppRole(AppRoleEntry appRole) throws PolicyStoreException
appRole
- to remove the policy.PolicyStoreException
- if application role is not defined in the policy.void addResource(ResourceEntry resource) throws PolicyStoreException
resource
- to add to the policy.PolicyStoreException
- if the resource is already defined in the policy.void deleteResource(ResourceEntry resource) throws PolicyStoreException
resource
- to remove from the policy.PolicyStoreException
- if the resource is not part of the policy.void addResourceNameExpression(ResourceNameExpression resNameExpr) throws PolicyStoreException
resNameExpr
- to add to the policy.PolicyStoreException
- if the resource name expression is already defined in the policy.void deleteResourceNameExpression(ResourceNameExpression resNameExpr) throws PolicyStoreException
resNameExpr
- to remove from the policy.PolicyStoreException
- if the resource name expression is not defined in the policy.
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |