org.nuxeo.ecm.core.storage.sql

Class SQLBinaryManager

java.lang.Object

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

org.nuxeo.ecm.core.storage.sql.SQLBinaryManager

All Implemented Interfaces:

BinaryManager

public class SQLBinaryManager
extends BinaryCachingManager

A Binary Manager that stores binaries as SQL BLOBs.

The BLOBs are cached locally on first access for efficiency.

Because the BLOB length can be accessed independently of the binary stream, it is also cached in a simple text file if accessed before the stream.

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.
class	SQLBinaryManager.SQLBinaryFileCache
static class	SQLBinaryManager.SQLBinaryGarbageCollector

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_SIZE_PREFIX
static String	COL_BIN
static String	COL_ID
static String	COL_MARK
static String	DEFAULT_CACHE_SIZE
static int	DEFAULT_DEPTH
static String	DEFAULT_DIGEST
static String	DS_PREFIX
static int	MAX_BUF_SIZE
static int	MIN_BUF_SIZE
static String	TABLE_PREFIX

Constructor Summary

Constructors

Constructor and Description
SQLBinaryManager()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

DS_PREFIX

public static final String DS_PREFIX

See Also:

Constant Field Values

TABLE_PREFIX

public static final String TABLE_PREFIX

See Also:

Constant Field Values

CACHE_SIZE_PREFIX

public static final String CACHE_SIZE_PREFIX

See Also:

Constant Field Values

DEFAULT_CACHE_SIZE

public static final String DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

COL_ID

public static final String COL_ID

See Also:

Constant Field Values

COL_BIN

public static final String COL_BIN

See Also:

Constant Field Values

COL_MARK

public static final String COL_MARK

See Also:

Constant Field Values

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

SQLBinaryManager

public SQLBinaryManager()

Method Detail

initialize

public void initialize(RepositoryDescriptor repositoryDescriptor)
                throws IOException

Description copied from interface: BinaryManager

Initializer.

Specified by:

initialize in interface BinaryManager

Throws:

IOException

getBinary

public 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

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

Overrides:

getBinary in class BinaryCachingManager

Parameters:

digest - the digest, or null

Returns:

the corresponding binary

fileCache

public BinaryFileCache fileCache()

Specified by:

fileCache in class BinaryCachingManager

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