org.picketlink.permission.spi

Interface PermissionHandler

public interface PermissionHandler

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

Author:

Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(Class<?> resourceClass) Returns true if the implementation can handle resources of the specified class
boolean	canLoadResource(String identifier) Returns true if the implementation can load the resource instance for the specified identifier
Set<String>	convertResourcePermissions(Class<?> resourceClass, Object permissions)
String	getGeneratedIdentifier(Object resource) Returns a String identifier value that can be used to uniquely identify the specified resource
Serializable	getNaturalIdentifier(Object resource) Returns the natural identifier value of the specified resource
Set<String>	listAvailablePermissions(Class<?> resourceClass) Returns a set containing the available permissions for a particular resource.
Object	lookupResource(String identifier) Returns the resource instance for the specified identifier

Method Detail

canHandle

boolean canHandle(Class<?> resourceClass)

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

Parameters:

resourceClass -

Returns:

canLoadResource

boolean canLoadResource(String identifier)

Returns true if the implementation can load the resource instance for the specified identifier

Parameters:

identifier -

Returns:

getGeneratedIdentifier

String getGeneratedIdentifier(Object resource)

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

Parameters:

resource -

Returns:

getNaturalIdentifier

Serializable getNaturalIdentifier(Object resource)

Returns the natural identifier value of the specified resource

Parameters:

resource -

Returns:

lookupResource

Object lookupResource(String identifier)

Returns the resource instance for the specified identifier

Parameters:

identifier -

Returns:

listAvailablePermissions

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

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

Parameters:

resourceClass -

Returns:

convertResourcePermissions

Set<String> convertResourcePermissions(Class<?> resourceClass,
                                     Object permissions)

Parameters:

resourceClass -

permissions -

Returns: