org.nuxeo.ecm.core.blob

Interface DocumentBlobManager

All Known Implementing Classes:

DocumentBlobManagerComponent

public interface DocumentBlobManager

Service managing Blobs associated to a Document or a repository.

Since:

9.2

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.
InputStream	getConvertedStream(Blob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
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(BlobInfo blobInfo, String repositoryName) Reads a Blob from storage.
String	writeBlob(Blob blob, Document doc, String xpath) Writes a Blob to storage and returns its key.

Method Detail

readBlob

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

Since:

7.2

writeBlob

String writeBlob(Blob blob,
                 Document doc,
                 String xpath)
          throws IOException

Writes a Blob to storage and returns its key.

Parameters:

blob - the blob

doc - the document to which this blob belongs

xpath - the xpath of blob in doc

Returns:

the blob key

Throws:

IOException

Since:

9.1

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

Since:

7.2

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