Skip navigation links

oracle.security.jps.service.policystore.info.resource
Interface ResourceTypeEntry

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

DEFAULT_RESOURCE_TYPE_NAME

static final java.lang.String DEFAULT_RESOURCE_TYPE_NAME

See Also:

Constant Field Values

Method Detail

getValidActions

java.util.List<java.lang.String> getValidActions()

Returns a List of all possible actions for the given resource type.

Returns:

a list of actions

getAllAction

java.lang.String getAllAction()

This method returns the keyword that is used to denote all valid actions. Default value is 'ANY'. Returns null if permission/matcher class is set.

Returns:

The value of the keyword that denotes all valid actions.

setAllAction

void setAllAction(java.lang.String allAction)
                  throws PolicyStoreException

This method sets the keyword that is used to denote all valid actions.

Parameters:

allAction - The keyword value that will denote all valid actions.

Throws:

InvalidArgumentException - If the given value is not allowed or already exists in the valid actions list.

PolicyStoreOperationNotAllowedException - If permission/matcher class is set.

PolicyStoreException

getResourceMatcherClassName

java.lang.String getResourceMatcherClassName()

The permission class or matching algorithm applicable for all resources of this resource type. This class must implement java Permission interface. May be null.

Returns:

Name of the permission class/ matcher class for the resource type.

getProvider

java.lang.String getProvider()

Returns:

Provider for this resource type. The Provider will support queries on instances of this resource type. Must implement the ResourceFinder interface.

getActionsDelimiter

java.lang.String getActionsDelimiter()

Returns:

Delimiter used to separate multiple actions for the resource type. Default value is ", as in "read, writer, execute"

getValidResourceAttributes

java.util.List<AttributeEntry<? extends DataType>> getValidResourceAttributes()

Returns list of attributes that an instance of this resource type may have. The returned List is backed by this ResourceTypeEntry internal private attribute List. Any modification to the returned List affects the internal private List as well.

Returns:

a list of attributes

addValidAction

void addValidAction(java.lang.String actionName)
                    throws PolicyStoreException

Add supported actions.

Parameters:

actionName - action name

Throws:

PolicyStoreException

deleteValidAction

void deleteValidAction(java.lang.String actionName)
                       throws PolicyStoreException

Remove supported actions.

Parameters:

actionName - action name

Throws:

PolicyStoreException

setProvider

void setProvider(java.lang.String providerName)
                 throws PolicyStoreException

Set the provider of this resource type.

Parameters:

providerName - provider name

Throws:

PolicyStoreException

addValidResourceAttribute

void addValidResourceAttribute(AttributeEntry<? extends DataType> attribute)
                               throws PolicyStoreException

Add a supported resource attribute.

Parameters:

attribute - attribute entry object

Throws:

PolicyStoreException

deleteValidResourceAttribute

void deleteValidResourceAttribute(AttributeEntry<? extends DataType> attribute)
                                  throws PolicyStoreException

Remove a supported resource attribute.

Parameters:

attribute - attribute entry object

Throws:

PolicyStoreException

setResourceMatcherClassName

void setResourceMatcherClassName(java.lang.String resourceMatcherClassName)
                                 throws PolicyStoreException

Set resource matcher class name. If Resource Matching Algorithm is set, throw out a PolicyStoreException with proper message.

Parameters:

resourceMatcherClassName - resource matcher class name

Throws:

PolicyStoreException

getDescription

java.lang.String getDescription()

Get the description of the entity.

Returns:

the description of the entity.

getDisplayName

java.lang.String getDisplayName()

Returns the Display name.

Returns:

the display name.

getName

java.lang.String getName()

Name of the entry.

Returns:

the name of the entry.

setDescription

void setDescription(java.lang.String description)

Set the description of this entry.

Parameters:

description -

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of this entry.

Parameters:

displayName -

setResourceNameDelimiter

void setResourceNameDelimiter(ResourceTypeEntry.ResourceNameDelimiter delimiter)
                              throws PolicyStoreException

Sets the resource name delimiter for this hierarchical resource type. The default delimiter is '/' character.

Parameters:

delimiter - Resource name delimiter

Throws:

PolicyStoreException - If the delimiter character is invalid.

setResourceNameDelimiter

@Deprecated
void setResourceNameDelimiter(char delimiter)
                              throws PolicyStoreException

Deprecated.

Sets the resource name delimiter for this hierarchical resource type. The default delimiter is '/' character.

Parameters:

delimiter - Resource name delimiter

Throws:

PolicyStoreException - If the delimiter character is invalid.

getResourceNameDelimiter

char getResourceNameDelimiter()

Returns the resource name delimiter for this hierarchical resource type

Returns:

resource name delimiter

setHierarchicalResource

void setHierarchicalResource(boolean isHierarchical)

Sets the resource type to hierarchical resource type

Parameters:

isHierarchical -

isHierarchicalResource

boolean isHierarchicalResource()

This method returns the resource type to hierarchical resource type

Returns:

True if the resource type is hierarchical, otherwise false.

Skip navigation links