org.picketlink.idm.permission.acl.spi

Interface PermissionHandler

All Known Implementing Classes:

BaseAbstractPermissionHandler, ClassPermissionHandler, EntityPermissionHandler, StringPermissionHandler

public interface PermissionHandler

Handles the generation of permission resource identifiers, and is responsible for the marshaling / unmarshaling of permissions

Author:

Shane Bryzak

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(Class<?> resourceClass) Returns true if the implementation can handle resources of the specified class
Serializable	getIdentifier(Object resource) Returns a Serializable identifier value that can be used to uniquely identify the specified resource
Set<String>	listClassOperations(Class<?> resourceClass) Returns a set containing the available permissions for a resource class.
Set<String>	listInstanceOperations(Class<?> resourceClass) Returns a set containing the available permissions for a particular resource instance.
Class<?>	unwrapResourceClass(Object resource) Returns the formal class of the specified resource

Method Detail

canHandle

boolean canHandle(Class<?> resourceClass)

Returns true if the implementation can handle resources of the specified class

Parameters:

resourceClass -

Returns:

getIdentifier

Serializable getIdentifier(Object resource)

Returns a Serializable identifier value that can be used to uniquely identify the specified resource

Parameters:

resource -

Returns:

unwrapResourceClass

Class<?> unwrapResourceClass(Object resource)

Returns the formal class of the specified resource

Parameters:

resource -

Returns:

listClassOperations

Set<String> listClassOperations(Class<?> resourceClass)

Returns a set containing the available permissions for a resource class. If there are no hard coded permissions defined (i.e. any permission is allowed) then this method must return an empty set.

Parameters:

resourceClass -

Returns:

listInstanceOperations

Set<String> listInstanceOperations(Class<?> resourceClass)

Returns a set containing the available permissions for a particular resource instance. If there are no hard coded permissions defined (i.e. any permission is allowed) then this method must return an empty set.

Parameters:

resourceClass -

Returns: