Summary: Methods | [Expand All]
public interface

DownloadResourceManager

com.atlassian.confluence.importexport.resource.DownloadResourceManager
Known Indirect Subclasses

Class Overview

An interface for managers that support reading of downloadable resources. Managers that also support writing, should implement the WritableDownloadResourceManager interface.

Summary

Public Methods
DownloadResourceReader getResourceReader(String userName, String resourcePath, Map parameters)
Returns a DownloadResourceReader for a downloadable resource.
boolean matches(String resourcePath)
Returns a boolean to indicate whether the current DownloadResourceManager will know how to handle the given resourcePath.

Public Methods

public DownloadResourceReader getResourceReader (String userName, String resourcePath, Map parameters)

Returns a DownloadResourceReader for a downloadable resource. Typically used by HTML/PDF export and resource content downloads. Use this method only if matches(String) returns true.

Parameters
userName the user who is retrieving the downloadable resource.
resourcePath the relative URL of the resource including the application context path. For example, "/confluence/download/attachments/12345/temp.png".
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 downloadable resource does not have the permissions to get it
DownloadResourceNotFoundException if the downloadable resource associated with the resourcePath cannot be found

public boolean matches (String resourcePath)

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

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