org.infinispan.persistence.jdbc.mixed

Class JdbcMixedStore<K,V>

java.lang.Object

org.infinispan.persistence.jdbc.mixed.JdbcMixedStore<K,V>

All Implemented Interfaces:

Lifecycle, AdvancedCacheLoader<K,V>, AdvancedCacheWriter<K,V>, AdvancedLoadWriteStore<K,V>, CacheLoader<K,V>, CacheWriter<K,V>, ExternalStore<K,V>, TransactionalCacheWriter<K,V>

public class JdbcMixedStore<K,V>
extends Object
implements AdvancedLoadWriteStore<K,V>, TransactionalCacheWriter<K,V>

Cache store that combines functionality of JdbcBinaryStore and JdbcStringBasedStore. It aggregates an instance of JdbcBinaryStore and JdbcStringBasedStore, delegating work to one of them (sometimes both, see below) based on the passed in key. In order to determine which store to use it will rely on the configured Key2StringMapper )(see configuration).

The advantage it brings is the possibility of efficiently storing string(able) keyed InternalCacheEntrys, and at the same time being able to store any other keys, a la JdbcBinaryStore.

There will only be a performance cost for the aggregate operations: loadAll, fromStream, toStream and clear. For these operations there will be two distinct database call, one for each JdbcStore implementation. Most of application are only using these operations at lifecycles changes (e.g. fromStream and toStream at cluster join time, loadAll at startup for warm caches), so performance drawback shouldn't be significant (again, most of the cases).

Resource sharing - both aggregated cache stores have locks and connection pools. The locking is not shared, each loader keeping its own StripedLock instance. Also the tables (even though similar as definition) are different in order to avoid key collision. On the other hand, the connection pooling is a shared resource.

Author:

Mircea.Markus@jboss.com

See Also:

JdbcBinaryStore, 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
JdbcMixedStore()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all the data from the storage.
void	commit(Transaction transaction) Commit the provided transaction's changes to the underlying store.
boolean	contains(Object key) Returns true if the storage contains an entry associated with the given key.
boolean	delete(Object key)
JdbcBinaryStore	getBinaryStore()
JdbcMixedStoreConfiguration	getConfiguration()
ConnectionFactory	getConnectionFactory()
JdbcStringBasedStore	getStringStore()
void	init(InitializationContext ctx) Used to initialize a cache loader.
MarshalledEntry	load(Object key) Fetches an entry from the storage.
void	prepareWithModifications(Transaction transaction, BatchModification batchModification) Write modifications to the store in the prepare phase, as this is the only way we know the FINAL values of the entries.
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.
void	rollback(Transaction transaction) Rollback the provided transaction's changes to the underlying store.
int	size() Returns the number of elements in the store.
void	start() Invoked on component start
void	stop() Invoked on component stop
void	write(MarshalledEntry ed) Persists the entry to the storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.persistence.spi.CacheWriter

deleteBatch, writeBatch

Constructor Detail

JdbcMixedStore

public JdbcMixedStore()

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<K,V>

Specified by:

init in interface CacheWriter<K,V>

start

public void start()

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

stop

public void stop()

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

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<K,V>

load

public 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<K,V>

Returns:

the entry, or null if the entry does not exist

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(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<K,V>

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

write

public void write(MarshalledEntry ed)

Description copied from interface: CacheWriter

Persists the entry to the storage.

Specified by:

write in interface CacheWriter<K,V>

See Also:

MarshalledEntry

delete

public boolean delete(Object key)

Specified by:

delete in interface CacheWriter<K,V>

Returns:

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

size

public int size()

Description copied from interface: AdvancedCacheLoader

Returns the number of elements in the store.

Specified by:

size in interface AdvancedCacheLoader<K,V>

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<K,V>

clear

public void clear()

Description copied from interface: AdvancedCacheWriter

Removes all the data from the storage.

Specified by:

clear in interface AdvancedCacheWriter<K,V>

prepareWithModifications

public void prepareWithModifications(Transaction transaction,
                                     BatchModification batchModification)
                              throws PersistenceException

Description copied from interface: TransactionalCacheWriter

Write modifications to the store in the prepare phase, as this is the only way we know the FINAL values of the entries. This is required to handle scenarios where an objects value is changed after the put command has been executed, but before the commit is called on the Tx.

Specified by:

prepareWithModifications in interface TransactionalCacheWriter<K,V>

Parameters:

transaction - the current transactional context.

batchModification - an object containing the write/remove operations required for this transaction.

Throws:

PersistenceException - if an error occurs when communicating/performing writes on the underlying store.

commit

public void commit(Transaction transaction)

Description copied from interface: TransactionalCacheWriter

Commit the provided transaction's changes to the underlying store.

Specified by:

commit in interface TransactionalCacheWriter<K,V>

Parameters:

transaction - the current transactional context.

rollback

public void rollback(Transaction transaction)

Description copied from interface: TransactionalCacheWriter

Rollback the provided transaction's changes to the underlying store.

Specified by:

rollback in interface TransactionalCacheWriter<K,V>

Parameters:

transaction - the current transactional context.

getConnectionFactory

public ConnectionFactory getConnectionFactory()

getBinaryStore

public JdbcBinaryStore getBinaryStore()

getStringStore

public JdbcStringBasedStore getStringStore()

getConfiguration

public JdbcMixedStoreConfiguration getConfiguration()