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
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

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, NXBIGZIPFILE, NXDOWNLOADINFO, NXFILE

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, Consumer<DownloadService.ByteRange> blobTransferer) Triggers a blob download.
protected String	fixXPath(String xpath)
protected static boolean	forceNoCacheOnMSIE()
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 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 static NuxeoPrincipal	getPrincipal()
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, String xpath) Finds a document's blob given an xpath or blobholder index
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, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

DOWNLOAD_BUFFER_SIZE

protected static final int DOWNLOAD_BUFFER_SIZE

See Also:

Constant Field Values

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

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

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,
                         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,
                        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()