com.atlassian.confluence.importexport.resource

Class ExportDownloadResourceManager

java.lang.Object

com.atlassian.confluence.importexport.resource.ExportDownloadResourceManager

All Implemented Interfaces:

DownloadResourceManager, WritableDownloadResourceManager

public class ExportDownloadResourceManager
extends Object
implements WritableDownloadResourceManager

A WritableDownloadResourceManager that stores and reads macro output from a temporary location.

Constructor Summary

Constructors

Constructor and Description
ExportDownloadResourceManager(BootstrapManager bootstrapManager, GateKeeper gateKeeper)

Method Summary

Methods

Modifier and Type	Method and Description
DownloadResourceReader	getResourceReader(String userName, String resourcePath, Map parameters) Returns a FileDownloadResourceReader for reading the stored output of the previous execution of a macro.
DownloadResourceWriter	getResourceWriter(String userName, String prefix, String suffix) Returns a FileDownloadResourceWriter for storing output of a macro in a temporary location.
boolean	matches(String resourcePath) Returns a boolean to indicate whether the current DownloadResourceManager will know how to handle the given resourcePath.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportDownloadResourceManager

public ExportDownloadResourceManager(BootstrapManager bootstrapManager,
                             GateKeeper gateKeeper)

Method Detail

matches

public boolean matches(String resourcePath)

Description copied from interface: DownloadResourceManager

Returns a boolean to indicate whether the current DownloadResourceManager will know how to handle the given resourcePath.

Specified by:

matches in interface DownloadResourceManager

Parameters:

resourcePath - the relative URL of the resource including the application context path. For example, "/confluence/download/attachments/12345/temp.png".

Returns:

true if the manager can handle the given resource path

getResourceReader

public DownloadResourceReader getResourceReader(String userName,
                                       String resourcePath,
                                       Map parameters)
                                         throws UnauthorizedDownloadResourceException,
                                                DownloadResourceNotFoundException

Returns a FileDownloadResourceReader for reading the stored output of the previous execution of a macro. Typically used by HTML and PDF export, macro content downloads.

Specified by:

getResourceReader in interface DownloadResourceManager

Parameters:

userName - the user who is viewing the macro output. Must be the same as the user who created the macro output with getResourceWriter(String, String, String), or an UnauthorizedDownloadResourceException will be thrown.

resourcePath - the relative URL of the resource including the application context path. For example, "/confluence/download/temp/chart1756.png". It must be the same path from the DownloadResourceWriter.

parameters - a map of url paramaters for the resource

Returns:

a DownloadResourceReader to read the resource content from

Throws:

UnauthorizedDownloadResourceException - if the user requesting the macro output is different to the user who created it

DownloadResourceNotFoundException - if a stored macro output associated with this resource path cannot be found

getResourceWriter

public DownloadResourceWriter getResourceWriter(String userName,
                                       String prefix,
                                       String suffix)

Returns a FileDownloadResourceWriter for storing output of a macro in a temporary location. This should be typically called by macros that generate output such as images and would like their output to be exported correctly.

Specified by:

getResourceWriter in interface WritableDownloadResourceManager

Parameters:

userName - the user who is creating the macro output.

prefix - the prefix of the macro output's name

suffix - the suffix of the macro output