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

Interface RASPolicySetManager

All Superinterfaces:

EntityManager

public interface RASPolicySetManager
extends EntityManager

RASPolicySetManager, the entity manager for RASPolicySet object. Users can use the class to
1. Create RASPolicySet

2. Modify RASPolicySet

3. Delete RASPolicySet

4. Query RASPolicySets

Method Summary

Methods

Modifier and Type	Method and Description
RASPolicySetEntry	createRASPolicySet(java.lang.String name, java.lang.String displayName, java.lang.String description, java.util.List<RASPolicyEntry> policies) Creates RAS policy set
void	deleteRASPolicySet(java.lang.String name) Delete RAS policy set.
RASPolicySetEntry	getRASPolicySet(java.lang.String name) Gets RAS policy set by its name
java.util.List<RASPolicySetEntry>	getRASPolicySets(RASPolicySetSearchQuery rasPolicySetSearchQuery) Queries RAS policy set with the criteria
void	modifyRASPolicySet(RASPolicySetEntry rasPolicySetEntry) Persists a revised in-memory RASPolicySetEntry object.

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

resolveReference

Method Detail

createRASPolicySet

RASPolicySetEntry createRASPolicySet(java.lang.String name,
                                   java.lang.String displayName,
                                   java.lang.String description,
                                   java.util.List<RASPolicyEntry> policies)
                                     throws InvalidArgumentException,
                                            PolicyObjectAlreadyExistsException,
                                            PolicyObjectNotFoundException,
                                            PolicyStoreException

Creates RAS policy set

Parameters:

name - RAS policy set 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. Name for a data security policy set must additionally adhere to underlying database naming specifications.

displayName - RAS policy set display name, can be either a String value or null.

description - RAS policy set description, can be either a String value or null.

policies - a list of RAS policies as members of this RAS policy set, could not be null or empty

Returns:

a RASPolicySetEntry

Throws:

InvalidArgumentException - if the values passed in are invalid, throws out InvalidArgumentException, e.g. passing null value to one of name, rasPolicyTypeName, policies triggers the exception.

PolicyObjectAlreadyExistsException - if the same name policy set exists, throws out PolicyObjectAlreadyExistsException.

PolicyObjectNotFoundException - if the RAS policy set components used don't exist.

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

deleteRASPolicySet

void deleteRASPolicySet(java.lang.String name)
                        throws InvalidArgumentException,
                               PolicyObjectNotFoundException,
                               PolicyStoreException

Delete RAS policy set.

Parameters:

name - the name of RAS policy set to delete

Throws:

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

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

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

modifyRASPolicySet

void modifyRASPolicySet(RASPolicySetEntry rasPolicySetEntry)
                        throws InvalidArgumentException,
                               PolicyObjectNotFoundException,
                               PolicyStoreException

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

Parameters:

rasPolicySetEntry - a modified RAS policy set object

Throws:

InvalidArgumentException - if null is passed in or the policy set object lacks any of name, rasResourceTypeName and policies.

PolicyObjectNotFoundException - if the policy set doesn't exist in policy repository, or the RAS policy set components used don't exist.

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

getRASPolicySets

java.util.List<RASPolicySetEntry> getRASPolicySets(RASPolicySetSearchQuery rasPolicySetSearchQuery)
                                                   throws InvalidArgumentException,
                                                          PolicyStoreException

Queries RAS policy set with the criteria

Parameters:

rasPolicySetSearchQuery -

Returns:

a list of RASPolicySetEntry, return empty list if no matched policy set found

Throws:

InvalidArgumentException - if the query is null

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

getRASPolicySet

RASPolicySetEntry getRASPolicySet(java.lang.String name)
                                  throws InvalidArgumentException,
                                         PolicyObjectNotFoundException,
                                         PolicyStoreException

Gets RAS policy set by its name

Parameters:

name -

Returns:

the RAS policy set object with given RAS policy set name

Throws:

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

PolicyObjectNotFoundException - if the specified RAS policy set doesn't exist.

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