com.atlassian.confluence.importexport.resource

Interface PartialDownloadResourceManager

All Superinterfaces:

DownloadResourceManager

All Known Implementing Classes:

AttachmentDownloadResourceManager, DelegatorDownloadResourceManager, ThumbnailDownloadResourceManager

public interface PartialDownloadResourceManager
extends DownloadResourceManager

Interface for downloadResourceManagers that support partial downloading of resources

Since:

5.10

Method Summary

Modifier and Type	Method and Description
PartialDownloadResourceReader	getPartialResourceReader(String userName, String resourcePath, Map parameters, String requestRange) Returns a DownloadResourceReader for part of a downloadable resource.

Methods inherited from interface com.atlassian.confluence.importexport.resource.DownloadResourceManager

getResourceReader, matches

Method Detail

getPartialResourceReader

PartialDownloadResourceReader getPartialResourceReader(String userName,
                                                       String resourcePath,
                                                       Map parameters,
                                                       String requestRange)
                                                throws UnauthorizedDownloadResourceException,
                                                       DownloadResourceNotFoundException,
                                                       RangeNotSatisfiableException

Returns a DownloadResourceReader for part of a downloadable resource. Currently being used by attachment downloads

Use this method only if DownloadResourceManager.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

requestRange - range of the resource as defined in RFC-2616 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.1

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

RangeNotSatisfiableException - if the requested range cannot be served