org.nuxeo.ecm.core.blob

Interface BlobProvider

All Known Subinterfaces:

LiveConnectBlobProvider<O>

All Known Implementing Classes:

AbstractBlobProvider, AbstractCloudBinaryManager, AbstractLiveConnectBlobProvider, AzureBinaryManager, AzureCDNBinaryManager, BinaryBlobProvider, BoxBlobProvider, DropboxBlobProvider, FilesystemBlobProvider, GoogleDriveBlobProvider, GridFSBinaryManager, OneDriveBlobProvider, S3BinaryManager

public interface BlobProvider

Interface for a provider of Blobs, which knows how to read and write them.

Since:

7.2

Method Summary

Modifier and Type	Method and Description
void	close() Closes this blob provider and releases resources that may be held by it.
default ManagedBlob	freezeVersion(ManagedBlob blob, Document doc) Returns a new managed blob pointing to a fixed version of the original blob.
default List<AppLink>	getAppLinks(String user, ManagedBlob blob) Returns a list of application links for the given blob.
default Map<String,URI>	getAvailableConversions(ManagedBlob blob, BlobManager.UsageHint hint) Gets a map of available MIME type conversions and corresponding URI for a managed blob.
default BinaryManager	getBinaryManager() Gets the associated binary manager, if any.
default InputStream	getConvertedStream(ManagedBlob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
default InputStream	getStream(ManagedBlob blob) Gets an InputStream for the data of a managed blob.
default InputStream	getThumbnail(ManagedBlob blob) Gets an InputStream for a thumbnail of a managed blob.
default URI	getURI(ManagedBlob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a managed blob.
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the blob provider.
default boolean	isVersion(ManagedBlob blob) Returns true if version of the blob is a version.
default boolean	performsExternalAccessControl(BlobManager.BlobInfo blobInfo) Checks if the blob provider performs external access control checks.
Blob	readBlob(BlobManager.BlobInfo blobInfo) Reads a Blob from storage.
boolean	supportsUserUpdate() Checks if user update is supported.
String	writeBlob(Blob blob, Document doc) Writes a Blob to storage and returns information about it.

Method Detail

initialize

void initialize(String blobProviderId,
                Map<String,String> properties)
         throws IOException

Initializes the blob provider.

Parameters:

blobProviderId - the blob provider id for this binary manager

properties - initialization properties

Throws:

IOException

Since:

7.3

close

void close()

Closes this blob provider and releases resources that may be held by it.

Since:

7.3

readBlob

Blob readBlob(BlobManager.BlobInfo blobInfo)
       throws IOException

Reads a Blob from storage.

Parameters:

blobInfo - the blob information

Returns:

the blob

Throws:

IOException

writeBlob

String writeBlob(Blob blob,
                 Document doc)
          throws IOException

Writes a Blob to storage and returns information about it.

Called to store a user-created blob.

Parameters:

blob - the blob

doc - the document to which this blob belongs

Returns:

the blob key

Throws:

IOException

supportsUserUpdate

boolean supportsUserUpdate()

Checks if user update is supported.

A user update refers to the fact that a blob from this provider may be overwritten with another blob, wherever the original blob may occur (usually in a document property).

Returns:

true if user update is supported

Since:

7.10

getStream

default InputStream getStream(ManagedBlob blob)
                       throws IOException

Gets an InputStream for the data of a managed blob.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Parameters:

blob - the managed blob

Returns:

the stream

Throws:

IOException

Since:

7.3

getThumbnail

default InputStream getThumbnail(ManagedBlob blob)
                          throws IOException

Gets an InputStream for a thumbnail of a managed blob.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Parameters:

blob - the managed blob

Returns:

the stream

Throws:

IOException

Since:

7.3

getURI

default URI getURI(ManagedBlob blob,
                   BlobManager.UsageHint hint,
                   javax.servlet.http.HttpServletRequest servletRequest)
            throws IOException

Gets an URI for the content of a managed blob.

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

Since:

7.4

getAvailableConversions

default Map<String,URI> getAvailableConversions(ManagedBlob blob,
                                                BlobManager.UsageHint hint)
                                         throws IOException

Gets a map of available MIME type conversions and corresponding URI for a managed blob.

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

Returns:

a map of MIME types and URI, which may be empty

Throws:

IOException

Since:

7.3

getConvertedStream

default InputStream getConvertedStream(ManagedBlob blob,
                                       String mimeType,
                                       DocumentModel doc)
                                throws IOException

Gets an InputStream for a conversion to the given MIME type.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Parameters:

blob - the managed blob

mimeType - the MIME type to convert to

doc - the document that holds the blob

Returns:

the stream, or null if no conversion is available for the given MIME type

Throws:

IOException

Since:

7.3

freezeVersion

default ManagedBlob freezeVersion(ManagedBlob blob,
                                  Document doc)
                           throws IOException

Returns a new managed blob pointing to a fixed version of the original blob.

Parameters:

blob - the original managed blob

doc - the document that holds the blob

Returns:

a managed blob with fixed version, or null if no change is needed

Throws:

IOException

Since:

7.3

isVersion

default boolean isVersion(ManagedBlob blob)

Returns true if version of the blob is a version.

Parameters:

blob - the managed blob

Returns:

true if the blob is a version or a revision

Since:

7.3

getAppLinks

default List<AppLink> getAppLinks(String user,
                                  ManagedBlob blob)
                           throws IOException

Returns a list of application links for the given blob.

Throws:

IOException

Since:

7.3

getBinaryManager

default BinaryManager getBinaryManager()

Gets the associated binary manager, if any.

Returns:

the binary manager, or null

Since:

7.4

performsExternalAccessControl

default boolean performsExternalAccessControl(BlobManager.BlobInfo blobInfo)

Checks if the blob provider performs external access control checks.

Parameters:

blobInfo - the blob information to be read

Returns:

true if the provider performs security checks before reading a blob, false otherwise

Since:

8.4