org.nuxeo.ecm.core.io.download

Class DownloadServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.io.download.DownloadServiceImpl

All Implemented Interfaces:

DownloadService, Adaptable, Component, Extensible, TimestampedService

public class DownloadServiceImpl
extends DefaultComponent
implements DownloadService

This service allows the download of blobs to a HTTP response.

Since:

7.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DownloadServiceImpl.Action
static class	DownloadServiceImpl.DownloadPermissionRegistry

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.io.download.DownloadService

DownloadService.ByteRange

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DOWNLOAD_BUFFER_SIZE
protected RedirectResolver	redirectResolver
protected List<RedirectResolverDescriptor>	redirectResolverContributions

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Fields inherited from interface org.nuxeo.ecm.core.io.download.DownloadService

BLOBHOLDER_0, BLOBHOLDER_PREFIX, EVENT_NAME, NXBIGBLOB, NXBIGFILE, NXBIGZIPFILE, NXBLOBSTATUS, NXDOWNLOADINFO, NXFILE, TRANSIENT_STORE_PARAM_ERROR, TRANSIENT_STORE_PARAM_PROGRESS, TRANSIENT_STORE_STORE_NAME

Constructor Summary

Constructors

Constructor and Description
DownloadServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addCacheControlHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Internet Explorer file downloads over SSL do not work with certain HTTP cache control headers
boolean	checkPermission(DocumentModel doc, String xpath, Blob blob, String reason, Map<String,Serializable> extendedInfos) Checks whether the download of the blob is allowed.
void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DocumentModel doc, String xpath, Blob blob, String filename, String reason) Triggers a blob download.
void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DocumentModel doc, String xpath, Blob blob, String filename, String reason, Map<String,Serializable> extendedInfos) Triggers a blob download.
void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DocumentModel doc, String xpath, Blob blob, String filename, String reason, Map<String,Serializable> extendedInfos, Boolean inline) Triggers a blob download.
void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DocumentModel doc, String xpath, Blob blob, String filename, String reason, Map<String,Serializable> extendedInfos, Boolean inline, Consumer<DownloadService.ByteRange> blobTransferer) Triggers a blob download.
void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String key, String reason) Triggers a blobs download.
protected void	downloadBlob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String key, String reason, boolean status)
void	downloadBlobStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String key, String reason) Triggers a AsyncBlob download which gives information about an asynchronous blob.
protected String	fixXPath(String xpath)
protected static boolean	forceNoCacheOnMSIE()
protected org.apache.commons.lang3.tuple.Pair<String,DownloadServiceImpl.Action>	getDownloadPathAndAction(String path) Gets the download path and action of the URL to use to download blobs.
String	getDownloadUrl(DocumentModel doc, String xpath, String filename) Gets the URL to use to download the blob at the given xpath in the given document.
String	getDownloadUrl(String storeKey) Gets the URL to use to download the blobs identified by a storage key.
String	getDownloadUrl(String repositoryName, String docId, String xpath, String filename) Gets the URL to use to download the blob at the given xpath in the given document.
protected String	getFilenameWithoutPath(String filename)
protected static NuxeoPrincipal	getPrincipal()
void	handleDownload(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String baseUrl, String path) Handles the download of a document.
protected void	handleDownload(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String downloadPath, String baseUrl, boolean info)
void	logDownload(DocumentModel doc, String xpath, String filename, String reason, Map<String,Serializable> extendedInfos) Logs a download.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
Blob	resolveBlob(DocumentModel doc) Finds a document's blob.
Blob	resolveBlob(DocumentModel doc, String xpath) Finds a document's blob given an xpath or blobholder index
Blob	resolveBlobFromDownloadUrl(String url) Finds a document's blob given the URL to use to download the blob.
String	storeBlobs(List<Blob> blobs) Stores the blobs for later download.
protected void	transferBlobWithByteRange(Blob blob, DownloadService.ByteRange byteRange, javax.servlet.http.HttpServletResponse response)
void	transferBlobWithByteRange(Blob blob, DownloadService.ByteRange byteRange, Supplier<OutputStream> outputStreamSupplier) Copies the blob stream at the given byte range into the supplied OutputStream.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, deactivate, getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, start, stop, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

DOWNLOAD_BUFFER_SIZE

protected static final int DOWNLOAD_BUFFER_SIZE

See Also:

Constant Field Values

redirectResolver

protected RedirectResolver redirectResolver

redirectResolverContributions

protected List<RedirectResolverDescriptor> redirectResolverContributions

Constructor Detail

DownloadServiceImpl

public DownloadServiceImpl()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

storeBlobs

public String storeBlobs(List<Blob> blobs)

Stores the blobs for later download. Multipart download are not yet supported. You can only provide a blob singleton at this time.

Specified by:

storeBlobs in interface DownloadService

Returns:

the store key used for retrieving the blobs (@see DownloadService.getDownloadUrl(String)

getDownloadUrl

public String getDownloadUrl(DocumentModel doc,
                             String xpath,
                             String filename)

Description copied from interface: DownloadService

Gets the URL to use to download the blob at the given xpath in the given document.

The URL is relative to the Nuxeo Web Application context.

Returns something like nxbigfile/reponame/docuuid/blobholder:0/foo.jpg

Specified by:

getDownloadUrl in interface DownloadService

Parameters:

doc - the document

xpath - the blob's xpath or blobholder index, or null for default

filename - the blob's filename, or null for default

Returns:

the download URL

getDownloadUrl

public String getDownloadUrl(String repositoryName,
                             String docId,
                             String xpath,
                             String filename)

Description copied from interface: DownloadService

Gets the URL to use to download the blob at the given xpath in the given document.

The URL is relative to the Nuxeo Web Application context.

Returns something like nxbigfile/reponame/docuuid/blobholder:0/foo.jpg

Specified by:

getDownloadUrl in interface DownloadService

Parameters:

repositoryName - the document repository

docId - the document id

xpath - the blob's xpath or blobholder index, or null for default

filename - the blob's filename, or null for default

Returns:

the download URL

getFilenameWithoutPath

protected String getFilenameWithoutPath(String filename)

getDownloadUrl

public String getDownloadUrl(String storeKey)

Description copied from interface: DownloadService

Gets the URL to use to download the blobs identified by a storage key.

The URL is relative to the Nuxeo Web Application context.

Returns something like nxbigblob/key

Specified by:

getDownloadUrl in interface DownloadService

Returns:

the download URL

getDownloadPathAndAction

protected org.apache.commons.lang3.tuple.Pair<String,DownloadServiceImpl.Action> getDownloadPathAndAction(String path)

Gets the download path and action of the URL to use to download blobs. For instance, from the path "nxfile/default/3727ef6b-cf8c-4f27-ab2c-79de0171a2c8/files:files/0/file/image.png", the pair ("default/3727ef6b-cf8c-4f27-ab2c-79de0171a2c8/files:files/0/file/image.png", Action.DOWNLOAD_FROM_DOC) is returned.

Parameters:

path - the path of the URL to use to download blobs

Returns:

the pair download path and action

Since:

9.1

resolveBlobFromDownloadUrl

public Blob resolveBlobFromDownloadUrl(String url)

Description copied from interface: DownloadService

Finds a document's blob given the URL to use to download the blob.

Specified by:

resolveBlobFromDownloadUrl in interface DownloadService

Parameters:

url - the URL to use to download the blob

Returns:

the blob, or null if not found

handleDownload

public void handleDownload(javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse resp,
                           String baseUrl,
                           String path)
                    throws IOException

Description copied from interface: DownloadService

Handles the download of a document.

Specified by:

handleDownload in interface DownloadService

Parameters:

req - the request

resp - the response

baseUrl - the request baseUrl

path - the request path, without the context

Throws:

IOException

handleDownload

protected void handleDownload(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              String downloadPath,
                              String baseUrl,
                              boolean info)
                       throws IOException

Throws:

IOException

downloadBlobStatus

public void downloadBlobStatus(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               String key,
                               String reason)
                        throws IOException

Description copied from interface: DownloadService

Triggers a AsyncBlob download which gives information about an asynchronous blob.

Specified by:

downloadBlobStatus in interface DownloadService

key - the stored blobs key

reason - the download reason

Throws:

IOException

downloadBlob

public void downloadBlob(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         String key,
                         String reason)
                  throws IOException

Description copied from interface: DownloadService

Triggers a blobs download. Once the temporary blobs are transfered from the store, they are automatically deleted. The returned HTTP Status Code is 200 if the blob is ready or 202 if it is still being processed.

Specified by:

downloadBlob in interface DownloadService

key - the stored blobs key

reason - the download reason

Throws:

IOException

downloadBlob

protected void downloadBlob(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String key,
                            String reason,
                            boolean status)
                     throws IOException

Throws:

IOException

downloadBlob

public void downloadBlob(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         DocumentModel doc,
                         String xpath,
                         Blob blob,
                         String filename,
                         String reason)
                  throws IOException

Description copied from interface: DownloadService

Triggers a blob download.

Specified by:

downloadBlob in interface DownloadService

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

Throws:

IOException

downloadBlob

public void downloadBlob(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         DocumentModel doc,
                         String xpath,
                         Blob blob,
                         String filename,
                         String reason,
                         Map<String,Serializable> extendedInfos)
                  throws IOException

Description copied from interface: DownloadService

Triggers a blob download.

Specified by:

downloadBlob in interface DownloadService

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

extendedInfos - an optional map of extended informations to log

Throws:

IOException

downloadBlob

public void downloadBlob(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         DocumentModel doc,
                         String xpath,
                         Blob blob,
                         String filename,
                         String reason,
                         Map<String,Serializable> extendedInfos,
                         Boolean inline)
                  throws IOException

Description copied from interface: DownloadService

Triggers a blob download.

Specified by:

downloadBlob in interface DownloadService

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

extendedInfos - an optional map of extended informations to log

inline - if not null, force the inline flag for content-disposition

Throws:

IOException

downloadBlob

public void downloadBlob(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         DocumentModel doc,
                         String xpath,
                         Blob blob,
                         String filename,
                         String reason,
                         Map<String,Serializable> extendedInfos,
                         Boolean inline,
                         Consumer<DownloadService.ByteRange> blobTransferer)
                  throws IOException

Description copied from interface: DownloadService

Triggers a blob download. The actual byte transfer is done through a DownloadExecutor.

Specified by:

downloadBlob in interface DownloadService

doc - the document, if available

xpath - the blob's xpath or blobholder index, if available

blob - the blob, if already fetched

filename - the filename to use

reason - the download reason

extendedInfos - an optional map of extended informations to log

inline - if not null, force the inline flag for content-disposition

blobTransferer - the transferer of the actual blob

Throws:

IOException

transferBlobWithByteRange

protected void transferBlobWithByteRange(Blob blob,
                                         DownloadService.ByteRange byteRange,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws UncheckedIOException

Throws:

UncheckedIOException

transferBlobWithByteRange

public void transferBlobWithByteRange(Blob blob,
                                      DownloadService.ByteRange byteRange,
                                      Supplier<OutputStream> outputStreamSupplier)
                               throws UncheckedIOException

Description copied from interface: DownloadService

Copies the blob stream at the given byte range into the supplied OutputStream.

Specified by:

transferBlobWithByteRange in interface DownloadService

Parameters:

blob - the blob

byteRange - the byte range

outputStreamSupplier - the OutputStream supplier

Throws:

UncheckedIOException

fixXPath

protected String fixXPath(String xpath)

resolveBlob

public Blob resolveBlob(DocumentModel doc)

Description copied from interface: DownloadService

Finds a document's blob.

Specified by:

resolveBlob in interface DownloadService

Parameters:

doc - the document

Returns:

the blob, or null if not available

resolveBlob

public Blob resolveBlob(DocumentModel doc,
                        String xpath)

Description copied from interface: DownloadService

Finds a document's blob given an xpath or blobholder index

Specified by:

resolveBlob in interface DownloadService

Parameters:

doc - the document

xpath - the xpath or blobholder index

Returns:

the blob, or null if not found

checkPermission

public boolean checkPermission(DocumentModel doc,
                               String xpath,
                               Blob blob,
                               String reason,
                               Map<String,Serializable> extendedInfos)

Description copied from interface: DownloadService

Checks whether the download of the blob is allowed.

Specified by:

checkPermission in interface DownloadService

Parameters:

doc - the doc for which this download occurs, if available

blob - the blob

reason - the download reason

extendedInfos - an optional map of extended informations to log

Returns:

true if download is allowed

addCacheControlHeaders

protected void addCacheControlHeaders(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Internet Explorer file downloads over SSL do not work with certain HTTP cache control headers

See http://support.microsoft.com/kb/323308/

What is not mentioned in the above Knowledge Base is that "Pragma: no-cache" also breaks download in MSIE over SSL

forceNoCacheOnMSIE

protected static boolean forceNoCacheOnMSIE()

logDownload

public void logDownload(DocumentModel doc,
                        String xpath,
                        String filename,
                        String reason,
                        Map<String,Serializable> extendedInfos)

Description copied from interface: DownloadService

Logs a download.

Specified by:

logDownload in interface DownloadService

Parameters:

doc - the doc for which this download occurs, if available

xpath - the blob's xpath or blobholder index, if available

filename - the filename

reason - the download reason

extendedInfos - an optional map of extended informations to log

getPrincipal

protected static NuxeoPrincipal getPrincipal()