com.xpn.xwiki.web

Class TempResourceAction

java.lang.Object

org.apache.struts.action.Action

com.xpn.xwiki.web.XWikiAction

com.xpn.xwiki.web.TempResourceAction

public class TempResourceAction
extends com.xpn.xwiki.web.XWikiAction

Action responsible for downloading temporary resources created by various modules. The temporary resource is put in the temporary directory in a directory named "temp" and in subdirectories "(module)/(wiki)/(space)/(page)/(file)" where:

• (module): it's the 3rd path segment in the request URL (format: {code .../temp/1/2/3/4})
• (wiki): the name of the current wiki (extracted from the URL too)
• (space): it's the 1st path segment in the request URL (format: {code .../temp/1/2/3/4})
• (page): it's the 2nd path segment in the request URL (format: {code .../temp/1/2/3/4})
• (file): it's the 4th path segment in the request URL (format: {code .../temp/1/2/3/4})

For example if the URL is http://localhost:8080/xwiki/bin/temp/Main/WebHome/test/test.png then the resource will be fetched from TMPDIR/temp/test/xwiki/Main/WebHome/test.png.

Since:

2.4M1

Version:

$Id: 60906b3ffea2f37f15f7d718b773aab336343a70 $

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	URI_PATTERN URI pattern for this action.

Fields inherited from class com.xpn.xwiki.web.XWikiAction

ACTION_PROGRESS, waitForXWikiInitialization

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
TempResourceAction()

Method Summary

Modifier and Type	Method and Description
protected File	getTemporaryFile(String uri, com.xpn.xwiki.XWikiContext context) Returns the temporary file corresponding to the specified URI.
String	render(com.xpn.xwiki.XWikiContext context)

Methods inherited from class com.xpn.xwiki.web.XWikiAction

action, cleanupComponents, csrfTokenCheck, execute, execute, getLocalization, getProgress, getRealPath, getTranslatedDocument, handleRevision, initializeContainerComponent, initializeXWikiContext, localizePlainOrKey, sendGlobalRedirect, sendRedirect

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

URI_PATTERN

public static final Pattern URI_PATTERN

URI pattern for this action.

Constructor Detail

TempResourceAction

public TempResourceAction()

Method Detail

render

public String render(com.xpn.xwiki.XWikiContext context)
              throws com.xpn.xwiki.XWikiException

Overrides:

render in class com.xpn.xwiki.web.XWikiAction

Throws:

com.xpn.xwiki.XWikiException

getTemporaryFile

protected File getTemporaryFile(String uri,
                                com.xpn.xwiki.XWikiContext context)

Returns the temporary file corresponding to the specified URI.

Parameters:

uri - request URI.

context - xwiki context.

Returns:

temporary file corresponding to the specified URI or null if no such file can be located.