Skip navigation links

oracle.security.jps.service.policystore.entitymanager
Interface ExtensionManager

All Superinterfaces:

EntityManager

public interface ExtensionManager

extends EntityManager

This class manages OES policy extension objects, including:

• Attribute
• Function

Method Summary

<T extends DataType> AttributeEntry<T>	createAttribute(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.Class<T> type, AttributeEntry.AttributeCategory category, boolean isSingleValue) Creates an attribute
FunctionEntry	createFunction(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String className, java.lang.Class<? extends DataType> returnType, java.util.List<java.lang.Class<? extends DataType>> inputParameters) Create a function.
FunctionEntry	createFunction(java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String className, java.lang.Class<? extends DataType> returnType, java.util.List<java.lang.Class<? extends DataType>> inputParameters, VarArgsInfo varArgs) Create a function.
void	deleteAttribute(java.lang.String name, boolean cascade) Delete an attribute.
void	deleteFunction(java.lang.String name, boolean cascade) Remove a function.
AttributeEntry<? extends DataType>	getAttribute(java.lang.String attrName) Get the attribute entry from the policy given the attribute name
java.util.List<AttributeEntry<? extends DataType>>	getAttributes(AttributeSearchQuery query) Returns a list of attributes matches specified query condition
FunctionEntry	getFunction(java.lang.String funcName) Get the function entry from the policy given the function name
java.util.List<FunctionEntry>	getFunctions(FunctionSearchQuery query) Returns a list of functions currently supported.
void	modifyAttribute(AttributeEntry<? extends DataType> attrEntry) Modify the attribute information given the modified attribute object.
void	modifyFunction(FunctionEntry funcEntry) Modify the function information given the modified function object.

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

resolveReference

Method Detail

createAttribute

<T extends DataType> AttributeEntry<T> createAttribute(java.lang.String name,
                                                       java.lang.String displayName,
                                                       java.lang.String description,
                                                       java.lang.Class<T> type,
                                                       AttributeEntry.AttributeCategory category,
                                                       boolean isSingleValue)
                                                   throws InvalidArgumentException,
                                                          PolicyObjectAlreadyExistsException,
                                                          PolicyStoreException

Creates an attribute

Parameters:

name - attribute name

displayName - attribute display name

description - attribute description

type - attribute type

category - attribute category

isSingleValue - indicate the attribute allow single/multiple value

Returns:

an attribute entry object

Throws:

InvalidArgumentException - if one of the parameter name, type and category is null or invalid

PolicyObjectAlreadyExistsException - if the attribute already exists

PolicyStoreException - if failed to create the attribute

getAttribute

AttributeEntry<? extends DataType> getAttribute(java.lang.String attrName)
                                                throws InvalidArgumentException,
                                                       PolicyObjectNotFoundException,
                                                       PolicyStoreException

Get the attribute entry from the policy given the attribute name

Parameters:

attrName - attribute name

Returns:

an attribute entry object

Throws:

InvalidArgumentException - if the attribute name is invalid

PolicyObjectNotFoundException - if the specified attribute does not exist

PolicyStoreException - if failed to get the attribute

getAttributes

java.util.List<AttributeEntry<? extends DataType>> getAttributes(AttributeSearchQuery query)
                                                                 throws PolicyStoreException

Returns a list of attributes matches specified query condition

Parameters:

query - the query criteria

Returns:

a list of attributes

Throws:

PolicyStoreException - if failed to get attributes

modifyAttribute

void modifyAttribute(AttributeEntry<? extends DataType> attrEntry)
                     throws InvalidArgumentException,
                            PolicyStoreException

Modify the attribute information given the modified attribute object.

Parameters:

attrEntry - attribute entry object

Throws:

InvalidArgumentException - if the parameter attrEntry is null

PolicyStoreException - if failed to modify the attribute entry

deleteAttribute

void deleteAttribute(java.lang.String name,
                     boolean cascade)
                     throws InvalidArgumentException,
                            PolicyStoreOperationNotAllowedException,
                            PolicyStoreException

Delete an attribute.

Parameters:

name - attribute name

cascade - cascade if set to false, the attribute is deleted provided it is not referenced in any policy. If set to true, the reference to the attribute is removed from whereever it is referenced, and then the attribute is deleted.

Throws:

InvalidArgumentException - if the attribute name is invalid

PolicyStoreOperationNotAllowedException - if the attribute is referenced elsewhere and the cascade parameter is false, or the cascade parameter is true.

PolicyStoreException - if failed to delete the attribute

getFunctions

java.util.List<FunctionEntry> getFunctions(FunctionSearchQuery query)
                                           throws InvalidArgumentException,
                                                  PolicyStoreException

Returns a list of functions currently supported.

Parameters:

query - the query criteria

Returns:

a list of functions currently supported

Throws:

InvalidArgumentException - if the parameter is invalid

PolicyStoreException - if failed to get functions

createFunction

FunctionEntry createFunction(java.lang.String name,
                             java.lang.String displayName,
                             java.lang.String description,
                             java.lang.String className,
                             java.lang.Class<? extends DataType> returnType,
                             java.util.List<java.lang.Class<? extends DataType>> inputParameters)
                             throws InvalidArgumentException,
                                    PolicyObjectAlreadyExistsException,
                                    PolicyStoreException

Create a function.

Parameters:

name - function name

displayName - function display name

description - function description

className - function class name

returnType - function return type

inputParameters - function input parameters

Returns:

an function entry object

Throws:

InvalidArgumentException - if the parameter name is invalid or className is null or returnType is null

PolicyObjectAlreadyExistsException - if the function already exists

PolicyStoreException - if failed to create function

createFunction

FunctionEntry createFunction(java.lang.String name,
                             java.lang.String displayName,
                             java.lang.String description,
                             java.lang.String className,
                             java.lang.Class<? extends DataType> returnType,
                             java.util.List<java.lang.Class<? extends DataType>> inputParameters,
                             VarArgsInfo varArgs)
                             throws InvalidArgumentException,
                                    PolicyObjectAlreadyExistsException,
                                    PolicyStoreException

Create a function.

Parameters:

name - function name

displayName - function display name

description - function description

className - function class name

returnType - function return type

inputParameters - function input parameters

varArgs - variable input parameters to a function if any

Returns:

an function entry object

Throws:

InvalidArgumentException - if the parameter name is invalid or className is null or returnType is null

PolicyObjectAlreadyExistsException - if the function already exists

PolicyStoreException - if failed to create function

deleteFunction

void deleteFunction(java.lang.String name,
                    boolean cascade)
                    throws InvalidArgumentException,
                           PolicyStoreOperationNotAllowedException,
                           PolicyStoreException

Remove a function.

Parameters:

name - function name

cascade - if set to false, the function is deleted provide it is no referenced in any policy.If set to true, the reference to the function is removed from whereever it is referenced, and then the function is deleted.

Throws:

InvalidArgumentException - if the function name is invalid

PolicyStoreOperationNotAllowedException - if the function is referenced elsewhere and the cascade parameter is false, or the cascade parameter is true.

PolicyStoreException - if failed to delete the function

getFunction

FunctionEntry getFunction(java.lang.String funcName)
                          throws InvalidArgumentException,
                                 PolicyObjectNotFoundException,
                                 PolicyStoreException

Get the function entry from the policy given the function name

Parameters:

funcName - function name

Returns:

an function entry object

Throws:

InvalidArgumentException - if the function name is invalid

PolicyObjectNotFoundException - if the specified function does not exist

PolicyStoreException - if failed to get the function

modifyFunction

void modifyFunction(FunctionEntry funcEntry)
                    throws InvalidArgumentException,
                           PolicyStoreException

Modify the function information given the modified function object.

Parameters:

funcEntry - function entry object

Throws:

InvalidArgumentException - if the parameter funcEntry is null

PolicyStoreException - if failed to modify function

Skip navigation links