org.nuxeo.ecm.core.blob

Interface ExtendedBlobProvider

All Superinterfaces:

BlobProvider

All Known Implementing Classes:

DropboxBlobProvider, GoogleDriveBlobProvider

public interface ExtendedBlobProvider
extends BlobProvider

Interface for an extended provider of Blobs, which knows how to fetch alternate content.

Since:

7.3

Method Summary

Modifier and Type	Method and Description
ManagedBlob	freezeVersion(ManagedBlob blob) Returns a new managed blob pointing to a fixed version of the original blob.
Map<String,URI>	getAvailableConversions(ManagedBlob blob, BlobManager.UsageHint hint) Gets a map of available MIME type conversions and corresponding URI for a managed blob.
InputStream	getConvertedStream(ManagedBlob blob, String mimeType) Gets an InputStream for a conversion to the given MIME type.
InputStream	getStream(ManagedBlob blob) Gets an InputStream for the data of a managed blob.
InputStream	getThumbnail(ManagedBlob blob) Gets an InputStream for a thumbnail of a managed blob.
URI	getURI(ManagedBlob blob, BlobManager.UsageHint hint) Gets an URI for the content of a managed blob.
boolean	isVersion(ManagedBlob blob) Returns true if version of the blob is a version.

Methods inherited from interface org.nuxeo.ecm.core.blob.BlobProvider

close, initialize, readBlob, writeBlob

Method Detail

getStream

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

getThumbnail

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

getURI

URI getURI(ManagedBlob blob,
           BlobManager.UsageHint hint)
    throws IOException

Gets an URI for the content of a managed blob.

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

Returns:

the URI, or null if none available

Throws:

IOException

getAvailableConversions

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

getConvertedStream

InputStream getConvertedStream(ManagedBlob blob,
                               String mimeType)
                        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

Returns:

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

Throws:

IOException

freezeVersion

ManagedBlob freezeVersion(ManagedBlob blob)
                   throws IOException

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

Parameters:

blob - the original managed blob

Returns:

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

Throws:

IOException

isVersion

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