oracle.security.jps.service.policystore.entitymanager.ras

Interface RASPolicyRuleManager

All Superinterfaces:

EntityManager

public interface RASPolicyRuleManager
extends EntityManager

Method Summary

Methods

Modifier and Type	Method and Description
RASPolicyRuleEntry	createRASPolicyRule(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String principalName, RASPolicyRuleEntry.PrincipalType principalType, java.util.Set<java.lang.String> privileges, PolicyRuleEntry.EffectType effect, java.util.Date startDate, java.util.Date endDate, boolean invert) Creates RAS policy rule.
void	deleteRASPolicyRule(java.lang.String name, boolean cascading) Deletes the policy rule.
RASPolicyRuleEntry	getRASPolicyRule(java.lang.String name) Returns the RAS policy rule by its name.
java.util.List<RASPolicyRuleEntry>	getRASPolicyRules(RASPolicyRuleSearchQuery rasPolicyRuleSearchQuery) Queries RAS policy rules.
void	modifyRASPolicyRule(RASPolicyRuleEntry rasPolicyRuleEntry) Modifies RAS policy rule.

Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager

resolveReference

Method Detail

createRASPolicyRule

RASPolicyRuleEntry createRASPolicyRule(java.lang.String name,
                                     java.lang.String displayName,
                                     java.lang.String description,
                                     java.lang.String principalName,
                                     RASPolicyRuleEntry.PrincipalType principalType,
                                     java.util.Set<java.lang.String> privileges,
                                     PolicyRuleEntry.EffectType effect,
                                     java.util.Date startDate,
                                     java.util.Date endDate,
                                     boolean invert)
                                       throws PolicyStoreException

Creates RAS policy rule.

Parameters:

name - the name of the rule. The parameter should not be null, otherwise, throw out an InvalidArgumentException.

displayName - the display name of the rule. The parameter can be either a String value or null.

description - the description of the rule. The parameter can be either a String value or null.

principalName - target for RAS policy rule. NOTE, if the principalType is external, the principalName should use GUID.

principalType - principal type of RAS policy rule

privileges - privileges used in RAS policy Rule

effect - the effect can be GRANT or DENY.

startDate - a time point from which this rule takes effect.

endDate - a time point at which this rule expires.

invert - flag specifying whether this rule is inverted for the principal or not. That is, when invert is true, this RAS policy rule is applicable ONLY when the subject has NO such principal specified by <principalName>

Returns:

a RASPolicyRuleEntry.

Throws:

PolicyStoreException - if any internal status error, throws out PolicyStoreException.

deleteRASPolicyRule

void deleteRASPolicyRule(java.lang.String name,
                       boolean cascading)
                         throws PolicyObjectNotFoundException,
                                PolicyStoreException

Deletes the policy rule.

• If cascading flag is set to false and the RAS policy rule is referred by any RAS policies, throw out a PolicyStoreOperationNotAllowedException.
• If cascading flag is set to false and the RAS policy rule is not referred by any RAS policies, deletes the rule.
• If cascading flag is set to true and the RAS policy rule is referred by any RAS policies, delete the reference in these RAS policies, furthermore, if the referring RAS policies contain only one RAS policy rule reference (no other RAS policy rules are referred), delete referring RAS policies too.

Parameters:

name - the name of the rule.

cascade - cascading flag.

Throws:

InvalidArgumentException - if null/empty name passed in, throws out InvalidArgumentException.

PolicyObjectNotFoundException - if the RAS policy rule specified by name doesn't exist, throws out PolicyObjectNotFoundException.

PolicyStoreOperationNotAllowedException - if the cascading flag is set to false and the RAS policy rule is referred by other RAS policies, throw out a PolicyStoreOperationNotAllowedException

PolicyStoreException - if any internal status error, throws out PolicyStoreException.

modifyRASPolicyRule

void modifyRASPolicyRule(RASPolicyRuleEntry rasPolicyRuleEntry)
                         throws PolicyStoreException

Modifies RAS policy rule.

Parameters:

rasPolicyRuleEntry - the RAS policy rule entry, please refer to RASPolicyRuleEntry for details.

Throws:

PolicyStoreException.

PolicyStoreException

getRASPolicyRules

java.util.List<RASPolicyRuleEntry> getRASPolicyRules(RASPolicyRuleSearchQuery rasPolicyRuleSearchQuery)
                                                     throws PolicyStoreException

Queries RAS policy rules.

Only RAS policy rules created using the createRASPolicyRule API are returned.

Parameters:

rasPolicyRuleSearchQuery - search criteria, please refer to RASPolicyRuleSearchQuery for details.

Returns:

a list of RASPolicyRuleEntry, return empty list if no matched RAS policy rule found.

Throws:

PolicyStoreException.

PolicyStoreException

getRASPolicyRule

RASPolicyRuleEntry getRASPolicyRule(java.lang.String name)
                                    throws PolicyObjectNotFoundException,
                                           PolicyStoreException

Returns the RAS policy rule by its name.

Parameters:

name - the name of the rule.

Returns:

the RAS policy rule object with given RAS policy rule name.

Throws:

PolicyStoreException.

PolicyObjectNotFoundException

PolicyStoreException