org.infinispan.persistence.jdbc.binary

Class JdbcBinaryStore

java.lang.Object

org.infinispan.persistence.jdbc.binary.JdbcBinaryStore

All Implemented Interfaces:

Lifecycle, AdvancedCacheLoader, AdvancedCacheWriter, AdvancedLoadWriteStore, CacheLoader, CacheWriter, ExternalStore

public class JdbcBinaryStore
extends Object
implements AdvancedLoadWriteStore

AdvancedLoadWriteStore implementation that will store all the buckets as rows in database, each row corresponding to a bucket. This is in contrast to JdbcStringBasedStore which stores each StoredEntry as a row in the database.

It is generally recommended to use JdbcStringBasedStore whenever possible as it performs better. Please read JdbcStringBasedStore's javadoc for more details on this.

This class has the benefit of being able to store StoredEntries that do not have String keys, at the cost of coarser grained access granularity, and inherently performance.

All the DB related configurations are described in .JdbcBinaryStoreConfiguration.

Author:

Mircea.Markus@jboss.com

See Also:

JdbcBinaryStoreConfiguration, JdbcStringBasedStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheLoader

AdvancedCacheLoader.CacheLoaderTask<K,V>, AdvancedCacheLoader.TaskContext

Nested classes/interfaces inherited from interface org.infinispan.persistence.spi.AdvancedCacheWriter

AdvancedCacheWriter.PurgeListener<K>

Constructor Summary

Constructors

Constructor and Description
JdbcBinaryStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all the data from the storage.
boolean	contains(Object key) Returns true if the storage contains an entry associated with the given key.
boolean	delete(Object key)
void	doConnectionFactoryInitialization(ConnectionFactory connectionFactory)
Integer	getBuckedId(Object key)
JdbcBinaryStoreConfiguration	getConfiguration()
ConnectionFactory	getConnectionFactory()
TableManipulation	getTableManipulation()
protected boolean	immediateLockForWriting(Integer key)
void	init(InitializationContext ctx) Used to initialize a cache loader.
protected void	insertBucket(Bucket bucket)
MarshalledEntry	load(Object key) Fetches an entry from the storage.
protected Bucket	loadBucket(Integer bucketId)
protected void	lockBucketForReading(Integer bucket) Acquires read lock on the given key.
protected void	lockBucketForWriting(Integer key) Acquires write lock on the given key.
void	process(KeyFilter filter, AdvancedCacheLoader.CacheLoaderTask task, Executor executor, boolean fetchValue, boolean fetchMetadata) Iterates in parallel over the entries in the storage using the threads from the executor pool.
void	purge(Executor threadPool, AdvancedCacheWriter.PurgeListener task) Using the thread in the pool, removed all the expired data from the persistence storage.
protected boolean	removeKeyFromBucket(Object key, Integer bucketId)
int	size() Returns the number of elements in the store.
void	start()
void	stop()
protected void	storeInBucket(MarshalledEntry me, Integer bucketId)
protected void	unlock(Integer key) Release the locks (either read or write).
protected void	updateBucket(Bucket bucket)
void	write(MarshalledEntry entry) Persists the entry to the storage.

Constructor Detail

JdbcBinaryStore

public JdbcBinaryStore()

Method Detail

init

public void init(InitializationContext ctx)

Description copied from interface: CacheLoader

Used to initialize a cache loader. Typically invoked by the PersistenceManager when setting up cache loaders.

Specified by:

init in interface CacheLoader

Specified by:

init in interface CacheWriter

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

write

public final void write(MarshalledEntry entry)

Description copied from interface: CacheWriter

Persists the entry to the storage.

Specified by:

write in interface CacheWriter

See Also:

MarshalledEntry

load

public final MarshalledEntry load(Object key)

Description copied from interface: CacheLoader

Fetches an entry from the storage. If a MarshalledEntry needs to be created here, InitializationContext.getMarshalledEntryFactory() and InitializationContext.getByteBufferFactory() should be used.

Specified by:

load in interface CacheLoader

Returns:

the entry, or null if the entry does not exist

contains

public boolean contains(Object key)

Description copied from interface: CacheLoader

Returns true if the storage contains an entry associated with the given key.

Specified by:

contains in interface CacheLoader

delete

public final boolean delete(Object key)

Specified by:

delete in interface CacheWriter

Returns:

true if the entry existed in the persistent store and it was deleted.

process

public void process(KeyFilter filter,
           AdvancedCacheLoader.CacheLoaderTask task,
           Executor executor,
           boolean fetchValue,
           boolean fetchMetadata)

Description copied from interface: AdvancedCacheLoader

Iterates in parallel over the entries in the storage using the threads from the executor pool. For each entry the CacheLoaderTask#processEntry(org.infinispan.marshall.core.MarshalledEntry, TaskContext) is invoked. Before passing an entry to the callback task, the entry should be validated against the filter. Implementors should build an AdvancedCacheLoader.TaskContext instance (implementation) that is fed to the AdvancedCacheLoader.CacheLoaderTask on every invocation. The AdvancedCacheLoader.CacheLoaderTask might invoke AdvancedCacheLoader.TaskContext.stop() at any time, so implementors of this method should verify TaskContext's state for early termination of iteration. The method should only return once the iteration is complete or as soon as possible in the case TaskContext.stop() is invoked.

Specified by:

process in interface AdvancedCacheLoader

Parameters:

filter - to validate which entries should be feed into the task. Might be null.

task - callback to be invoked in parallel for each stored entry that passes the filter check

executor - an external thread pool to be used for parallel iteration

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no pint fetching the metadata from the persistent store as well

clear

public void clear()

Description copied from interface: AdvancedCacheWriter

Removes all the data from the storage.

Specified by:

clear in interface AdvancedCacheWriter

size

public int size()

Description copied from interface: AdvancedCacheLoader

Returns the number of elements in the store.

Specified by:

size in interface AdvancedCacheLoader

purge

public void purge(Executor threadPool,
         AdvancedCacheWriter.PurgeListener task)

Description copied from interface: AdvancedCacheWriter

Using the thread in the pool, removed all the expired data from the persistence storage. For each removed entry, the supplied listener is invoked.

Specified by:

purge in interface AdvancedCacheWriter

insertBucket

protected void insertBucket(Bucket bucket)

updateBucket

protected void updateBucket(Bucket bucket)

loadBucket

protected Bucket loadBucket(Integer bucketId)

getConnectionFactory

public ConnectionFactory getConnectionFactory()

doConnectionFactoryInitialization

public void doConnectionFactoryInitialization(ConnectionFactory connectionFactory)

getTableManipulation

public TableManipulation getTableManipulation()

storeInBucket

protected void storeInBucket(MarshalledEntry me,
                 Integer bucketId)

removeKeyFromBucket

protected boolean removeKeyFromBucket(Object key,
                          Integer bucketId)

getBuckedId

public Integer getBuckedId(Object key)

unlock

protected final void unlock(Integer key)

Release the locks (either read or write).

lockBucketForWriting

protected final void lockBucketForWriting(Integer key)

Acquires write lock on the given key.

lockBucketForReading

protected final void lockBucketForReading(Integer bucket)

Acquires read lock on the given key.

immediateLockForWriting

protected final boolean immediateLockForWriting(Integer key)

getConfiguration

public JdbcBinaryStoreConfiguration getConfiguration()