org.nuxeo.ecm.core.storage.binary

Interface BinaryManager

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractBinaryManager, AESBinaryManager, CachingBinaryManager, DefaultBinaryManager, JCloudsBinaryManager, LocalBinaryManager, S3BinaryManager, SQLBinaryManager

public interface BinaryManager
extends Closeable

A binary manager stores binaries according to their digest.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the binary manager and releases all resources and temporary objects held by it.
Binary	getBinary(Blob blob) Saves the given blob into a Binary.
Binary	getBinary(String digest) Returns a Binary corresponding to the given digest.
BinaryGarbageCollector	getGarbageCollector() Returns the Binary Garbage Collector that can be used for this binary manager.
void	initialize(BinaryManagerDescriptor descriptor) Initializer.

Method Detail

initialize

void initialize(BinaryManagerDescriptor descriptor)
                throws IOException

Initializer.

Throws:

IOException

getBinary

Binary getBinary(Blob blob)
                 throws IOException

Saves the given blob into a Binary.

Returns a Binary representing the stream. The Binary includes a digest that is a sufficient representation to persist it.

If the blob is a temporary FileBlob, then the temporary file may be reused as the final storage location after being moved.

Parameters:

blob - the blob

Returns:

the corresponding binary

Throws:

IOException

Since:

7.2

getBinary

Binary getBinary(String digest)

Returns a Binary corresponding to the given digest.

A null is returned if the digest could not be found.

Parameters:

digest - the digest, or null

Returns:

the corresponding binary

getGarbageCollector

BinaryGarbageCollector getGarbageCollector()

Returns the Binary Garbage Collector that can be used for this binary manager.

Several calls to this method will return the same GC, so that its status can be monitored using BinaryGarbageCollector.isInProgress().

Returns:

the binary GC

close

void close()

Closes the binary manager and releases all resources and temporary objects held by it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable