org.jboss.cache.interceptors
Class CacheLoaderInterceptor

java.lang.Object
  org.jboss.cache.commands.AbstractVisitor
      org.jboss.cache.interceptors.base.CommandInterceptor
          org.jboss.cache.interceptors.base.JmxStatsCommandInterceptor
              org.jboss.cache.interceptors.CacheLoaderInterceptor

All Implemented Interfaces:

Visitor, JmxStatisticsExposer

Direct Known Subclasses:

ActivationInterceptor

public class CacheLoaderInterceptor
extends JmxStatsCommandInterceptor

Loads nodes that don't exist at the time of the call into memory from the CacheLoader

Version:

$Id: CacheLoaderInterceptor.java 7610 2009-01-29 12:43:31Z manik.surtani@jboss.com $

Author:

Bela Ban

Field Summary

protected DataContainer	dataContainer
protected MVCCNodeHelper	helper
protected boolean	isActivation
protected CacheLoader	loader
protected Notifier	notifier
protected TransactionTable	txTable
protected boolean	useCacheStore True if CacheStoreInterceptor is in place.

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

configuration, log, trace

Constructor Summary

CacheLoaderInterceptor()

Method Summary

java.util.Map<java.lang.String,java.lang.Object>	dumpStatistics() Returns a map of statistics.
long	getCacheLoaderLoads()
long	getCacheLoaderMisses()
protected void	injectDependencies(TransactionTable txTable, CacheLoaderManager clm, Configuration configuration, DataContainer dataContainer, Notifier notifier, MVCCNodeHelper helper)
protected void	recordNodeLoaded(InvocationContext ctx, Fqn fqn)
void	resetStatistics() Resets statistics gathered.
protected void	startInterceptor()
java.lang.Object	visitClearDataCommand(InvocationContext ctx, ClearDataCommand command) Visits a RemoveDataCommand.
java.lang.Object	visitGetDataMapCommand(InvocationContext ctx, GetDataMapCommand command) Visits a GetDataMapCommand.
java.lang.Object	visitGetChildrenNamesCommand(InvocationContext ctx, GetChildrenNamesCommand command) Visits a GetChildrenNamesCommand.
java.lang.Object	visitGetKeysCommand(InvocationContext ctx, GetKeysCommand command) Visits a GetKeysCommand.
java.lang.Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command) Visits a GetKeyValueCommand.
java.lang.Object	visitGetNodeCommand(InvocationContext ctx, GetNodeCommand command) Visits a GetNodeCommand.
java.lang.Object	visitMoveCommand(InvocationContext ctx, MoveCommand command) Visits a MoveCommand.
java.lang.Object	visitPutDataMapCommand(InvocationContext ctx, PutDataMapCommand command) Visits a PutDataMapCommand.
java.lang.Object	visitPutForExternalReadCommand(InvocationContext ctx, PutForExternalReadCommand command) Visits a PutForExternalReadCommand.
java.lang.Object	visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command) Visits a PutKeyValueCommand.
java.lang.Object	visitRemoveKeyCommand(InvocationContext ctx, RemoveKeyCommand command) Visits a RemoveKeyCommand.
java.lang.Object	visitRemoveNodeCommand(InvocationContext ctx, RemoveNodeCommand command) Visits a RemoveNodeCommand.
java.lang.Object	visitRollbackCommand(InvocationContext ctx, RollbackCommand command) Visits a RollbackCommand.

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

getStatisticsEnabled, checkStatisticsUsed, setStatisticsEnabled

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

getNext, handleDefault, hasNext, invokeNextInterceptor, setNext

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

visitCollection, visitCommitCommand, visitCreateNodeCommand, visitEvictFqnCommand, visitExistsNodeCommand, visitGravitateDataCommand, visitInvalidateCommand, visitOptimisticPrepareCommand, visitPrepareCommand

Methods inherited from class java.lang.Object

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

Field Detail

txTable

protected TransactionTable txTable

loader

protected CacheLoader loader

dataContainer

protected DataContainer dataContainer

notifier

protected Notifier notifier

isActivation

protected boolean isActivation

helper

protected MVCCNodeHelper helper

useCacheStore

protected boolean useCacheStore

True if CacheStoreInterceptor is in place. This allows us to skip loading keys for remove(Fqn, key) and put(Fqn, key). It also affects removal of node data and listing children.

Constructor Detail

CacheLoaderInterceptor

public CacheLoaderInterceptor()

Method Detail

injectDependencies

protected void injectDependencies(TransactionTable txTable,
                                  CacheLoaderManager clm,
                                  Configuration configuration,
                                  DataContainer dataContainer,
                                  Notifier notifier,
                                  MVCCNodeHelper helper)

startInterceptor

protected void startInterceptor()

visitPutDataMapCommand

public java.lang.Object visitPutDataMapCommand(InvocationContext ctx,
                                               PutDataMapCommand command)
                                        throws java.lang.Throwable

Description copied from interface: Visitor

Visits a PutDataMapCommand.

Specified by:

visitPutDataMapCommand in interface Visitor

Overrides:

visitPutDataMapCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitPutKeyValueCommand

public java.lang.Object visitPutKeyValueCommand(InvocationContext ctx,
                                                PutKeyValueCommand command)
                                         throws java.lang.Throwable

Description copied from interface: Visitor

Visits a PutKeyValueCommand.

Specified by:

visitPutKeyValueCommand in interface Visitor

Overrides:

visitPutKeyValueCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitPutForExternalReadCommand

public java.lang.Object visitPutForExternalReadCommand(InvocationContext ctx,
                                                       PutForExternalReadCommand command)
                                                throws java.lang.Throwable

Description copied from interface: Visitor

Visits a PutForExternalReadCommand.

Specified by:

visitPutForExternalReadCommand in interface Visitor

Overrides:

visitPutForExternalReadCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitMoveCommand

public java.lang.Object visitMoveCommand(InvocationContext ctx,
                                         MoveCommand command)
                                  throws java.lang.Throwable

Description copied from interface: Visitor

Visits a MoveCommand.

Specified by:

visitMoveCommand in interface Visitor

Overrides:

visitMoveCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitGetKeyValueCommand

public java.lang.Object visitGetKeyValueCommand(InvocationContext ctx,
                                                GetKeyValueCommand command)
                                         throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitGetNodeCommand

public java.lang.Object visitGetNodeCommand(InvocationContext ctx,
                                            GetNodeCommand command)
                                     throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitGetChildrenNamesCommand

public java.lang.Object visitGetChildrenNamesCommand(InvocationContext ctx,
                                                     GetChildrenNamesCommand command)
                                              throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitGetKeysCommand

public java.lang.Object visitGetKeysCommand(InvocationContext ctx,
                                            GetKeysCommand command)
                                     throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitGetDataMapCommand

public java.lang.Object visitGetDataMapCommand(InvocationContext ctx,
                                               GetDataMapCommand command)
                                        throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitRollbackCommand

public java.lang.Object visitRollbackCommand(InvocationContext ctx,
                                             RollbackCommand command)
                                      throws java.lang.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:

java.lang.Throwable - in the event of problems.

visitRemoveNodeCommand

public java.lang.Object visitRemoveNodeCommand(InvocationContext ctx,
                                               RemoveNodeCommand command)
                                        throws java.lang.Throwable

Description copied from interface: Visitor

Visits a RemoveNodeCommand.

Specified by:

visitRemoveNodeCommand in interface Visitor

Overrides:

visitRemoveNodeCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitRemoveKeyCommand

public java.lang.Object visitRemoveKeyCommand(InvocationContext ctx,
                                              RemoveKeyCommand command)
                                       throws java.lang.Throwable

Description copied from interface: Visitor

Visits a RemoveKeyCommand.

Specified by:

visitRemoveKeyCommand in interface Visitor

Overrides:

visitRemoveKeyCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

visitClearDataCommand

public java.lang.Object visitClearDataCommand(InvocationContext ctx,
                                              ClearDataCommand command)
                                       throws java.lang.Throwable

Description copied from interface: Visitor

Visits a RemoveDataCommand.

Specified by:

visitClearDataCommand in interface Visitor

Overrides:

visitClearDataCommand in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

java.lang.Throwable - in the event of problems.

getCacheLoaderLoads

public long getCacheLoaderLoads()

getCacheLoaderMisses

public long getCacheLoaderMisses()

resetStatistics

public void resetStatistics()

Description copied from class: JmxStatsCommandInterceptor

Resets statistics gathered. Is a no-op, and should be overridden if it is to be meaningful.

Specified by:

resetStatistics in interface JmxStatisticsExposer

Overrides:

resetStatistics in class JmxStatsCommandInterceptor

dumpStatistics

public java.util.Map<java.lang.String,java.lang.Object> dumpStatistics()

Description copied from class: JmxStatsCommandInterceptor

Returns a map of statistics. This is a default implementation which returns an empty map and should be overridden if it is to be meaningful.

Specified by:

dumpStatistics in interface JmxStatisticsExposer

Overrides:

dumpStatistics in class JmxStatsCommandInterceptor

Returns:

an empty map

recordNodeLoaded

protected void recordNodeLoaded(InvocationContext ctx,
                                Fqn fqn)