org.nuxeo.ecm.core.blob

Interface BlobManager

All Known Implementing Classes:

BlobManagerComponent

public interface BlobManager

Service managing the storage and retrieval of Blobs, through internally-registered BlobProviders.

Since:

7.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlobManager.BlobInfo Class describing information from a Blob, suitable for serialization and storage.
static class	BlobManager.UsageHint Hints for returning URIs appropriate for the expected usage.

Method Summary

Modifier and Type	Method and Description
void	freezeVersion(Document doc) Freezes the blobs' versions on a document version when it is created via a check in.
BinaryManagerStatus	garbageCollectBinaries(boolean delete) Garbage collect the unused binaries.
Map<String,URI>	getAvailableConversions(Blob blob, BlobManager.UsageHint hint) Gets a map of available MIME type conversions and corresponding URI for a blob.
BlobProvider	getBlobProvider(Blob blob) Gets the blob provider for the given blob.
BlobProvider	getBlobProvider(String id) Gets the blob provider with the given id.
Map<String,BlobProvider>	getBlobProviders() Get the map of blob providers
InputStream	getConvertedStream(Blob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
InputStream	getStream(Blob blob) INTERNAL - Gets an InputStream for the data of a managed blob.
InputStream	getThumbnail(Blob blob) Gets an InputStream for a thumbnail of a blob.
URI	getURI(Blob blob, BlobManager.UsageHint hint, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a blob.
boolean	isBinariesGarbageCollectionInProgress() Checks if a garbage collection of the binaries in progress.
void	markReferencedBinary(String key, String repositoryName) INTERNAL.
void	notifyChanges(Document doc, Set<String> xpaths) Notifies the blob manager that a set of xpaths have changed on a document.
Blob	readBlob(BlobManager.BlobInfo blobInfo, String repositoryName) Reads a Blob from storage.
String	writeBlob(Blob blob, Document doc) Writes a Blob to storage and returns its key.

Method Detail

getBlobProvider

BlobProvider getBlobProvider(String id)

Gets the blob provider with the given id.

Parameters:

id - the blob provider id

Returns:

the blob provider

getBlobProvider

BlobProvider getBlobProvider(Blob blob)

Gets the blob provider for the given blob.

Returns:

the blob provider

Since:

7.4

readBlob

Blob readBlob(BlobManager.BlobInfo blobInfo,
              String repositoryName)
       throws IOException

Reads a Blob from storage.

Parameters:

blobInfo - the blob information

repositoryName - the repository to which this blob belongs

Returns:

a managed blob

Throws:

IOException

writeBlob

String writeBlob(Blob blob,
                 Document doc)
          throws IOException

Writes a Blob to storage and returns its key.

Parameters:

blob - the blob

doc - the document to which this blob belongs

Returns:

the blob key

Throws:

IOException

getStream

InputStream getStream(Blob blob)
               throws IOException

INTERNAL - Gets an InputStream for the data of a managed blob. Used by internal implementations, regular callers should call Blob.getStream().

Parameters:

blob - the blob

Returns:

the stream

Throws:

IOException

getThumbnail

InputStream getThumbnail(Blob blob)
                  throws IOException

Gets an InputStream for a thumbnail of a blob.

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

Parameters:

blob - the blob

Returns:

the thumbnail stream

Throws:

IOException

getURI

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

Gets an URI for the content of a blob.

Parameters:

blob - the blob

hint - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

getAvailableConversions

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

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

Returns:

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

Throws:

IOException

getConvertedStream

InputStream getConvertedStream(Blob 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 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

getBlobProviders

Map<String,BlobProvider> getBlobProviders()

Get the map of blob providers

Returns:

the list of blob providers

Since:

7.3

freezeVersion

void freezeVersion(Document doc)

Freezes the blobs' versions on a document version when it is created via a check in.

Parameters:

doc - the new document version

Since:

7.3

notifyChanges

void notifyChanges(Document doc,
                   Set<String> xpaths)

Notifies the blob manager that a set of xpaths have changed on a document.

Parameters:

doc - the document

xpaths - the set of changed xpaths

Since:

7.3

garbageCollectBinaries

BinaryManagerStatus garbageCollectBinaries(boolean delete)

Garbage collect the unused binaries.

Parameters:

delete - if false don't actually delete the garbage collected binaries (but still return statistics about them), if true delete them

Returns:

a status about the number of garbage collected binaries

Since:

7.4

isBinariesGarbageCollectionInProgress

boolean isBinariesGarbageCollectionInProgress()

Checks if a garbage collection of the binaries in progress.

Returns:

true if a garbage collection of the binaries is in progress

Since:

7.4

markReferencedBinary

void markReferencedBinary(String key,
                          String repositoryName)

INTERNAL. Marks a binary as referenced during garbage collection. Called back by repository implementations during garbageCollectBinaries(boolean).

Parameters:

key - the binary key

repositoryName - the repository name

Since:

7.4