org.jboss.cache.interceptors
Class CacheStoreInterceptor

java.lang.Object
  org.jboss.cache.interceptors.Interceptor
      org.jboss.cache.interceptors.MethodDispacherInterceptor
          org.jboss.cache.interceptors.CacheStoreInterceptor

All Implemented Interfaces:

CacheStoreInterceptorMBean, InterceptorMBean

public class CacheStoreInterceptor
extends MethodDispacherInterceptor
implements CacheStoreInterceptorMBean

Writes modifications back to the store on the way out: stores modifications back through the CacheLoader, either after each method call (no TXs), or at TX commit.

Version:

$Id: CacheStoreInterceptor.java 5413 2008-03-11 21:59:36Z mircea.markus $

Author:

Bela Ban

Field Summary

protected CacheLoader	loader
protected CacheLoaderConfig	loaderConfig
protected TransactionManager	tx_mgr
protected TransactionTable	tx_table

Fields inherited from class org.jboss.cache.interceptors.Interceptor

cache, configuration, last, log, next, trace

Constructor Summary

CacheStoreInterceptor()

Method Summary

Map<String,Object>	dumpStatistics() This implementation returns an empty Map.
long	getCacheLoaderStores() Returns the number of cache loader stores
protected Object	handleCommitMethod(InvocationContext ctx, GlobalTransaction gtx) Handles CacheImpl.commit(org.jboss.cache.transaction.GlobalTransaction)
protected Object	handleMoveMethod(InvocationContext ctx, Fqn from, Fqn to) Handles CacheImpl._move(org.jboss.cache.Fqn, org.jboss.cache.Fqn)
protected Object	handleOptimisticPrepareMethod(InvocationContext ctx, GlobalTransaction gtx, List modifications, Map data, org.jgroups.Address address, boolean onePhaseCommit) Handles CacheImpl.optimisticPrepare(org.jboss.cache.transaction.GlobalTransaction, java.util.List, java.util.Map, org.jgroups.Address, boolean)
protected Object	handlePrepareMethod(InvocationContext ctx, GlobalTransaction gtx, List modification, org.jgroups.Address coordinator, boolean onePhaseCommit) Handles CacheImpl.prepare(org.jboss.cache.transaction.GlobalTransaction, java.util.List, org.jgroups.Address, boolean)
protected Object	handlePutDataEraseMethod(InvocationContext ctx, GlobalTransaction gt, Fqn fqn, Map newData, boolean createUndoOps, boolean eraseContents) Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, java.util.Map, boolean, boolean)
protected Object	handlePutDataMethod(InvocationContext ctx, GlobalTransaction tx, Fqn fqn, Map data, boolean createUndoOps) Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, String, java.util.Map, boolean)
protected Object	handlePutForExternalReadMethod(InvocationContext ctx, GlobalTransaction tx, Fqn fqn, Object key, Object value) Handles CacheImpl._putForExternalRead(org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, Object, Object)
protected Object	handlePutKeyValueMethod(InvocationContext ctx, GlobalTransaction gtx, Fqn fqn, Object key, Object value, boolean createUndoOps) Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, String, Object, Object, boolean)
protected Object	handleRemoveDataMethod(InvocationContext ctx, GlobalTransaction tx, Fqn fqn, boolean createUndoOps) Handles CacheImpl._removeData(org.jboss.cache.transaction.GlobalTransaction, Fqn, boolean)
protected Object	handleRemoveKeyMethod(InvocationContext ctx, GlobalTransaction tx, Fqn fqn, Object key, boolean createUndoOps) Handles CacheImpl._remove(org.jboss.cache.transaction.GlobalTransaction, String, Object, boolean)
protected Object	handleRemoveNodeMethod(InvocationContext ctx, GlobalTransaction tx, Fqn fqn, boolean createUndoOps) remove() methods need to be applied to the CacheLoader before passing up the call: a listener might access an element just removed, causing the CacheLoader to *load* the element before *removing* it.
protected Object	handleRollbackMethod(InvocationContext ctx, GlobalTransaction gtx) Handles CacheImpl.rollback(org.jboss.cache.transaction.GlobalTransaction)
void	resetStatistics() This implementation is a no-op.
protected boolean	skipMethodCall(InvocationContext ctx) if this is a shared cache loader and the call is of remote origin, pass up the chain
protected void	startInterceptor()

Methods inherited from class org.jboss.cache.interceptors.MethodDispacherInterceptor

handleAddChildMethod, handleBlockChannelMethod, handleDataGravitationCleanupMethod, handleEvictMethod, handleEvictVersionedNodeMethod, handleExistsMethod, handleGetDataMapMethod, handleGetChildrenNamesMethod, handleGetKeysMethod, handleGetKeyValueMethod, handleGetNodeMethod, handleLockMethod, handlePrintMethod, handlePutDataEraseVersionedMethod, handlePutDataVersionedMethod, handlePutForExternalReadVersionedMethod, handlePutKeyValueVersionedMethod, handleReleaseAllLocksMethod, handleRemoveDataVersionedMethod, handleRemoveKeyVersionedMethod, handleRemoveNodeVersionedMethod, handleUnblockChannelMethod, invoke

Methods inherited from class org.jboss.cache.interceptors.Interceptor

assertTransactionValid, getLast, getNext, getStatisticsEnabled, initLogger, isActive, isPreparing, isValid, nextInterceptor, peekNode, setCache, setLast, setNext, setStatisticsEnabled, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.cache.interceptors.InterceptorMBean

getStatisticsEnabled, setStatisticsEnabled

Field Detail

loaderConfig

protected CacheLoaderConfig loaderConfig

tx_mgr

protected TransactionManager tx_mgr

tx_table

protected TransactionTable tx_table

loader

protected CacheLoader loader

Constructor Detail

CacheStoreInterceptor

public CacheStoreInterceptor()

Method Detail

startInterceptor

protected void startInterceptor()

skipMethodCall

protected boolean skipMethodCall(InvocationContext ctx)

if this is a shared cache loader and the call is of remote origin, pass up the chain

Overrides:

skipMethodCall in class MethodDispacherInterceptor

handleCommitMethod

protected Object handleCommitMethod(InvocationContext ctx,
                                    GlobalTransaction gtx)
                             throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl.commit(org.jboss.cache.transaction.GlobalTransaction)

Overrides:

handleCommitMethod in class MethodDispacherInterceptor

Throws:

Throwable

handleRollbackMethod

protected Object handleRollbackMethod(InvocationContext ctx,
                                      GlobalTransaction gtx)
                               throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl.rollback(org.jboss.cache.transaction.GlobalTransaction)

Overrides:

handleRollbackMethod in class MethodDispacherInterceptor

Throws:

Throwable

handleOptimisticPrepareMethod

protected Object handleOptimisticPrepareMethod(InvocationContext ctx,
                                               GlobalTransaction gtx,
                                               List modifications,
                                               Map data,
                                               org.jgroups.Address address,
                                               boolean onePhaseCommit)
                                        throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl.optimisticPrepare(org.jboss.cache.transaction.GlobalTransaction, java.util.List, java.util.Map, org.jgroups.Address, boolean)

Overrides:

handleOptimisticPrepareMethod in class MethodDispacherInterceptor

Throws:

Throwable

handlePrepareMethod

protected Object handlePrepareMethod(InvocationContext ctx,
                                     GlobalTransaction gtx,
                                     List modification,
                                     org.jgroups.Address coordinator,
                                     boolean onePhaseCommit)
                              throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl.prepare(org.jboss.cache.transaction.GlobalTransaction, java.util.List, org.jgroups.Address, boolean)

Overrides:

handlePrepareMethod in class MethodDispacherInterceptor

Throws:

Throwable

handleRemoveNodeMethod

protected Object handleRemoveNodeMethod(InvocationContext ctx,
                                        GlobalTransaction tx,
                                        Fqn fqn,
                                        boolean createUndoOps)
                                 throws Throwable

remove() methods need to be applied to the CacheLoader before passing up the call: a listener might access an element just removed, causing the CacheLoader to *load* the element before *removing* it.

Overrides:

handleRemoveNodeMethod in class MethodDispacherInterceptor

Throws:

Throwable

handleRemoveKeyMethod

protected Object handleRemoveKeyMethod(InvocationContext ctx,
                                       GlobalTransaction tx,
                                       Fqn fqn,
                                       Object key,
                                       boolean createUndoOps)
                                throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._remove(org.jboss.cache.transaction.GlobalTransaction, String, Object, boolean)

Overrides:

handleRemoveKeyMethod in class MethodDispacherInterceptor

Throws:

Throwable

See Also:

handleRemoveNodeMethod(org.jboss.cache.InvocationContext, org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, boolean)

handleRemoveDataMethod

protected Object handleRemoveDataMethod(InvocationContext ctx,
                                        GlobalTransaction tx,
                                        Fqn fqn,
                                        boolean createUndoOps)
                                 throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._removeData(org.jboss.cache.transaction.GlobalTransaction, Fqn, boolean)

Overrides:

handleRemoveDataMethod in class MethodDispacherInterceptor

Throws:

Throwable

See Also:

handleRemoveNodeMethod(org.jboss.cache.InvocationContext, org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, boolean)

handleMoveMethod

protected Object handleMoveMethod(InvocationContext ctx,
                                  Fqn from,
                                  Fqn to)
                           throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._move(org.jboss.cache.Fqn, org.jboss.cache.Fqn)

Overrides:

handleMoveMethod in class MethodDispacherInterceptor

Throws:

Throwable

handlePutDataEraseMethod

protected Object handlePutDataEraseMethod(InvocationContext ctx,
                                          GlobalTransaction gt,
                                          Fqn fqn,
                                          Map newData,
                                          boolean createUndoOps,
                                          boolean eraseContents)
                                   throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, java.util.Map, boolean, boolean)

Overrides:

handlePutDataEraseMethod in class MethodDispacherInterceptor

Throws:

Throwable

handlePutDataMethod

protected Object handlePutDataMethod(InvocationContext ctx,
                                     GlobalTransaction tx,
                                     Fqn fqn,
                                     Map data,
                                     boolean createUndoOps)
                              throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, String, java.util.Map, boolean)

Overrides:

handlePutDataMethod in class MethodDispacherInterceptor

Throws:

Throwable

handlePutForExternalReadMethod

protected Object handlePutForExternalReadMethod(InvocationContext ctx,
                                                GlobalTransaction tx,
                                                Fqn fqn,
                                                Object key,
                                                Object value)
                                         throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._putForExternalRead(org.jboss.cache.transaction.GlobalTransaction, org.jboss.cache.Fqn, Object, Object)

Overrides:

handlePutForExternalReadMethod in class MethodDispacherInterceptor

Throws:

Throwable

handlePutKeyValueMethod

protected Object handlePutKeyValueMethod(InvocationContext ctx,
                                         GlobalTransaction gtx,
                                         Fqn fqn,
                                         Object key,
                                         Object value,
                                         boolean createUndoOps)
                                  throws Throwable

Description copied from class: MethodDispacherInterceptor

Handles CacheImpl._put(org.jboss.cache.transaction.GlobalTransaction, String, Object, Object, boolean)

Overrides:

handlePutKeyValueMethod in class MethodDispacherInterceptor

Throws:

Throwable

getCacheLoaderStores

public long getCacheLoaderStores()

Description copied from interface: CacheStoreInterceptorMBean

Returns the number of cache loader stores

Specified by:

getCacheLoaderStores in interface CacheStoreInterceptorMBean

Returns:

the number of cache loader stores

resetStatistics

public void resetStatistics()

Description copied from class: Interceptor

This implementation is a no-op. If individual Interceptors wish to expose statistics, they can override this method.

Specified by:

resetStatistics in interface InterceptorMBean

Overrides:

resetStatistics in class Interceptor

dumpStatistics

public Map<String,Object> dumpStatistics()

Description copied from class: Interceptor

This implementation returns an empty Map. If individual Interceptors wish to expose statistics, they can override this method.

Specified by:

dumpStatistics in interface InterceptorMBean

Overrides:

dumpStatistics in class Interceptor

Returns:

a map containing statistics