org.nuxeo.ecm.core.blob

Interface BlobProvider

All Known Subinterfaces:

LiveConnectBlobProvider<O>

All Known Implementing Classes:

AbstractBlobProvider, AbstractCloudBinaryManager, AbstractLiveConnectBlobProvider, AzureBinaryManager, AzureCDNBinaryManager, BinaryBlobProvider, BoxBlobProvider, CloudFrontBinaryManager, DropboxBlobProvider, DummyBlobProvider, 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
default boolean	canConvert(ManagedBlob blob, String mimeType) Checks if the conversion to the given mimeType is supported by the blob.
void	close() Closes this blob provider and releases resources that may be held by it.
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.
Map<String,String>	getProperties() Returns the properties of the blob provider.
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.
default boolean	hasCreateFromKeyPermission() Checks if current user has the rights to create blobs in the blob provider using a key.
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the blob provider.
default boolean	isTransient() Checks whether this blob provider is transient: blobs may disappear after a while, so a caller should not rely on them being available forever.
default boolean	isVersion(ManagedBlob blob) Returns true if version of the blob is a version.
default boolean	performsExternalAccessControl(BlobInfo blobInfo) Checks if the blob provider performs external access control checks.
Blob	readBlob(BlobInfo blobInfo) Reads a Blob from storage.
boolean	supportsUserUpdate() Checks if user update is supported.
String	writeBlob(Blob blob) 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

isTransient

default boolean isTransient()

Checks whether this blob provider is transient: blobs may disappear after a while, so a caller should not rely on them being available forever.

Since:

10.1

readBlob

Blob readBlob(BlobInfo blobInfo)
       throws IOException

Reads a Blob from storage.

Parameters:

blobInfo - the blob information

Returns:

the blob

Throws:

IOException

writeBlob

String writeBlob(Blob blob)
          throws IOException

Writes a Blob to storage and returns information about it.

Called to store a user-created blob.

Parameters:

blob - the blob

Returns:

the blob key

Throws:

IOException

Since:

9.2

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

canConvert

default boolean canConvert(ManagedBlob blob,
                           String mimeType)

Checks if the conversion to the given mimeType is supported by the blob.

Parameters:

blob - the managed blob

mimeType - the destination mime type

Returns:

true if this managed blob supports the conversion to the given mime type

Since:

10.1

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

getProperties

Map<String,String> getProperties()

Returns the properties of the blob provider.

Since:

10.2

hasCreateFromKeyPermission

default boolean hasCreateFromKeyPermission()

Checks if current user has the rights to create blobs in the blob provider using a key.

Since:

10.2