org.gridgain.grid.cache.store

Class GridCacheStoreAdapter<K,V>

java.lang.Object

org.gridgain.grid.cache.store.GridCacheStoreAdapter<K,V>

All Implemented Interfaces:

GridCacheStore<K,V>

Direct Known Subclasses:

GridCacheJdbcBlobStore

public abstract class GridCacheStoreAdapter<K,V>
extends Object
implements GridCacheStore<K,V>

Cache storage convenience adapter. It provides default implementation for bulk operations, such as loadAll(GridCacheTx, Collection, GridBiInClosure), putAll(GridCacheTx, Map), abd removeAll(GridCacheTx, Collection) by sequentially calling corresponding GridCacheStore.load(GridCacheTx, Object), GridCacheStore.put(GridCacheTx, Object, Object), and GridCacheStore.remove(GridCacheTx, Object) operations. Use this adapter whenever such behaviour is acceptable. However in many cases it maybe more preferable to take advantage of database batch update functionality, and therefore default adapter implementation may not be the best option.

Note that method loadCache(GridBiInClosure, Object...) has empty implementation because it is essentially up to the user to invoke it with specific arguments.

Constructor Summary

Constructors

Constructor and Description
GridCacheStoreAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	loadAll(GridCacheTx tx, Collection<? extends K> keys, GridBiInClosure<K,V> c) Loads all values for given keys and passes every value to the provided closure.
void	loadCache(GridBiInClosure<K,V> clo, Object... args) Default empty implementation.
void	putAll(GridCacheTx tx, Map<? extends K,? extends V> map) Stores given key value pairs in persistent storage.
void	removeAll(GridCacheTx tx, Collection<? extends K> keys) Removes all vales identified by given keys from persistent storage.
void	txEnd(GridCacheTx tx, boolean commit) Default empty implementation for ending transactions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.cache.store.GridCacheStore

load, put, remove

Constructor Detail

GridCacheStoreAdapter

public GridCacheStoreAdapter()

Method Detail

loadCache

public void loadCache(GridBiInClosure<K,V> clo,
             Object... args)
               throws GridException

Default empty implementation. This method needs to be overridden only if GridCache.loadCache(GridBiPredicate, long, Object...) method is explicitly called.

Specified by:

loadCache in interface GridCacheStore<K,V>

Parameters:

clo - Closure for loaded values.

args - Arguments passes into GridCache.loadCache(GridBiPredicate, long, Object...) method.

Throws:

GridException - If loading failed.

loadAll

public void loadAll(@Nullable
           GridCacheTx tx,
           Collection<? extends K> keys,
           GridBiInClosure<K,V> c)
             throws GridException

Loads all values for given keys and passes every value to the provided closure.

For every loaded value method GridInClosure.apply(Object) should be called on the passed in closure. The closure will then make sure that the loaded value is stored in cache.

Specified by:

loadAll in interface GridCacheStore<K,V>

Parameters:

tx - Cache transaction.

keys - Collection of keys to load.

c - Closure to call for every loaded element.

Throws:

GridException - If load failed.

putAll

public void putAll(GridCacheTx tx,
          Map<? extends K,? extends V> map)
            throws GridException

Stores given key value pairs in persistent storage. Note that cache transaction is implicitly created even for a single put. However, if write-behind is configured for a particular cache, transaction object passed in the cache store will be always null.

Specified by:

putAll in interface GridCacheStore<K,V>

Parameters:

tx - Cache transaction, if write-behind is not enabled, null otherwise.

map - Values to store.

Throws:

GridException - If store failed.

removeAll

public void removeAll(GridCacheTx tx,
             Collection<? extends K> keys)
               throws GridException

Removes all vales identified by given keys from persistent storage. Note that cache transaction is implicitly created even for a single put. However, if write-behind is configured for a particular cache, transaction object passed in the cache store will be always null.

Specified by:

removeAll in interface GridCacheStore<K,V>

Parameters:

tx - Cache transaction, if write-behind is not enabled, null otherwise.

keys - Keys to remove.

Throws:

GridException - If remove failed.

txEnd

public void txEnd(GridCacheTx tx,
         boolean commit)
           throws GridException

Default empty implementation for ending transactions. Note that if explicit cache transactions are not used, then transactions do not have to be explicitly ended - for all other cases this method should be overridden with custom commit/rollback logic.

Specified by:

txEnd in interface GridCacheStore<K,V>

Parameters:

tx - Cache transaction being ended.

commit - True if transaction should commit, false for rollback.

Throws:

GridException - If commit or rollback failed. Note that commit failure in some cases may bring cache transaction into GridCacheTxState.UNKNOWN which will consequently cause all transacted entries to be invalidated.