org.nuxeo.ecm.core.io.download

Interface DownloadService

All Known Implementing Classes:

DownloadServiceImpl

public interface DownloadService

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

Since:

7.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DownloadService.ByteRange

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOBHOLDER_0
static String	BLOBHOLDER_PREFIX
static String	EVENT_NAME
static String	NXBIGBLOB
static String	NXBIGFILE Deprecated. since 7.4, use nxfile instead
static String	NXBIGZIPFILE Deprecated. since 9.1, use nxbigblob instead
static String	NXDOWNLOADINFO
static String	NXFILE

Method Summary

Modifier and Type	Method and Description
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 storeKey, String reason) Triggers a blobs download.
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.
void	handleDownload(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String baseUrl, String path) Handles the download of a document.
void	logDownload(DocumentModel doc, String blobXPath, String filename, String reason, Map<String,Serializable> extendedInfos) Logs a download.
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.
void	transferBlobWithByteRange(Blob blob, DownloadService.ByteRange byteRange, Supplier<OutputStream> outputStreamSupplier) Copies the blob stream at the given byte range into the supplied OutputStream.

Field Detail

EVENT_NAME

static final String EVENT_NAME

See Also:

Constant Field Values

NXFILE

static final String NXFILE

See Also:

Constant Field Values

NXDOWNLOADINFO

static final String NXDOWNLOADINFO

See Also:

Constant Field Values

NXBIGBLOB

static final String NXBIGBLOB

See Also:

Constant Field Values

NXBIGZIPFILE

@Deprecated
static final String NXBIGZIPFILE

Deprecated. since 9.1, use nxbigblob instead

See Also:

Constant Field Values

NXBIGFILE

@Deprecated
static final String NXBIGFILE

Deprecated. since 7.4, use nxfile instead

See Also:

Constant Field Values

BLOBHOLDER_PREFIX

static final String BLOBHOLDER_PREFIX

See Also:

Constant Field Values

BLOBHOLDER_0

static final String BLOBHOLDER_0

See Also:

Constant Field Values

Method Detail

storeBlobs

String storeBlobs(List<Blob> blobs)

Stores the blobs for later download.

Parameters:

the - list of blobs to store

Returns:

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

Since:

9.1

getDownloadUrl

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.

The URL is relative to the Nuxeo Web Application context.

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

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

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.

The URL is relative to the Nuxeo Web Application context.

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

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

getDownloadUrl

String getDownloadUrl(String storeKey)

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

Parameters:

key - The key of stored blobs to download

Returns:

the download URL

Since:

9.1

resolveBlobFromDownloadUrl

Blob resolveBlobFromDownloadUrl(String url)

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

Parameters:

url - the URL to use to download the blob

Returns:

the blob, or null if not found

Since:

9.1

handleDownload

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

Handles the download of a document.

Parameters:

req - the request

resp - the response

baseUrl - the request baseUrl

path - the request path, without the context

Throws:

IOException

Since:

9.1

downloadBlob

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

Triggers a blobs download. Once the temporary blobs are transfered from the store, they are automatically deleted.

Parameters:

storeKey - the stored blobs key

reason - the download reason

Throws:

IOException

Since:

9.1

downloadBlob

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

Triggers a blob download.

Parameters:

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

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

Triggers a blob download.

Parameters:

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

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

Triggers a blob download.

Parameters:

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

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

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

Parameters:

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

Since:

7.10

transferBlobWithByteRange

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

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

Parameters:

blob - the blob

byteRange - the byte range

outputStreamSupplier - the OutputStream supplier

Since:

7.10

logDownload

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

Logs a download.

Parameters:

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

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

resolveBlob

Blob resolveBlob(DocumentModel doc,
                 String xpath)

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

Parameters:

doc - the document

xpath - the xpath or blobholder index

Returns:

the blob, or null if not found

checkPermission

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

Checks whether the download of the blob is allowed.

Parameters:

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

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

blob - the blob

reason - the download reason

extendedInfos - an optional map of extended informations to log

Returns:

true if download is allowed

Since:

7.10