Package org.xwiki.resource

Interface ResourceReferenceHandlerManager<T>

Type Parameters:

T - the qualifying element to distinguish a Resource Reference (e.g. Resource Type, Entity Resource Action)

@Role
public interface ResourceReferenceHandlerManager<T>

The Resource Handler Manager's goal is to locate the right ResourceReferenceHandler implementations to call in the right order.

Since:

6.1M2

Version:

$Id: aa32ee84fc619ec396b68aea02ed90e5400269e4 $

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(T resourceReferenceQualifier)	Check if there's a Handler for the passed Resource Reference or not.
void	handle(ResourceReference reference)	Handles a passed ResourceReference.

Method Detail

handle

void handle(ResourceReference reference)
     throws ResourceReferenceHandlerException

Handles a passed ResourceReference.

Parameters:

reference - the Resource Reference to handle

Throws:

ResourceReferenceHandlerException - if an error happens during the Handler execution, for example if no Handler was found to handle the passed Resource Reference

canHandle

boolean canHandle(T resourceReferenceQualifier)

Check if there's a Handler for the passed Resource Reference or not.

Parameters:

resourceReferenceQualifier - the qualifying element to distinguish a Resource Reference for which we wish to check if we can handle it or not (ie we have a Handler available for it). This can be for example the Resource Type or for an Entity Resource it can be an Entity Resource Action

Returns:

true if we have a Handler for the passed Resource Reference qualifier or false otherwise

Since:

7.1M1