com.metamatrix.platform.security.api
Interface AuthorizationResource

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

DataAccessResource

public interface AuthorizationResource
extends java.lang.Comparable

This interface defines a Resource on which can be granted one or more Actions. Together these form an AuthorizationPermission.

Method Summary

java.lang.String	getCanonicalName() Get the canonical name of this resource used for comparing.
java.lang.String	getID() Get the identifier of this resource.
java.lang.String	getName() Get the name of this resource.
java.lang.String	getUUID() Get the UUID of this resource.
boolean	implies(AuthorizationResource resource) Does this resource imply another?
boolean	isCannonicallyEquivalent(AuthorizationResource resource) Are these resources equal exception for recursion?
boolean	isRecursive() Determine if the Actions applies to this resource should be applied recursively to sub resources.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

Get the name of this resource. May be null if the resorce's ID has not been resolved.

Returns:

The resource name.

getID

java.lang.String getID()

Get the identifier of this resource. Will not be null. This is the identifier used to store and retrieve this resource from the Authorization store.

Returns:

The resource identifier.

getUUID

java.lang.String getUUID()

Get the UUID of this resource. May be null. This is a payload of UUID for MetaBase authorization code.

Returns:

The resource's UUID, if present, else null.

getCanonicalName

java.lang.String getCanonicalName()

Get the canonical name of this resource used for comparing. May be null if the resource's ID has not been resolved.

Returns:

The canonical resource name.

isRecursive

boolean isRecursive()

Determine if the Actions applies to this resource should be applied recursively to sub resources.

Returns:

Whether the actions are to be applied recursivly.

implies

boolean implies(AuthorizationResource resource)

Does this resource imply another?

Parameters:

resource - The other resource

Throws:

MetaBaseResourceNotResolvedException - if implies is called bfore the resource's ID has been resolved to a path.

isCannonicallyEquivalent

boolean isCannonicallyEquivalent(AuthorizationResource resource)

Are these resources equal exception for recursion?

Parameters:

resource - The resource to compare with this one disregarding recursion.

Returns:

true if these two resources differ only be recursion.