org.infinispan.interceptors.distribution

Class BaseDistributionInterceptor

java.lang.Object

org.infinispan.interceptors.BaseAsyncInterceptor

org.infinispan.interceptors.DDAsyncInterceptor

org.infinispan.interceptors.impl.BaseRpcInterceptor

org.infinispan.interceptors.impl.ClusteringInterceptor

org.infinispan.interceptors.distribution.BaseDistributionInterceptor

All Implemented Interfaces:

Visitor, AsyncInterceptor

Direct Known Subclasses:

NonTxDistributionInterceptor, TriangleDistributionInterceptor, TxDistributionInterceptor

public abstract class BaseDistributionInterceptor
extends ClusteringInterceptor

Base class for distribution of entries across a cluster.

Author:

Manik Surtani, Mircea.Markus@jboss.com, Pete Muir, Dan Berindei <dan@infinispan.org>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	BaseDistributionInterceptor.ReadManyCommandHelper<C extends VisitableCommand>
protected class	BaseDistributionInterceptor.ReadOnlyManyHelper

Nested classes/interfaces inherited from class org.infinispan.interceptors.impl.ClusteringInterceptor

ClusteringInterceptor.ClusteredGetAllFuture

Field Summary

Fields

Modifier and Type	Field and Description
protected InternalExpirationManager<Object,Object>	expirationManager
protected boolean	isL1Enabled
protected boolean	isReplicated
protected KeyPartitioner	keyPartitioner
protected RemoteValueRetrievedListener	rvrl
protected TimeService	timeService

Fields inherited from class org.infinispan.interceptors.impl.ClusteringInterceptor

cf, dataContainer, distributionManager, entryFactory, lockManager

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

componentRegistry, defaultSynchronous, rpcManager

Fields inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

cacheConfiguration

Constructor Summary

Constructors

Constructor and Description
BaseDistributionInterceptor()

Method Summary

Modifier and Type	Method and Description
protected LocalizedCacheTopology	checkTopologyId(TopologyAffectedCommand command)
void	configure()
protected Log	getLog()
protected <C extends TopologyAffectedCommand & FlagAffectedCommand> Object	handleFunctionalReadManyCommand(InvocationContext ctx, C command, BaseDistributionInterceptor.ReadManyCommandHelper<C> helper)
protected Object	handleNonTxWriteCommand(InvocationContext ctx, AbstractDataWriteCommand command)
protected void	handleRemotelyRetrievedKeys(InvocationContext ctx, WriteCommand appliedCommand, List<?> remoteKeys)
protected Object	invokeRemotely(InvocationContext ctx, DataWriteCommand command, Address primaryOwner)
protected Object	primaryReturnHandler(InvocationContext ctx, AbstractDataWriteCommand command, Object localResult)
protected boolean	readNeedsRemoteValue(FlagAffectedCommand command)
protected <C extends FlagAffectedCommand & TopologyAffectedCommand> CompletionStage<Void>	remoteGetMany(InvocationContext ctx, C command, Collection<?> keys)
protected <C extends FlagAffectedCommand & TopologyAffectedCommand> CompletionStage<Void>	remoteGetSingleKey(InvocationContext ctx, C command, Object key, boolean isWrite) Fetch a key from its remote owners and store it in the context.
protected ReadOnlyKeyCommand	remoteReadOnlyCommand(InvocationContext ctx, ReadOnlyKeyCommand command)
protected DistributionInfo	retrieveDistributionInfo(LocalizedCacheTopology topology, ReplicableCommand command, Object key)
protected Object[]	unwrapFunctionalManyResultOnOrigin(InvocationContext ctx, List<Object> keys, Object responseValue)
protected Object	unwrapFunctionalResultOnOrigin(InvocationContext ctx, Object key, Object responseValue)
Object	visitClearCommand(InvocationContext ctx, ClearCommand command)
Object	visitGetAllCommand(InvocationContext ctx, GetAllCommand command)
Object	visitGetCacheEntryCommand(InvocationContext ctx, GetCacheEntryCommand command)
Object	visitGetKeysInGroupCommand(InvocationContext ctx, GetKeysInGroupCommand command)
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command)
Object	visitReadOnlyKeyCommand(InvocationContext ctx, ReadOnlyKeyCommand command)
Object	visitReadOnlyManyCommand(InvocationContext ctx, ReadOnlyManyCommand command)
protected Object	wrapFunctionalManyResultOnNonOrigin(InvocationContext rCtx, Collection<?> keys, Object[] values)
protected Object	wrapFunctionalResultOnNonOriginOnReturn(Object rv, CacheEntry entry)
protected void	wrapRemoteEntry(InvocationContext ctx, Object key, CacheEntry ice, boolean isWrite)

Methods inherited from class org.infinispan.interceptors.impl.ClusteringInterceptor

getSuccessfulResponseOrFail, unexpected

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

init, isLocalModeForced, isSynchronous, shouldInvokeRemoteTxCommand, transactionRemotelyPrepared

Methods inherited from class org.infinispan.interceptors.DDAsyncInterceptor

handleDefault, visitCommand, visitCommitCommand, visitComputeCommand, visitComputeIfAbsentCommand, visitEntrySetCommand, visitEvictCommand, visitInvalidateCommand, visitInvalidateL1Command, visitKeySetCommand, visitLockControlCommand, visitPrepareCommand, visitPutKeyValueCommand, visitPutMapCommand, visitReadWriteKeyCommand, visitReadWriteKeyValueCommand, visitReadWriteManyCommand, visitReadWriteManyEntriesCommand, visitRemoveCommand, visitReplaceCommand, visitRollbackCommand, visitSizeCommand, visitUnknownCommand, visitWriteOnlyKeyCommand, visitWriteOnlyKeyValueCommand, visitWriteOnlyManyCommand, visitWriteOnlyManyEntriesCommand

Methods inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

asyncInvokeNext, asyncInvokeNext, asyncInvokeNext, asyncValue, delayedNull, delayedValue, delayedValue, invokeNext, invokeNextAndExceptionally, invokeNextAndFinally, invokeNextAndHandle, invokeNextThenAccept, invokeNextThenApply, isSuccessfullyDone, makeStage, setNextInterceptor, valueOrException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.Visitor

visitRemoveExpiredCommand

Field Detail

rvrl

protected RemoteValueRetrievedListener rvrl

keyPartitioner

protected KeyPartitioner keyPartitioner

timeService

protected TimeService timeService

expirationManager

protected InternalExpirationManager<Object,Object> expirationManager

isL1Enabled

protected boolean isL1Enabled

isReplicated

protected boolean isReplicated

Constructor Detail

BaseDistributionInterceptor

public BaseDistributionInterceptor()

Method Detail

getLog

protected Log getLog()

Specified by:

getLog in class BaseRpcInterceptor

configure

public void configure()

visitGetKeysInGroupCommand

public final Object visitGetKeysInGroupCommand(InvocationContext ctx,
                                               GetKeysInGroupCommand command)
                                        throws Throwable

Specified by:

visitGetKeysInGroupCommand in interface Visitor

Overrides:

visitGetKeysInGroupCommand in class DDAsyncInterceptor

Throws:

Throwable

visitClearCommand

public final Object visitClearCommand(InvocationContext ctx,
                                      ClearCommand command)
                               throws Throwable

Specified by:

visitClearCommand in interface Visitor

Overrides:

visitClearCommand in class DDAsyncInterceptor

Throws:

Throwable

retrieveDistributionInfo

protected DistributionInfo retrieveDistributionInfo(LocalizedCacheTopology topology,
                                                    ReplicableCommand command,
                                                    Object key)

remoteGetSingleKey

protected <C extends FlagAffectedCommand & TopologyAffectedCommand> CompletionStage<Void> remoteGetSingleKey(InvocationContext ctx,
                                                                                                             C command,
                                                                                                             Object key,
                                                                                                             boolean isWrite)

Fetch a key from its remote owners and store it in the context. Not thread-safe. The invocation context should not be accessed concurrently from multiple threads, so this method should only be used for single-key commands.

wrapRemoteEntry

protected void wrapRemoteEntry(InvocationContext ctx,
                               Object key,
                               CacheEntry ice,
                               boolean isWrite)

handleNonTxWriteCommand

protected final Object handleNonTxWriteCommand(InvocationContext ctx,
                                               AbstractDataWriteCommand command)
                                        throws Throwable

Throws:

Throwable

checkTopologyId

protected LocalizedCacheTopology checkTopologyId(TopologyAffectedCommand command)

primaryReturnHandler

protected Object primaryReturnHandler(InvocationContext ctx,
                                      AbstractDataWriteCommand command,
                                      Object localResult)

visitGetAllCommand

public Object visitGetAllCommand(InvocationContext ctx,
                                 GetAllCommand command)
                          throws Throwable

Specified by:

visitGetAllCommand in interface Visitor

Overrides:

visitGetAllCommand in class DDAsyncInterceptor

Throws:

Throwable

remoteGetMany

protected <C extends FlagAffectedCommand & TopologyAffectedCommand> CompletionStage<Void> remoteGetMany(InvocationContext ctx,
                                                                                                        C command,
                                                                                                        Collection<?> keys)

handleRemotelyRetrievedKeys

protected void handleRemotelyRetrievedKeys(InvocationContext ctx,
                                           WriteCommand appliedCommand,
                                           List<?> remoteKeys)

visitReadOnlyManyCommand

public Object visitReadOnlyManyCommand(InvocationContext ctx,
                                       ReadOnlyManyCommand command)
                                throws Throwable

Specified by:

visitReadOnlyManyCommand in interface Visitor

Overrides:

visitReadOnlyManyCommand in class DDAsyncInterceptor

Throws:

Throwable

handleFunctionalReadManyCommand

protected <C extends TopologyAffectedCommand & FlagAffectedCommand> Object handleFunctionalReadManyCommand(InvocationContext ctx,
                                                                                                           C command,
                                                                                                           BaseDistributionInterceptor.ReadManyCommandHelper<C> helper)

wrapFunctionalManyResultOnNonOrigin

protected Object wrapFunctionalManyResultOnNonOrigin(InvocationContext rCtx,
                                                     Collection<?> keys,
                                                     Object[] values)

unwrapFunctionalManyResultOnOrigin

protected Object[] unwrapFunctionalManyResultOnOrigin(InvocationContext ctx,
                                                      List<Object> keys,
                                                      Object responseValue)

visitGetKeyValueCommand

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

Specified by:

visitGetKeyValueCommand in interface Visitor

Overrides:

visitGetKeyValueCommand in class DDAsyncInterceptor

Throws:

Throwable

visitGetCacheEntryCommand

public Object visitGetCacheEntryCommand(InvocationContext ctx,
                                        GetCacheEntryCommand command)
                                 throws Throwable

Specified by:

visitGetCacheEntryCommand in interface Visitor

Overrides:

visitGetCacheEntryCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadOnlyKeyCommand

public Object visitReadOnlyKeyCommand(InvocationContext ctx,
                                      ReadOnlyKeyCommand command)
                               throws Throwable

Specified by:

visitReadOnlyKeyCommand in interface Visitor

Overrides:

visitReadOnlyKeyCommand in class DDAsyncInterceptor

Throws:

Throwable

remoteReadOnlyCommand

protected ReadOnlyKeyCommand remoteReadOnlyCommand(InvocationContext ctx,
                                                   ReadOnlyKeyCommand command)

wrapFunctionalResultOnNonOriginOnReturn

protected Object wrapFunctionalResultOnNonOriginOnReturn(Object rv,
                                                         CacheEntry entry)

unwrapFunctionalResultOnOrigin

protected Object unwrapFunctionalResultOnOrigin(InvocationContext ctx,
                                                Object key,
                                                Object responseValue)

invokeRemotely

protected Object invokeRemotely(InvocationContext ctx,
                                DataWriteCommand command,
                                Address primaryOwner)

readNeedsRemoteValue

protected boolean readNeedsRemoteValue(FlagAffectedCommand command)

Returns:

true if the value is not available on the local node and a read command is allowed to fetch it from a remote node. Does not check if the value is already in the context.