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

Interface RASPolicyManager

All Superinterfaces:

EntityManager

public interface RASPolicyManager
extends EntityManager

Method Summary

Methods

Modifier and Type	Method and Description
RASPolicyEntry	createRASPolicy(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<RASResourceEntry> target, java.util.List<java.lang.String> referredRules, java.util.Set<RASPolicyEntry.RASParameterValue> parameterValues, RASPolicyEntry.ACLMatchType matchType, boolean isStatic) Create a RAS Policy
void	deleteRASPolicy(java.lang.String name, boolean cascading) Deletes a RAS policy with the given name
java.util.List<RASPolicyEntry>	getRASPolicies(RASPolicySearchQuery rasPolicySearchQuery) Gets all RAS policies which satisfy the query
RASPolicyEntry	getRASPolicy(java.lang.String name) Gets RAS policy by its name
void	modifyRASPolicy(RASPolicyEntry rasPolicyEntry) Persists a revised in-memory RASPolicyEntry object.

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

resolveReference

Method Detail

createRASPolicy

RASPolicyEntry createRASPolicy(java.lang.String name,
                             java.lang.String displayName,
                             java.lang.String description,
                             java.util.List<RASResourceEntry> target,
                             java.util.List<java.lang.String> referredRules,
                             java.util.Set<RASPolicyEntry.RASParameterValue> parameterValues,
                             RASPolicyEntry.ACLMatchType matchType,
                             boolean isStatic)
                               throws InvalidArgumentException,
                                      PolicyObjectAlreadyExistsException,
                                      PolicyObjectNotFoundException,
                                      PolicyStoreException

Create a RAS Policy

Parameters:

name - the name of RAS Policy, the parameter should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.

displayName - the display name of RAS Policy

description - the description of RAS Policy

target - should be a target list only contains RASResourceEntry info

referredRules - a list of RAS policyRules

parameterValues - a collection of ParameterValues

matchType - the ACL match type

isStatic - flag specifying whether the RAS policy is for static realm constraint

Returns:

RASPolicyEntry a RAS policy as a RASPolicyEntry

Throws:

InvalidArgumentException

PolicyObjectAlreadyExistsException

PolicyObjectNotFoundException

PolicyStoreException

deleteRASPolicy

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

Deletes a RAS policy with the given name

Parameters:

name - the name of the RAS policy to be removed, the parameter should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.

cascading - deletion flag, if the flag is set to false and the RAS Policy is referred by a RAS PolicySet, throws out PolicyStoreOperationNotAllowedException. If the flag is set to true and the RAS Policy is referred by a RAS PolicySet, delete the RAS Policy as well as the reference in that RAS PolicySet. If the particular RAS PolicySet has only one RAS Policy reference, delete the RAS PolicySet too.

Throws:

InvalidArgumentException - if an invalid value is passed in, throws out InvalidArgumentException.

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

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

modifyRASPolicy

void modifyRASPolicy(RASPolicyEntry rasPolicyEntry)
                     throws InvalidArgumentException,
                            PolicyObjectNotFoundException,
                            PolicyStoreException

Persists a revised in-memory RASPolicyEntry object. In order to change a RAS policy, you have to apply the changes on an in-memory object, and then pass the object to the method.

Parameters:

rasPolicyEntry - a modified RAS policy object

Throws:

InvalidArgumentException - if null is passed in or the RAS policy object lacks any of name, RAS policy rule, target.

PolicyObjectNotFoundException - if the RAS policy doesn't exist in policy repository, or the RAS policy components used don't exist, including target and RAS policy rule.

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

getRASPolicies

java.util.List<RASPolicyEntry> getRASPolicies(RASPolicySearchQuery rasPolicySearchQuery)
                                              throws PolicyStoreException

Gets all RAS policies which satisfy the query

Parameters:

rasPolicySearchQuery - the query object which contains query criteria. The value should not be null.

Returns:

a list of RAS policies which match the query criteria, if nothing found, return an empty list.

Throws:

InvalidArgumentException - the exception is reserved for future use.

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

getRASPolicy

RASPolicyEntry getRASPolicy(java.lang.String name)
                            throws PolicyObjectNotFoundException,
                                   PolicyStoreException

Gets RAS policy by its name

Parameters:

name - RAS policy name, the parameter should not be null or empty string. A qualified name should start with a letter or underscore and consist of letter, digit and underscore.

Returns:

the matched RAS policy with the given name

Throws:

InvalidArgumentException - if an invalid value is passed in, throws out InvalidArgumentException.

PolicyObjectNotFoundException - if the specified policy doesn't exist.

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