org.apache.jackrabbit.api.binary

Interface BinaryDownload

All Superinterfaces:

Binary

@ProviderType
public interface BinaryDownload
extends Binary

This extension interface provides a mechanism whereby a client can download a Binary directly from a storage location.

Method Summary

Modifier and Type	Method and Description
@Nullable URI	getURI(BinaryDownloadOptions downloadOptions) Get a URI for downloading a Binary directly from a storage location with the provided BinaryDownloadOptions.

Methods inherited from interface javax.jcr.Binary

dispose, getSize, getStream, read

Method Detail

getURI

@Nullable
@Nullable URI getURI(BinaryDownloadOptions downloadOptions)
                         throws RepositoryException

Get a URI for downloading a Binary directly from a storage location with the provided BinaryDownloadOptions. This is probably a signed URI with a short TTL (time to live), although the API does not require it to be so.

The implementation will attempt to apply the specified downloadOptions to the subsequent download. For example, if the caller knows that the URI refers to a specific type of content, the caller can specify that content type by setting the internet media type and character encoding in the downloadOptions. The caller may also use a default instance obtained via BinaryDownloadOptions.DEFAULT in which case the caller is indicating that the default behavior of the service provider is acceptable.

Parameters:

downloadOptions - A BinaryDownloadOptions instance which is used to request specific options on the binary to be downloaded. BinaryDownloadOptions.DEFAULT should be used if the caller wishes to accept the service provider's default behavior.

Returns:

A URI for downloading the binary directly, or null if the binary cannot be downloaded directly or if the underlying implementation does not support this capability.

Throws:

RepositoryException - if an error occurs trying to locate the binary.