org.infinispan.interceptors

Class ClusteringInterceptor

java.lang.Object

org.infinispan.commands.AbstractVisitor

org.infinispan.interceptors.base.CommandInterceptor

org.infinispan.interceptors.base.BaseRpcInterceptor

org.infinispan.interceptors.ClusteringInterceptor

All Implemented Interfaces:

Visitor

Direct Known Subclasses:

BaseDistributionInterceptor

public abstract class ClusteringInterceptor
extends BaseRpcInterceptor

Base class for replication and distribution interceptors.

Since:

5.2

Author:

anistor@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandsFactory	cf
protected DataContainer	dataContainer
protected EntryFactory	entryFactory
protected boolean	isL1Enabled
protected LockManager	lockManager
protected boolean	needReliableReturnValues
protected StateTransferManager	stateTransferManager

Fields inherited from class org.infinispan.interceptors.base.BaseRpcInterceptor

defaultSynchronous, rpcManager

Fields inherited from class org.infinispan.interceptors.base.CommandInterceptor

cacheConfiguration

Constructor Summary

Constructors

Constructor and Description
ClusteringInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure()
protected boolean	ignorePreviousValueOnBackup(WriteCommand command, InvocationContext ctx) For conditional operations (replace, remove, put if absent) Used only for optimistic transactional caches, to solve the following situation:
void	injectDependencies(CommandsFactory cf, EntryFactory entryFactory, LockManager lockManager, DataContainer dataContainer, StateTransferManager stateTransferManager)
protected boolean	isNeedReliableReturnValues(FlagAffectedCommand command)
protected boolean	isValueAvailableLocally(ConsistentHash consistentHash, Object key)
protected boolean	needsRemoteGet(InvocationContext ctx, AbstractDataCommand command)
protected abstract InternalCacheEntry	retrieveFromRemoteSource(Object key, InvocationContext ctx, boolean acquireRemoteLock, FlagAffectedCommand command, boolean isWrite) Retrieves a cache entry from a remote source.

Methods inherited from class org.infinispan.interceptors.base.BaseRpcInterceptor

getIgnoreExtraResponseFilter, getSelfDeliverFilter, init, inject, isLocalModeForced, isSyncCommitPhase, isSynchronous, shouldInvokeRemoteTxCommand, shouldTotalOrderRollbackBeInvokedRemotely, totalOrderAnycastPrepare, totalOrderBroadcastPrepare, totalOrderTxCommit, totalOrderTxRollback, transactionRemotelyPrepared

Methods inherited from class org.infinispan.interceptors.base.CommandInterceptor

getLockAcquisitionTimeout, getLog, getNext, handleDefault, hasNext, hasSkipLocking, injectConfiguration, invokeNextInterceptor, setNext

Methods inherited from class org.infinispan.commands.AbstractVisitor

visitApplyDeltaCommand, visitClearCommand, visitCollection, visitCommitCommand, visitDistributedExecuteCommand, visitEntrySetCommand, visitEvictCommand, visitGetKeyValueCommand, visitInvalidateCommand, visitInvalidateL1Command, visitKeySetCommand, visitLockControlCommand, visitPrepareCommand, visitPutKeyValueCommand, visitPutMapCommand, visitRemoveCommand, visitReplaceCommand, visitRollbackCommand, visitSizeCommand, visitUnknownCommand, visitValuesCommand

Methods inherited from class java.lang.Object

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

Field Detail

cf

protected CommandsFactory cf

entryFactory

protected EntryFactory entryFactory

lockManager

protected LockManager lockManager

dataContainer

protected DataContainer dataContainer

stateTransferManager

protected StateTransferManager stateTransferManager

needReliableReturnValues

protected boolean needReliableReturnValues

isL1Enabled

protected boolean isL1Enabled

Constructor Detail

ClusteringInterceptor

public ClusteringInterceptor()

Method Detail

injectDependencies

public void injectDependencies(CommandsFactory cf,
                      EntryFactory entryFactory,
                      LockManager lockManager,
                      DataContainer dataContainer,
                      StateTransferManager stateTransferManager)

configure

public void configure()

isNeedReliableReturnValues

protected boolean isNeedReliableReturnValues(FlagAffectedCommand command)

needsRemoteGet

protected boolean needsRemoteGet(InvocationContext ctx,
                     AbstractDataCommand command)

isValueAvailableLocally

protected boolean isValueAvailableLocally(ConsistentHash consistentHash,
                              Object key)

ignorePreviousValueOnBackup

protected boolean ignorePreviousValueOnBackup(WriteCommand command,
                                  InvocationContext ctx)

For conditional operations (replace, remove, put if absent) Used only for optimistic transactional caches, to solve the following situation:

 - node A (owner, tx originator) does a successful replace
 - the actual value changes
 - tx commits. The value is applied on A (the check was performed at operation time) but is not applied on
   B (check is performed at commit time).
 In such situations (optimistic caches) the remote conditional command should not re-check the old value.
 

retrieveFromRemoteSource

protected abstract InternalCacheEntry retrieveFromRemoteSource(Object key,
                                          InvocationContext ctx,
                                          boolean acquireRemoteLock,
                                          FlagAffectedCommand command,
                                          boolean isWrite)
                                                        throws Exception

Retrieves a cache entry from a remote source. Would typically involve an RPC call using a ClusteredGetCommand and some form of quorum of responses if the responses returned are inconsistent - often the case if there is a rehash in progress, involving nodes that the key maps to.

Parameters:

key - key to look up

isWrite - true if this is triggered by a write operation

Returns:

an internal cache entry, or null if it cannot be located

Throws:

Exception