org.nuxeo.ecm.core.storage.binary

Class AbstractBinaryManager

java.lang.Object

org.nuxeo.ecm.core.storage.binary.AbstractBinaryManager

All Implemented Interfaces:

Closeable, AutoCloseable, BinaryManager

Direct Known Subclasses:

CachingBinaryManager, LocalBinaryManager

public abstract class AbstractBinaryManager
extends Object
implements BinaryManager

Abstract BinaryManager implementation that provides a few utilities

Author:

Florent Guillaume

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DEPTH
static String	DEFAULT_DIGEST
static int	MAX_BUF_SIZE
static int	MIN_BUF_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractBinaryManager()

Method Summary

Methods

Modifier and Type	Method and Description
Binary	getBinary(Blob blob) Saves the given blob into a Binary.
abstract 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.
abstract void	initialize(BinaryManagerDescriptor binaryManagerDescriptor) Initializer.
static String	toHexString(byte[] data)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.storage.binary.BinaryManager

close

Field Detail

DEFAULT_DIGEST

public static final String DEFAULT_DIGEST

See Also:

Constant Field Values

DEFAULT_DEPTH

public static final int DEFAULT_DEPTH

See Also:

Constant Field Values

MIN_BUF_SIZE

public static final int MIN_BUF_SIZE

See Also:

Constant Field Values

MAX_BUF_SIZE

public static final int MAX_BUF_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractBinaryManager

public AbstractBinaryManager()

Method Detail

initialize

public abstract void initialize(BinaryManagerDescriptor binaryManagerDescriptor)
                         throws IOException

Description copied from interface: BinaryManager

Initializer.

Specified by:

initialize in interface BinaryManager

Throws:

IOException

getBinary

public Binary getBinary(Blob blob)
                 throws IOException

Description copied from interface: BinaryManager

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.

Specified by:

getBinary in interface BinaryManager

Parameters:

blob - the blob

Returns:

the corresponding binary

Throws:

IOException

getBinary

public abstract Binary getBinary(String digest)

Description copied from interface: BinaryManager

Returns a Binary corresponding to the given digest.

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

Specified by:

getBinary in interface BinaryManager

Parameters:

digest - the digest, or null

Returns:

the corresponding binary

toHexString

public static String toHexString(byte[] data)

getGarbageCollector

public BinaryGarbageCollector getGarbageCollector()

Description copied from interface: BinaryManager

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().

Specified by:

getGarbageCollector in interface BinaryManager

Returns:

the binary GC