org.nuxeo.ecm.core.storage.sql

Class SQLBinaryManager

java.lang.Object

org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

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

All Implemented Interfaces:

BinaryManager

public class SQLBinaryManager
extends CachingBinaryManager

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_SIZE_PREFIX
static String	CACHE_SIZE_PROP
protected String	checkSql
static String	COL_BIN
static String	COL_ID
static String	COL_MARK
protected String	dataSourceName
static String	DEFAULT_CACHE_SIZE
protected static boolean	disableCheckExisting
static String	DS_PREFIX
static String	DS_PROP
protected String	gcMarkSql
protected String	gcStartSql
protected String	gcStatsSql
protected String	gcSweepSql
protected String	getLengthSql
protected String	getSql
protected String	putSql
protected static boolean	resetCache
static String	TABLE_PREFIX
static String	TABLE_PROP

Fields inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

cachedir, fileCache, fileStorage, LEN_DIGEST_SUFFIX

Fields inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

blobProviderId, DEFAULT_DEPTH, DEFAULT_DIGEST, descriptor, DIGESTS_BY_LENGTH, garbageCollector, MAX_BUF_SIZE, MD5_DIGEST, MD5_DIGEST_LENGTH, MIN_BUF_SIZE, SHA1_DIGEST, SHA1_DIGEST_LENGTH, SHA256_DIGEST, SHA256_DIGEST_LENGTH

Fields inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager

PROP_KEY, PROP_PATH

Constructor Summary

Constructors

Constructor and Description
SQLBinaryManager()

Method Summary

Modifier and Type	Method and Description
protected void	createGarbageCollector()
protected void	createSql(String tableName)
Binary	getBinary(InputStream in) Creates a binary value from the given input stream.
Binary	getBinary(String digest) Returns a Binary corresponding to the given digest.
protected Connection	getConnection()
protected Dialect	getDialect()
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the binary manager.
protected static boolean	isDuplicateKeyException(SQLException e)
protected static String	loggedValue(Serializable value)
protected static void	logSQL(String sql, Serializable... values)

Methods inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

close, getFile, getLength, getLengthFromCache, initializeCache, initializeCache, putLengthInCache

Methods inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

getBinary, getDefaultDigestAlgorithm, getDescriptor, getDigestAlgorithm, getGarbageCollector, removeBinaries, storeAndDigest, toHexString

Methods inherited from class java.lang.Object

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

Field Detail

DS_PROP

public static final String DS_PROP

See Also:

Constant Field Values

DS_PREFIX

public static final String DS_PREFIX

See Also:

Constant Field Values

TABLE_PROP

public static final String TABLE_PROP

See Also:

Constant Field Values

TABLE_PREFIX

public static final String TABLE_PREFIX

See Also:

Constant Field Values

CACHE_SIZE_PROP

public static final String CACHE_SIZE_PROP

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

dataSourceName

protected String dataSourceName

checkSql

protected String checkSql

putSql

protected String putSql

getSql

protected String getSql

getLengthSql

protected String getLengthSql

gcStartSql

protected String gcStartSql

gcMarkSql

protected String gcMarkSql

gcStatsSql

protected String gcStatsSql

gcSweepSql

protected String gcSweepSql

disableCheckExisting

protected static boolean disableCheckExisting

resetCache

protected static boolean resetCache

Constructor Detail

SQLBinaryManager

public SQLBinaryManager()

Method Detail

initialize

public void initialize(String blobProviderId,
                       Map<String,String> properties)
                throws IOException

Description copied from interface: BinaryManager

Initializes the binary manager.

Specified by:

initialize in interface BinaryManager

Overrides:

initialize in class CachingBinaryManager

Parameters:

blobProviderId - the blob provider id for this binary manager

properties - initialization properties

Throws:

IOException

createGarbageCollector

protected void createGarbageCollector()

createSql

protected void createSql(String tableName)
                  throws IOException

Throws:

IOException

getDialect

protected Dialect getDialect()
                      throws IOException

Throws:

IOException

getConnection

protected Connection getConnection()
                            throws SQLException

Throws:

SQLException

logSQL

protected static void logSQL(String sql,
                             Serializable... values)

loggedValue

protected static String loggedValue(Serializable value)

isDuplicateKeyException

protected static boolean isDuplicateKeyException(SQLException e)

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 CachingBinaryManager

Parameters:

digest - the digest, or null

Returns:

the corresponding binary

getBinary

public Binary getBinary(InputStream in)
                 throws IOException

Description copied from class: AbstractBinaryManager

Creates a binary value from the given input stream.

Overrides:

getBinary in class CachingBinaryManager

Throws:

IOException