Skip navigation links

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

public interface ResourceEntry

ResourceEntry represents persistent view of a resource in an application. A resource MUST have a resource type.

A resource can be specified by a name such as /www.oracle.com/index.html

To create an in-memory representation of a ResourceEntry use InfoFactory.newResourceEntry(String, String, String, String).

To persist a ResourceEntry in the underlying policystore use ResourceManager.createResource(ResourceEntry).

To modify, delete or query a ResourceEntry use ResourceManager.

Nested Class Summary

static class

ResourceEntry.Properties Modifiable properties of a ResourceEntry

Method Summary

void	addResourceAttribute(AttributeEntry<? extends DataType> attribute) Add a resource attribute.
void	deleteResourceAttribute(AttributeEntry<? extends DataType> attribute) Remove a resource attribute
java.util.List<AttributeEntry<? extends DataType>>	getAllResourceAttributes() Get resource attributes and inherited attributes .
java.lang.String	getDescription() Get the description of the entity.
java.lang.String	getDisplayName() Returns the Display name.
java.util.List<AttributeEntry<? extends DataType>>	getInheritedResourceAttributes() Get inherited resource attributes
java.lang.String	getName() Name of the entry.
java.lang.String	getParentApplication() Get the parent application this entity belongs to.
java.lang.String	getPolicyDomainName() Returns the name of the policy domain to which this entry belongs.
java.lang.String	getPolicyDomainUniqueName() Returns the unique name of the policy domain to which this entry belongs.
java.util.List<AttributeEntry<? extends DataType>>	getResourceAttributes() Get all resource attributes.
java.lang.String	getResourceName()
ResourceTypeEntry	getResourceType() Return the resource type.
java.lang.String	getResourceTypeName()
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.

Method Detail

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 -

getResourceTypeName

java.lang.String getResourceTypeName()

Returns:

Name of the resource type associated with resource instance.

getResourceName

java.lang.String getResourceName()

Returns:

Returns the target of the resource.

getResourceType

ResourceTypeEntry getResourceType()

Return the resource type.

Returns:

the resource type.

getResourceAttributes

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

Get all resource attributes. The returned List is backed by this ResourceEntry internal private attribute List. Any modification to the returned List affects the internal private List as well.

Returns:

a list of resource attributes

getInheritedResourceAttributes

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

Get inherited resource attributes

Returns:

a list of inherited resource attributes

getAllResourceAttributes

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

Get resource attributes and inherited attributes .

Returns:

a list of resource attributes

addResourceAttribute

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

Add a resource attribute.

Parameters:

attribute - attribute entry object

Throws:

PolicyStoreException

deleteResourceAttribute

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

Remove a resource attribute

Parameters:

attribute - attribute entry object

Throws:

PolicyStoreException

getParentApplication

java.lang.String getParentApplication()

Get the parent application this entity belongs to.

Returns:

parent application name

getPolicyDomainName

java.lang.String getPolicyDomainName()

Returns the name of the policy domain to which this entry belongs. returns null if the entry belongs to default policy domain.

Returns:

name of the policy domain to which this entry belongs.

getPolicyDomainUniqueName

java.lang.String getPolicyDomainUniqueName()

Returns the unique name of the policy domain to which this entry belongs.

Returns:

unique name of the policy domain to which this entry belongs.

Skip navigation links