org.jboss.cache.interceptors
Class DataGravitatorInterceptor

java.lang.Object
  org.jboss.cache.commands.AbstractVisitor
      org.jboss.cache.interceptors.base.CommandInterceptor
          org.jboss.cache.interceptors.BaseRpcInterceptor
              org.jboss.cache.interceptors.DataGravitatorInterceptor

All Implemented Interfaces:

Visitor, InterceptorMBean

public class DataGravitatorInterceptor
extends BaseRpcInterceptor

The Data Gravitator interceptor intercepts cache misses and attempts to gravitate data from other parts of the cluster.

Only used if Buddy Replication is enabled. Also, the interceptor only kicks in if an Option is passed in to force Data Gravitation for a specific invocation or if autoDataGravitation is set to true when configuring Buddy Replication.

See the JBoss Cache User Guide for more details on configuration options. There is a section dedicated to Buddy Replication in the Replication chapter.

In terms of functionality, if a gravitation call has occured and a cleanup call is needed (based on how BR is configured), a cleanup call will be broadcast immediately after the gravitation call (no txs) or if txs are used, an asynchronous call is made to perform the cleanup outside the scope of the tx that caused the gravitation event.

Author:

Manik Surtani (manik@jboss.org)

Nested Class Summary

static class

DataGravitatorInterceptor.ResponseValidityFilter

Field Summary

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

defaultSynchronous, rpcManager, txTable

Fields inherited from class org.jboss.cache.interceptors.base.CommandInterceptor

configuration, log, trace

Constructor Summary

DataGravitatorInterceptor()

Method Summary

void	injectComponents(BuddyManager buddyManager, DataContainer dataContainer, CommandsFactory commandsFactory, CacheSPI cacheSPI)
void	startInterceptor()
Object	visitCommitCommand(InvocationContext ctx, CommitCommand command) Visits a CommitCommand.
Object	visitExistsNodeCommand(InvocationContext ctx, ExistsCommand command) Visits a RemoteExistsCommand.
Object	visitGetChildrenNamesCommand(InvocationContext ctx, GetChildrenNamesCommand command) Visits a GetChildrenNamesCommand.
Object	visitGetDataMapCommand(InvocationContext ctx, GetDataMapCommand command) Visits a GetDataMapCommand.
Object	visitGetKeysCommand(InvocationContext ctx, GetKeysCommand command) Visits a GetKeysCommand.
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command) Visits a GetKeyValueCommand.
Object	visitGetNodeCommand(InvocationContext ctx, GetNodeCommand command) Visits a GetNodeCommand.
Object	visitRollbackCommand(InvocationContext ctx, RollbackCommand command) Visits a RollbackCommand.

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

checkResponses, injectComponents, isSynchronous, isTransactionalAndLocal, replicateCall, replicateCall, replicateCall, replicateCall, skipReplicationOfTransactionMethod

Methods inherited from class org.jboss.cache.interceptors.base.CommandInterceptor

dumpStatistics, getNext, getStatisticsEnabled, handleDefault, hasNext, invokeNextInterceptor, resetStatistics, setNext, setStatisticsEnabled

Methods inherited from class org.jboss.cache.commands.AbstractVisitor

visitCollection, visitCreateNodeCommand, visitEvictFqnCommand, visitGravitateDataCommand, visitInvalidateCommand, visitMoveCommand, visitOptimisticPrepareCommand, visitPrepareCommand, visitPutDataMapCommand, visitPutKeyValueCommand, visitRemoveDataCommand, visitRemoveKeyCommand, visitRemoveNodeCommand

Methods inherited from class java.lang.Object

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

Constructor Detail

DataGravitatorInterceptor

public DataGravitatorInterceptor()

Method Detail

injectComponents

public void injectComponents(BuddyManager buddyManager,
                             DataContainer dataContainer,
                             CommandsFactory commandsFactory,
                             CacheSPI cacheSPI)

startInterceptor

public void startInterceptor()

visitGetChildrenNamesCommand

public Object visitGetChildrenNamesCommand(InvocationContext ctx,
                                           GetChildrenNamesCommand command)
                                    throws Throwable

Description copied from interface: Visitor

Visits a GetChildrenNamesCommand.

Specified by:

visitGetChildrenNamesCommand in interface Visitor

Overrides:

visitGetChildrenNamesCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetDataMapCommand

public Object visitGetDataMapCommand(InvocationContext ctx,
                                     GetDataMapCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a GetDataMapCommand.

Specified by:

visitGetDataMapCommand in interface Visitor

Overrides:

visitGetDataMapCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitExistsNodeCommand

public Object visitExistsNodeCommand(InvocationContext ctx,
                                     ExistsCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a RemoteExistsCommand.

Specified by:

visitExistsNodeCommand in interface Visitor

Overrides:

visitExistsNodeCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetKeysCommand

public Object visitGetKeysCommand(InvocationContext ctx,
                                  GetKeysCommand command)
                           throws Throwable

Description copied from interface: Visitor

Visits a GetKeysCommand.

Specified by:

visitGetKeysCommand in interface Visitor

Overrides:

visitGetKeysCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetKeyValueCommand

public Object visitGetKeyValueCommand(InvocationContext ctx,
                                      GetKeyValueCommand command)
                               throws Throwable

Description copied from interface: Visitor

Visits a GetKeyValueCommand.

Specified by:

visitGetKeyValueCommand in interface Visitor

Overrides:

visitGetKeyValueCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetNodeCommand

public Object visitGetNodeCommand(InvocationContext ctx,
                                  GetNodeCommand command)
                           throws Throwable

Description copied from interface: Visitor

Visits a GetNodeCommand.

Specified by:

visitGetNodeCommand in interface Visitor

Overrides:

visitGetNodeCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitRollbackCommand

public Object visitRollbackCommand(InvocationContext ctx,
                                   RollbackCommand command)
                            throws Throwable

Description copied from interface: Visitor

Visits a RollbackCommand.

Specified by:

visitRollbackCommand in interface Visitor

Overrides:

visitRollbackCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitCommitCommand

public Object visitCommitCommand(InvocationContext ctx,
                                 CommitCommand command)
                          throws Throwable

Description copied from interface: Visitor

Visits a CommitCommand.

Specified by:

visitCommitCommand in interface Visitor

Overrides:

visitCommitCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.