org.picketlink.idm.permission

Class Permission

java.lang.Object

org.picketlink.idm.permission.Permission

Direct Known Subclasses:

FuzzyPermission, IdentityPermission

public abstract class Permission
extends Object

Abstract base class representing a specific permission granted for a domain resource. If the actual resource object instance is known then the getResource() method will return a reference to it, otherwise the getResourceClass() and getResourceIdentifier() methods may be used to determine the specific resource that the permission applies to. It is the responsibility of any subclasses to declare any logic relating to the assignee of the Permission.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
Permission(Class<?> resourceClass, Serializable resourceIdentifier, String operation)
Permission(Object resource, String operation)

Method Summary

Methods

Modifier and Type	Method and Description
String	getOperation() Returns the permission operation
Object	getResource() Returns the resource object if known, otherwise returns null.
Class<?>	getResourceClass() Returns the resource class if the actual resource instance is not known, otherwise returns null.
Serializable	getResourceIdentifier() Returns the resource identifier if the actual resource instance is not known, otherwise returns null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Permission

public Permission(Object resource,
          String operation)

Permission

public Permission(Class<?> resourceClass,
          Serializable resourceIdentifier,
          String operation)

Method Detail

getResource

public Object getResource()

Returns the resource object if known, otherwise returns null. If the resource object is not known, then the getResourceClass() and getResourceIdentifier() methods represent the "coordinates" of the resource.

Returns:

Object The resource instance, or null

getResourceClass

public Class<?> getResourceClass()

Returns the resource class if the actual resource instance is not known, otherwise returns null.

Returns:

getResourceIdentifier

public Serializable getResourceIdentifier()

Returns the resource identifier if the actual resource instance is not known, otherwise returns null.

Returns:

getOperation

public String getOperation()

Returns the permission operation

Returns: