org.nuxeo.ecm.core.storage.sql

Class BinaryCachingManager

java.lang.Object

org.nuxeo.ecm.core.storage.sql.BinaryCachingManager

All Implemented Interfaces:

BinaryManager

Direct Known Subclasses:

JCloudsBinaryManager, S3BinaryManager, SQLBinaryManager

public abstract class BinaryCachingManager
extends Object

Since:

5.7

Author:

"Stephane Lacoin (aka matic) slacoin@nuxeo.com"

See Also:

file cache not serializable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBinaryManager.NullBinaryScrambler A BinaryScrambler that does nothing.
static class	AbstractBinaryManager.ScrambledBinary A Binary that is unscrambled on read using a BinaryScrambler.
static class	AbstractBinaryManager.ScrambledFileInputStream A FileInputStream that is unscrambled on read using a BinaryScrambler.
static class	AbstractBinaryManager.ScrambledStreamSource A FileSource that is unscrambled on read using a BinaryScrambler.

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

Method Summary

Methods

Modifier and Type	Method and Description
abstract BinaryFileCache	fileCache()
abstract 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.
abstract void	initialize(RepositoryDescriptor repositoryDescriptor) Initializer.
static String	toHexString(byte[] data)

Methods inherited from class java.lang.Object

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

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

BinaryCachingManager

public BinaryCachingManager()

Method Detail

fileCache

public abstract BinaryFileCache fileCache()

getBinary

public 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

initialize

public abstract void initialize(RepositoryDescriptor repositoryDescriptor)
                         throws IOException

Description copied from interface: BinaryManager

Initializer.

Specified by:

initialize in interface BinaryManager

Throws:

IOException

getBinary

public abstract Binary getBinary(InputStream in)
                          throws IOException

Description copied from interface: BinaryManager

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.

Specified by:

getBinary in interface BinaryManager

Parameters:

in - the input stream

Returns:

the corresponding binary

Throws:

IOException

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