org.nuxeo.ecm.core.storage.sql

Interface BinaryManager

All Known Implementing Classes:

BinaryManagerClient, DefaultBinaryManager, SQLBinaryManager, XORBinaryManager

public interface BinaryManager

A binary manager stores binaries according to their digest.

Method Summary

Methods

Modifier and Type	Method and Description
Binary	getBinary(InputStream in) Saves the given input stream 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(RepositoryDescriptor repositoryDescriptor) Initializer.

Method Detail

initialize

void initialize(RepositoryDescriptor repositoryDescriptor)
                throws IOException

Initializer.

Throws:

IOException

getBinary

Binary getBinary(InputStream in)
                 throws IOException

Saves the given input stream into a Binary.

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

The stream is closed after use.

Parameters:

in - the input stream

Returns:

the corresponding binary

Throws:

IOException

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