|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExtensionManager
This class manages OES policy extension objects, including:
Method Summary | ||
---|---|---|
|
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. |
|
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, java.util.List<FunctionEntry.ARG_TYPE> paramTypess, FunctionEntry.ARG_TYPE returnValueType) 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. |
|
java.lang.String[] |
getAllDeprecatedBuiltInFunctions() Returns supported built-in functions that are deprecated in corresponding policystore version |
|
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 |
---|
<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
name
- attribute namedisplayName
- attribute display namedescription
- attribute descriptiontype
- attribute typecategory
- attribute categoryisSingleValue
- indicate the attribute allow single/multiple valueInvalidArgumentException
- if one of the parameter name, type and category is null or invalidPolicyObjectAlreadyExistsException
- if the attribute already existsPolicyStoreException
- if failed to create the attributeAttributeEntry<? extends DataType> getAttribute(java.lang.String attrName) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
attrName
- attribute nameInvalidArgumentException
- if the attribute name is invalidPolicyObjectNotFoundException
- if the specified attribute does not existPolicyStoreException
- if failed to get the attributejava.util.List<AttributeEntry<? extends DataType>> getAttributes(AttributeSearchQuery query) throws PolicyStoreException
query
- the query criteriaPolicyStoreException
- if failed to get attributesvoid modifyAttribute(AttributeEntry<? extends DataType> attrEntry) throws InvalidArgumentException, PolicyStoreException
attrEntry
- attribute entry object, the value of the attribute entry is ignored and set to null at modificationInvalidArgumentException
- if the parameter attrEntry is nullPolicyStoreException
- if failed to modify the attribute entryvoid deleteAttribute(java.lang.String name, boolean cascade) throws InvalidArgumentException, PolicyStoreOperationNotAllowedException, PolicyStoreException
name
- attribute namecascade
- only cascade = false supported. If cascade = true, PolicyStoreOperationNotAllowedException will be thrown.InvalidArgumentException
- if the attribute name is invalidPolicyStoreOperationNotAllowedException
- if cascade = true, then PolicyStoreOperationNotAllowedException will be thrown because cascade delete is not supported. If cascade = false and the attribute is used by policy or other entities, PolicyStoreOperationNotAllowedException will be thrown because the attribute is being used.PolicyStoreException
- if failed to delete the attributejava.util.List<FunctionEntry> getFunctions(FunctionSearchQuery query) throws InvalidArgumentException, PolicyStoreException
query
- the query criteriaInvalidArgumentException
- if the parameter is invalidPolicyStoreException
- if failed to get functionsFunctionEntry 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
name
- function namedisplayName
- function display namedescription
- function descriptionclassName
- function class namereturnType
- function return typeinputParameters
- function input parametersInvalidArgumentException
- if the parameter name is invalid or className is null or returnType is nullPolicyObjectAlreadyExistsException
- if the function already existsPolicyStoreException
- if failed to create functionFunctionEntry 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
name
- function namedisplayName
- function display namedescription
- function descriptionclassName
- function class namereturnType
- function return typeinputParameters
- function input parametersvarArgs
- variable input parameters to a function if anyInvalidArgumentException
- if the parameter name is invalid or className is null or returnType is nullPolicyObjectAlreadyExistsException
- if the function already existsPolicyStoreException
- if failed to create functionFunctionEntry 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, java.util.List<FunctionEntry.ARG_TYPE> paramTypess, FunctionEntry.ARG_TYPE returnValueType) throws InvalidArgumentException, PolicyObjectAlreadyExistsException, PolicyStoreException
name
- function namedisplayName
- function display namedescription
- function descriptionclassName
- function class namereturnType
- function return typeinputParameters
- function input parametersvarArgs
- variable input parameters to a function if anyparamTypes
- types of input parameters to a function (single object, bag of objects/ set of objects). If null, it implies all input parameters to function are single objects.returnValueType
- type of output of function (single object/ bag/ set) If null, it implies function returns a single object of the given data type.InvalidArgumentException
- if the parameter name is invalid or className is null or returnType is nullPolicyObjectAlreadyExistsException
- if the function already existsPolicyStoreException
- if failed to create functionvoid deleteFunction(java.lang.String name, boolean cascade) throws InvalidArgumentException, PolicyStoreOperationNotAllowedException, PolicyStoreException
name
- function namecascade
- if set to false, the function is deleted provide it is no referenced in any policy.If cascade set to true, PolicyStoreOperationNotAllowedException will be thrown.InvalidArgumentException
- if the function name is invalidPolicyStoreOperationNotAllowedException
- if the function is referenced elsewhere and the cascade parameter is false, or the cascade parameter is true.PolicyStoreException
- if failed to delete the functionFunctionEntry getFunction(java.lang.String funcName) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
funcName
- function nameInvalidArgumentException
- if the function name is invalidPolicyObjectNotFoundException
- if the specified function does not existPolicyStoreException
- if failed to get the functionvoid modifyFunction(FunctionEntry funcEntry) throws InvalidArgumentException, PolicyStoreException
funcEntry
- function entry objectInvalidArgumentException
- if the parameter funcEntry is nullPolicyStoreException
- if failed to modify functionjava.lang.String[] getAllDeprecatedBuiltInFunctions() throws PolicyStoreException
PolicyStoreException
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |