|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceTypeEntry
A ResourceType is essentially a template for creating Resources within an Application. In addition to specifying the resource type, it also specifies attributes and all possible actions that can be performed on that type. A ResourceType is managed by a ResourceTypeManager
Nested Class Summary | |
---|---|
static class |
ResourceTypeEntry.ResourceActionDelimiter List of resource actions delimiter |
static class |
ResourceTypeEntry.ResourceHierarchyType the hierarchy model of the type of resources |
static class |
ResourceTypeEntry.ResourceNameDelimiter List of resource name delimiter |
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_RESOURCE_TYPE_NAME |
Method Summary | |
---|---|
void |
addValidAction(java.lang.String actionName) Add supported actions. |
void |
addValidResourceAttribute(AttributeEntry<? extends DataType> attribute) Add a supported resource attribute. |
void |
deleteValidAction(java.lang.String actionName) Remove supported actions. |
void |
deleteValidResourceAttribute(AttributeEntry<? extends DataType> attribute) Remove a supported resource attribute. |
java.lang.String |
getActionsDelimiter() |
java.lang.String |
getAllAction() This method returns the keyword that is used to denote all valid actions. |
java.lang.String |
getDescription() Get the description of the entity. |
java.lang.String |
getDisplayName() Returns the Display name. |
java.lang.String |
getName() Name of the entry. |
java.lang.String |
getProvider() |
java.lang.String |
getResourceMatcherClassName() The permission class or matching algorithm applicable for all resources of this resource type. |
char |
getResourceNameDelimiter() Returns the resource name delimiter for this hierarchical resource type |
java.util.List<java.lang.String> |
getValidActions() Returns a List of all possible actions for the given resource type. |
java.util.List<AttributeEntry<? extends DataType>> |
getValidResourceAttributes() Returns list of attributes that an instance of this resource type may have. |
boolean |
isHierarchicalResource() This method returns the resource type to hierarchical resource type |
void |
setAllAction(java.lang.String allAction) This method sets the keyword that is used to denote all valid actions. |
void |
setDescription(java.lang.String description) Set the description of this entry. |
void |
setDisplayName(java.lang.String displayName) Set the display name of this entry. |
void |
setHierarchicalResource(boolean isHierarchical) Sets the resource type to hierarchical resource type |
void |
setProvider(java.lang.String providerName) Set the provider of this resource type. |
void |
setResourceMatcherClassName(java.lang.String resourceMatcherClassName) Set resource matcher class name. |
void |
setResourceNameDelimiter(char delimiter) Deprecated. |
void |
setResourceNameDelimiter(ResourceTypeEntry.ResourceNameDelimiter delimiter) Sets the resource name delimiter for this hierarchical resource type. |
Field Detail |
---|
static final java.lang.String DEFAULT_RESOURCE_TYPE_NAME
Method Detail |
---|
java.util.List<java.lang.String> getValidActions()
java.lang.String getAllAction()
void setAllAction(java.lang.String allAction) throws PolicyStoreException
allAction
- The keyword value that will denote all valid actions.InvalidArgumentException
- If the given value is not allowed or already exists in the valid actions list.PolicyStoreOperationNotAllowedException
- If permission/matcher class is set.PolicyStoreException
java.lang.String getResourceMatcherClassName()
java.lang.String getProvider()
java.lang.String getActionsDelimiter()
java.util.List<AttributeEntry<? extends DataType>> getValidResourceAttributes()
void addValidAction(java.lang.String actionName) throws PolicyStoreException
actionName
- action namePolicyStoreException
void deleteValidAction(java.lang.String actionName) throws PolicyStoreException
actionName
- action namePolicyStoreException
void setProvider(java.lang.String providerName) throws PolicyStoreException
providerName
- provider namePolicyStoreException
void addValidResourceAttribute(AttributeEntry<? extends DataType> attribute) throws PolicyStoreException
attribute
- attribute entry objectPolicyStoreException
void deleteValidResourceAttribute(AttributeEntry<? extends DataType> attribute) throws PolicyStoreException
attribute
- attribute entry objectPolicyStoreException
void setResourceMatcherClassName(java.lang.String resourceMatcherClassName) throws PolicyStoreException
resourceMatcherClassName
- resource matcher class namePolicyStoreException
java.lang.String getDescription()
java.lang.String getDisplayName()
java.lang.String getName()
void setDescription(java.lang.String description)
description
-void setDisplayName(java.lang.String displayName)
displayName
-void setResourceNameDelimiter(ResourceTypeEntry.ResourceNameDelimiter delimiter) throws PolicyStoreException
delimiter
- Resource name delimiterPolicyStoreException
- If the delimiter character is invalid.
@Deprecated
void setResourceNameDelimiter(char delimiter)
throws PolicyStoreException
delimiter
- Resource name delimiterPolicyStoreException
- If the delimiter character is invalid.char getResourceNameDelimiter()
void setHierarchicalResource(boolean isHierarchical)
isHierarchical
-boolean isHierarchicalResource()
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |