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

Interface RASAttributeCollectionManager

All Superinterfaces:

EntityManager

public interface RASAttributeCollectionManager
extends EntityManager

An entity manager that creates, reads, updates and modifies a RAS AttributeCollection

Method Summary

Methods

Modifier and Type	Method and Description
RASAttributeCollectionEntry	createRASAttributeCollection(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String handlerSchemaName, java.lang.String handlerPackageName, java.lang.String handlerFunctionName, java.util.List<RASAttributeEntry> attrList, java.util.List<java.lang.String> policyRuleRefs) Creates a new RAS attribute collection with given parameters.
void	deleteRASAttributeCollection(java.lang.String name) Deletes the RAS attribute collection with the given name.
RASAttributeCollectionEntry	getRASAttributeCollection(java.lang.String name) Get the RAS attribute collection entry with the given name.
java.util.List<RASAttributeCollectionEntry>	getRASAttributeCollections(RASAttributeCollectionSearchQuery query) Gets all the RAS attribute collections satisfying the query in the current scope (system/ application).
void	modifyRASAttributeCollection(RASAttributeCollectionEntry item) Modifies the RAS attribute collection from the given RAS attributeCollection entry.

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

resolveReference

Method Detail

createRASAttributeCollection

RASAttributeCollectionEntry createRASAttributeCollection(java.lang.String name,
                                                       java.lang.String displayName,
                                                       java.lang.String description,
                                                       java.lang.String handlerSchemaName,
                                                       java.lang.String handlerPackageName,
                                                       java.lang.String handlerFunctionName,
                                                       java.util.List<RASAttributeEntry> attrList,
                                                       java.util.List<java.lang.String> policyRuleRefs)
                                                         throws InvalidArgumentException,
                                                                PolicyStoreException,
                                                                PolicyObjectAlreadyExistsException

Creates a new RAS attribute collection with given parameters.

The attributes in the collection must be of category DYNAMIC. If the definition of an attribute does not exist with ExtensionManager, one is created.

Parameters:

name - the RAS attribute collection name, the name should not be null or empty string. Name must adhere to underlying database naming specifications.

displayName - a RAS attribute collection name used to show more information, it is optional and can be set to null.

description - a text message to describe the RAS attribute collection, it is optional and can be set to null.

handlerSchemaName - schema name for the handler function, it is optional and can be set to null. If non-null, handlerPackageName and handlerFunctionName must also be non-null.

handlerPackageName - package name for the handler function, it is optional and can be set to null. If non-null, handlerSchemaName and handlerFunctionName must also be non-null.

handlerFunctionName - name of the handler function, it is optional and can be set to null. If non-null, handlerSchemaName and handlerPackageName must also be non-null.

attrList - list of attributes to add in the attribute collection, it is optional and can be set to null. All attributes in the list must be of category DYNAMIC. If the attribute definition does not exist with ExtensionManager, one is created.

policyRuleRefs - list of the name of the policy rules protecting operations on this RAS AttributeCollection. If null, a default acl is assigned by the underlying database. Can only be set at creation time.

Returns:

the newly created attribute collection.

Throws:

InvalidArgumentException - if an invalid value is passed in.

PolicyStoreException - if any internal status error.

PolicyObjectAlreadyExistsException - if the attribute collection already exists and if attribute in collection has different definition than one in the policy store.

getRASAttributeCollections

java.util.List<RASAttributeCollectionEntry> getRASAttributeCollections(RASAttributeCollectionSearchQuery query)
                                                                       throws PolicyStoreException

Gets all the RAS attribute collections satisfying the query in the current scope (system/ application). To get all attribute collections defined in the scope, set matcher to ANY and value to match to null.

Parameters:

query - Query to be applied. Cannot be null.

Returns:

List of RAS attribute collection entries. If no RAS attribute collections match the query, returns an empty list.

Throws:

PolicyStoreException - in case of any errors in interaction with backend data store.

getRASAttributeCollection

RASAttributeCollectionEntry getRASAttributeCollection(java.lang.String name)
                                                      throws InvalidArgumentException,
                                                             PolicyObjectNotFoundException,
                                                             PolicyStoreException

Get the RAS attribute collection entry with the given name.

Parameters:

name - name of the RAS attribute collection to be fetched. the name should not be null or empty string. Name must adhere to underlying database naming specifications.

Returns:

RAS attribute collection entry for the given name.

Throws:

InvalidArgumentException - if name is null.

PolicyObjectNotFoundException - if RAS attribute collection with the given name does not exist.

PolicyStoreException - in case of any errors in interaction with backend data store.

deleteRASAttributeCollection

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

Deletes the RAS attribute collection with the given name.

Parameters:

name - RAS attribute collection name, the name should not be null or empty string. Name must adhere to underlying database naming specifications.

Throws:

InvalidArgumentException - if name is null.

PolicyStoreException - in case of any errors in interaction with backend data store.

PolicyObjectNotFoundException - if the RAS attribute collection specified by name doesn't exist

modifyRASAttributeCollection

void modifyRASAttributeCollection(RASAttributeCollectionEntry item)
                                  throws InvalidArgumentException,
                                         PolicyObjectNotFoundException,
                                         PolicyObjectAlreadyExistsException,
                                         PolicyStoreException

Modifies the RAS attribute collection from the given RAS attributeCollection entry. It will calculate delta and generate the corresponding modifications.

The attributes in the collection must be of category DYNAMIC. If the definition of an attribute does not exist with ExtensionManager, one is created.

Parameters:

item - the target RAS attribute collection

Throws:

InvalidArgumentException - if null is passed in or the passed AttributeCollectionEntry is invalid.

PolicyObjectNotFoundException - if the RAS attribute collection doesn't exist.

PolicyObjectAlreadyExistsException - if attribute added has definition different than one in the policy store

PolicyStoreException - if any internal status error.