A C E G H I L M N O R S T U
All Classes All Packages

A

AbstractResourceReference - Class in org.xwiki.resource

Base XWiki Resource Reference implementation common to all extending classes.

AbstractResourceReference() - Constructor for class org.xwiki.resource.AbstractResourceReference

AbstractResourceReferenceHandler<T> - Class in org.xwiki.resource

Helper to implement Resource Handlers, providing some default implementation.

AbstractResourceReferenceHandler() - Constructor for class org.xwiki.resource.AbstractResourceReferenceHandler

AbstractResourceReferenceHandlerEvent - Class in org.xwiki.resource.events

Base class for ResourceReferenceHandlerEvent implementations.

AbstractResourceReferenceHandlerEvent() - Constructor for class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

Match any ResourceReferenceHandlerEvent.

AbstractResourceReferenceHandlerEvent(ResourceReference) - Constructor for class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

Constructor initializing the reference of the event.

addParameter(String, Object) - Method in class org.xwiki.resource.AbstractResourceReference

addParameter(String, Object) - Method in interface org.xwiki.resource.ResourceReference

Authenticate - Annotation Type in org.xwiki.resource.annotations

Indicate that a ResourceReferenceHandler should be executed in an authenticated context.

C

canHandle(T) - Method in interface org.xwiki.resource.ResourceReferenceHandlerManager

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

compareTo(ResourceReferenceHandler) - Method in class org.xwiki.resource.AbstractResourceReferenceHandler

CreateResourceReferenceException - Exception in org.xwiki.resource

Means that an error occurred while trying to construct an ResourceReference object.

CreateResourceReferenceException(String) - Constructor for exception org.xwiki.resource.CreateResourceReferenceException

CreateResourceReferenceException(String, Throwable) - Constructor for exception org.xwiki.resource.CreateResourceReferenceException

CreateResourceTypeException - Exception in org.xwiki.resource

Means that an error occurred while trying to construct an ResourceType object.

CreateResourceTypeException(String) - Constructor for exception org.xwiki.resource.CreateResourceTypeException

CreateResourceTypeException(String, Throwable) - Constructor for exception org.xwiki.resource.CreateResourceTypeException

E

equals(Object) - Method in class org.xwiki.resource.AbstractResourceReference

equals(Object) - Method in class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

equals(Object) - Method in class org.xwiki.resource.ResourceType

G

get(String) - Method in class org.xwiki.resource.script.ResourceScriptService

getId() - Method in class org.xwiki.resource.ResourceType

getParameters() - Method in class org.xwiki.resource.AbstractResourceReference

getParameters() - Method in interface org.xwiki.resource.ResourceReference

A Resource Reference parameter provides optional additional information about the Resource Reference.

getParameterValue(String) - Method in class org.xwiki.resource.AbstractResourceReference

getParameterValue(String) - Method in interface org.xwiki.resource.ResourceReference

getParameterValues(String) - Method in class org.xwiki.resource.AbstractResourceReference

getParameterValues(String) - Method in interface org.xwiki.resource.ResourceReference

getPriority() - Method in class org.xwiki.resource.AbstractResourceReferenceHandler

getPriority() - Method in interface org.xwiki.resource.ResourceReferenceHandler

The priority of execution relative to the other Handlers.

getResourceReference() - Method in class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

getResourceReference() - Method in interface org.xwiki.resource.events.ResourceReferenceHandlerEvent

getResourceReference() - Method in interface org.xwiki.resource.ResourceReferenceManager

getSupportedResourceReferences() - Method in interface org.xwiki.resource.ResourceReferenceHandler

getType() - Method in class org.xwiki.resource.AbstractResourceReference

getType() - Method in interface org.xwiki.resource.ResourceReference

H

handle(ResourceReference) - Method in interface org.xwiki.resource.ResourceReferenceHandlerManager

Handles a passed ResourceReference.

handle(ResourceReference, ResourceReferenceHandlerChain) - Method in interface org.xwiki.resource.ResourceReferenceHandler

Executes the Handler on the passed Resource Reference.

handleNext(ResourceReference) - Method in interface org.xwiki.resource.ResourceReferenceHandlerChain

Allow the next Handler in the chain an opportunity to handle the passed Resource Reference.

hashCode() - Method in class org.xwiki.resource.AbstractResourceReference

hashCode() - Method in class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

hashCode() - Method in class org.xwiki.resource.ResourceType

I

isStatic() - Method in class org.xwiki.resource.ResourceType

L

load(T) - Method in interface org.xwiki.resource.ResourceLoader

M

matches(Object) - Method in class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

N

NotFoundResourceHandlerException - Exception in org.xwiki.resource

Whenever a Resource Handler doesn't exist for handling a given Resource Reference.

NotFoundResourceHandlerException(ResourceReference) - Constructor for exception org.xwiki.resource.NotFoundResourceHandlerException

Construct a new exception with the specified detail message.

NotFoundResourceHandlerException(ResourceReference, Throwable) - Constructor for exception org.xwiki.resource.NotFoundResourceHandlerException

Construct a new exception with the specified detail message and cause.

O

org.xwiki.resource - package org.xwiki.resource

org.xwiki.resource.annotations - package org.xwiki.resource.annotations

org.xwiki.resource.events - package org.xwiki.resource.events

org.xwiki.resource.script - package org.xwiki.resource.script

R

resolve(T, Map<String, Object>) - Method in interface org.xwiki.resource.ResourceTypeResolver

Transforms some representation of a XWiki Resource Type into a ResourceType instance.

resolve(T, ResourceType, Map<String, Object>) - Method in interface org.xwiki.resource.ResourceReferenceResolver

Transforms some representation of a XWiki Resource Reference into a ResourceReference instance.

RESOURCE_CONTEXT_PROPERTY - Static variable in interface org.xwiki.resource.ResourceReferenceManager

Key under which the XWiki Resource Reference is put in the Execution Context.

ResourceLoader<T extends ResourceReference> - Interface in org.xwiki.resource

Load Resources pointed to by Resource Reference as a Input Stream.

ResourceReference - Interface in org.xwiki.resource

Represents a reference to an XWiki Resource (Entity Resource, Attachment Resource, Template Resource, etc).

ResourceReferenceCreationException - Exception in org.xwiki.resource

Means that an error occurred while trying to construct an ResourceReference object.

ResourceReferenceCreationException(String) - Constructor for exception org.xwiki.resource.ResourceReferenceCreationException

ResourceReferenceCreationException(String, Throwable) - Constructor for exception org.xwiki.resource.ResourceReferenceCreationException

ResourceReferenceHandledEvent - Class in org.xwiki.resource.events

Event sent after the execution of a ResourceReferenceHandler.

ResourceReferenceHandledEvent() - Constructor for class org.xwiki.resource.events.ResourceReferenceHandledEvent

Match any ResourceReferenceHandledEvent.

ResourceReferenceHandledEvent(ResourceReference) - Constructor for class org.xwiki.resource.events.ResourceReferenceHandledEvent

Constructor initializing the reference of the event.

ResourceReferenceHandler<T> - Interface in org.xwiki.resource

Handles a given ResourceReference.

ResourceReferenceHandlerChain - Interface in org.xwiki.resource

Allows calling the next ResourceReferenceHandler in the chain.

ResourceReferenceHandlerEvent - Interface in org.xwiki.resource.events

Common interface for all event related to ResourceReferenceHandler.

ResourceReferenceHandlerException - Exception in org.xwiki.resource

Represents a problem when handling a ResourceReference.

ResourceReferenceHandlerException(String) - Constructor for exception org.xwiki.resource.ResourceReferenceHandlerException

Construct a new exception with the specified detail message.

ResourceReferenceHandlerException(String, Throwable) - Constructor for exception org.xwiki.resource.ResourceReferenceHandlerException

Construct a new exception with the specified detail message and cause.

ResourceReferenceHandlerManager<T> - Interface in org.xwiki.resource

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

ResourceReferenceHandlingEvent - Class in org.xwiki.resource.events

Event sent before starting the execution of a ResourceReferenceHandler.

ResourceReferenceHandlingEvent() - Constructor for class org.xwiki.resource.events.ResourceReferenceHandlingEvent

Match any ResourceReferenceHandlingEvent.

ResourceReferenceHandlingEvent(ResourceReference) - Constructor for class org.xwiki.resource.events.ResourceReferenceHandlingEvent

Constructor initializing the reference of the event.

ResourceReferenceManager - Interface in org.xwiki.resource

Allow getting the ResourceReference object from the Execution Context.

ResourceReferenceResolver<T> - Interface in org.xwiki.resource

Transforms some representation of an XWiki Resource Reference (aka a URI) into a ResourceReference instance.

ResourceReferenceSerializer<T extends ResourceReference,U> - Interface in org.xwiki.resource

Transforms a Resource Reference into some other representation (eg URL).

ResourceScriptService - Class in org.xwiki.resource.script

Exposes the Resource API to server-side scripts.

ResourceScriptService() - Constructor for class org.xwiki.resource.script.ResourceScriptService

ResourceType - Class in org.xwiki.resource

Represents the type of Resource (eg Entity, Temporary, etc).

ResourceType(String) - Constructor for class org.xwiki.resource.ResourceType

ResourceType(String, boolean) - Constructor for class org.xwiki.resource.ResourceType

ResourceTypeResolver<T> - Interface in org.xwiki.resource

Transforms some representation of an XWiki Resource Type into a ResourceType instance.

ROLE_HINT - Static variable in class org.xwiki.resource.script.ResourceScriptService

The role hint of this component.

S

serialize(T) - Method in interface org.xwiki.resource.ResourceReferenceSerializer

Transforms a Resource Reference into some other representation.

SerializeResourceReferenceException - Exception in org.xwiki.resource

Means that an error occurred while trying to serialize a ResourceReference object.

SerializeResourceReferenceException(String) - Constructor for exception org.xwiki.resource.SerializeResourceReferenceException

SerializeResourceReferenceException(String, Throwable) - Constructor for exception org.xwiki.resource.SerializeResourceReferenceException

setParameter(String, Object) - Method in class org.xwiki.resource.AbstractResourceReference

Add or replace an existing parameter with the passed value.

setPriority(int) - Method in class org.xwiki.resource.AbstractResourceReferenceHandler

setType(ResourceType) - Method in class org.xwiki.resource.AbstractResourceReference

T

toString() - Method in class org.xwiki.resource.AbstractResourceReference

toString() - Method in class org.xwiki.resource.events.AbstractResourceReferenceHandlerEvent

toString() - Method in class org.xwiki.resource.ResourceType

U

UnsupportedResourceReferenceException - Exception in org.xwiki.resource

Means the Resource Reference is of a type for which we don't have an implementation for.

UnsupportedResourceReferenceException(String) - Constructor for exception org.xwiki.resource.UnsupportedResourceReferenceException

UnsupportedResourceReferenceException(String, Throwable) - Constructor for exception org.xwiki.resource.UnsupportedResourceReferenceException

A C E G H I L M N O R S T U
All Classes All Packages