org.xwiki.resource.temporary

Class TemporaryResourceReference

java.lang.Object

org.xwiki.resource.AbstractResourceReference

org.xwiki.resource.temporary.TemporaryResourceReference

All Implemented Interfaces:

ResourceReference

@Unstable
public class TemporaryResourceReference
extends AbstractResourceReference

Points to a temporary Resource that's been generated by some XWiki process (For example the Formula Macro generates images of rendered formulas, the Chart Macro generates images of rendered chart data, etc).

Since:

6.1M2

Version:

$Id: ff0fd2279498f714a3a0339a12f22c8fbd61997b $

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceType	TYPE Represents a Temporary Resource Type.

Constructor Summary

Constructors

Constructor and Description
TemporaryResourceReference(String moduleId, String resourceName)
TemporaryResourceReference(String moduleId, String resourceName, EntityReference owningEntityReference)

Method Summary

Methods

Modifier and Type	Method and Description
String	getModuleId()
EntityReference	getOwningEntityReference()
String	getResourceName()

Methods inherited from class org.xwiki.resource.AbstractResourceReference

addParameter, getParameters, getParameterValue, getParameterValues, getType, setType, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final ResourceType TYPE

Represents a Temporary Resource Type.

Constructor Detail

TemporaryResourceReference

public TemporaryResourceReference(String moduleId,
                          String resourceName,
                          EntityReference owningEntityReference)

Parameters:

moduleId - see getModuleId()

resourceName - see getResourceName()

owningEntityReference - see getOwningEntityReference()

TemporaryResourceReference

public TemporaryResourceReference(String moduleId,
                          String resourceName)

Parameters:

moduleId - see getModuleId()

resourceName - see getResourceName()

Method Detail

getOwningEntityReference

public EntityReference getOwningEntityReference()

Returns:

the reference to tne entity owning the current temporary resource. This can be used for example to verify that the user asking for the temporary resource has the permission to view the owning entity before letting him access the temporary resource.

getResourceName

public String getResourceName()

Returns:

the name of the temporary resource (eg the temporary file name of a generated image)

getModuleId

public String getModuleId()

Returns:

the module id, a free name (used as a namespace) allowing several components to generate temporary resources for the same Entity