org.nuxeo.ecm.core.blob

Interface BlobProvider

All Known Subinterfaces:

ExtendedBlobProvider

All Known Implementing Classes:

BinaryBlobProvider, DropboxBlobProvider, GoogleDriveBlobProvider

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.
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the blob provider.
Blob	readBlob(BlobManager.BlobInfo blobInfo) Reads a Blob from storage.
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