Package ch.tocco.nice2.persist.core.spi.binary

Class AbstractBinaryAccessProvider

java.lang.Object

ch.tocco.nice2.persist.core.spi.binary.AbstractBinaryAccessProvider

All Implemented Interfaces:

BinaryAccessProvider

Direct Known Subclasses:

S3AccessProvider

public abstract class AbstractBinaryAccessProvider
extends Object
implements BinaryAccessProvider

Abstract implementation of BinaryAccessProvider that handles reading/writing the _nice_binary table. Subclasses can modify the statement which inserts new rows into _nice_binary (to add additional columns for example). The persistence of the actual binary is handled by the subclasses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractBinaryAccessProvider.SqlFunction<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final BinaryHashingService	binaryHashingService
protected final org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
AbstractBinaryAccessProvider(org.slf4j.Logger log, BinaryHashingService binaryHashingService)

Method Summary

Modifier and Type	Method	Description
protected abstract void	configureSqlBuilder(SqlBuilder.InsertSqlBuilder sqlBuilder)
protected abstract Binary.Store	createBinaryStore(String hash)
protected PreparedStatement	createStatementToLoadBinary(String hash, Connection connection)
protected <T> T	doWithSingleResult(ResultSet resultSet, AbstractBinaryAccessProvider.SqlFunction<T> function)
Set<com.google.common.hash.HashCode>	findUnreferencedBinaries(Connection connection, @Nullable Integer limit)
protected abstract void	handleBinaryData(Binary data, PreparedStatement statement, int index)
Binary	loadBinary(com.google.common.hash.HashCode hashCode, long size, String mimeType, String fileExtension)	create a Binary instance without executing an sql query, this method should be used if the data from _nice_binary has already been loaded.
Binary	loadBinary(com.google.common.hash.HashCode hashCode, Connection connection)	load an object from the store
boolean	removeBinary(com.google.common.hash.HashCode hashCode, Connection connection)	remove a binary from storage
protected boolean	removeBinarySearchText(String hashCode, Connection connection)
com.google.common.hash.HashCode	storeBinary(Binary binary, Connection connection)	save an object into the store

Methods inherited from class java.lang.Object

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

Field Details

log

protected final org.slf4j.Logger log

binaryHashingService

protected final BinaryHashingService binaryHashingService

Constructor Details

AbstractBinaryAccessProvider

public AbstractBinaryAccessProvider(org.slf4j.Logger log,
 BinaryHashingService binaryHashingService)

Method Details

loadBinary

public Binary loadBinary(com.google.common.hash.HashCode hashCode,
 Connection connection)

Description copied from interface: BinaryAccessProvider

load an object from the store

Specified by:

loadBinary in interface BinaryAccessProvider

Parameters:

hashCode - hash/id of the file to load

connection - Connection to use for database operations

Returns:

the object

loadBinary

public Binary loadBinary(com.google.common.hash.HashCode hashCode,
 long size,
 String mimeType,
 String fileExtension)

Description copied from interface: BinaryAccessProvider

create a Binary instance without executing an sql query, this method should be used if the data from _nice_binary has already been loaded.

Specified by:

loadBinary in interface BinaryAccessProvider

createBinaryStore

protected abstract Binary.Store createBinaryStore(String hash)

storeBinary

public com.google.common.hash.HashCode storeBinary(Binary binary,
 Connection connection)

Description copied from interface: BinaryAccessProvider

save an object into the store

Specified by:

storeBinary in interface BinaryAccessProvider

Parameters:

binary - the object to save

connection - Connection to use for database operations

Returns:

the hash/id of the saved object

configureSqlBuilder

protected abstract void configureSqlBuilder(SqlBuilder.InsertSqlBuilder sqlBuilder)

handleBinaryData

protected abstract void handleBinaryData(Binary data,
 PreparedStatement statement,
 int index)
                                  throws SQLException

Throws:

SQLException

removeBinary

public boolean removeBinary(com.google.common.hash.HashCode hashCode,
 Connection connection)

Description copied from interface: BinaryAccessProvider

remove a binary from storage

Specified by:

removeBinary in interface BinaryAccessProvider

Parameters:

hashCode - the hash of the object to remove

connection - Connection to use for database operations

removeBinarySearchText

protected boolean removeBinarySearchText(String hashCode,
 Connection connection)

findUnreferencedBinaries

public Set<com.google.common.hash.HashCode> findUnreferencedBinaries(Connection connection,
 @Nullable
 @Nullable Integer limit)

Specified by:

findUnreferencedBinaries in interface BinaryAccessProvider

Returns:

all binary hashes that are no longer referenced and may be removed

createStatementToLoadBinary

protected PreparedStatement createStatementToLoadBinary(String hash,
 Connection connection)
                                                 throws SQLException

Throws:

SQLException

doWithSingleResult

protected <T> T doWithSingleResult(ResultSet resultSet,
 AbstractBinaryAccessProvider.SqlFunction<T> function)
                            throws SQLException

Throws:

SQLException