org.infinispan.interceptors.base

Class CommandInterceptor

java.lang.Object

org.infinispan.commands.AbstractVisitor

org.infinispan.interceptors.base.CommandInterceptor

All Implemented Interfaces:

Visitor, AsyncInterceptor

Direct Known Subclasses:

BaseCustomInterceptor, BaseRpcInterceptor, BaseStateTransferInterceptor, JmxStatsCommandInterceptor, PrePostProcessingCommandInterceptor

Deprecated.

Since 8.3, will be removed.

@Deprecated
public abstract class CommandInterceptor
extends AbstractVisitor
implements AsyncInterceptor

This is the base class for all interceptors to extend, and implements the Visitor interface allowing it to intercept invocations on VisitableCommands.

Commands are either created by the CacheImpl (for invocations on the Cache public interface), or by the InboundInvocationHandler for remotely originating invocations, and are passed up the interceptor chain by using the InterceptorChain helper class.

When writing interceptors, authors can either override a specific visitXXX() method (such as AbstractVisitor.visitGetKeyValueCommand(InvocationContext, GetKeyValueCommand)) or the more generic handleDefault(InvocationContext, VisitableCommand) which is the default behaviour of any visit method, as defined in AbstractVisitor.handleDefault(InvocationContext, VisitableCommand).

The preferred approach is to override the specific visitXXX() methods that are of interest rather than to override handleDefault(InvocationContext, VisitableCommand) and then write a series of if statements or a switch block, if command-specific behaviour is needed.

Author:

Mircea.Markus@jboss.com

See Also:

VisitableCommand, Visitor, InterceptorChain

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	cacheConfiguration Deprecated.

Constructor Summary

Constructors

Constructor and Description
CommandInterceptor() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected <K,V> Cache<K,V>	getCacheWithFlags(Cache<K,V> cache, FlagAffectedCommand command) Deprecated.
protected long	getLockAcquisitionTimeout(FlagAffectedCommand command, boolean skipLocking) Deprecated.
protected Log	getLog() Deprecated.
CommandInterceptor	getNext() Deprecated. Retrieves the next interceptor in the chain.
protected Object	handleDefault(InvocationContext ctx, VisitableCommand command) Deprecated. The default behaviour of the visitXXX methods, which is to ignore the call and pass the call up to the next interceptor in the chain.
boolean	hasNext() Deprecated. Note: Unlike getNext(), this method does not ignore interceptors that do not extend CommandInterceptor
protected boolean	hasSkipLocking(FlagAffectedCommand command) Deprecated.
void	injectConfiguration(Configuration configuration, AsyncInterceptorChain interceptorChain) Deprecated.
Object	invokeNextInterceptor(InvocationContext ctx, VisitableCommand command) Deprecated. Invokes the next interceptor in the chain.
void	setNext(CommandInterceptor ignored) Deprecated. Does nothing since 9.0.
void	setNextInterceptor(AsyncInterceptor interceptorStage) Deprecated. Sets up the interceptor.
Object	visitCommand(InvocationContext ctx, VisitableCommand command) Deprecated. Perform some work for a command invocation.

Methods inherited from class org.infinispan.commands.AbstractVisitor

visitApplyDeltaCommand, visitClearCommand, visitCollection, visitCommitCommand, visitDistributedExecuteCommand, visitEntrySetCommand, visitEvictCommand, visitGetAllCommand, visitGetCacheEntryCommand, visitGetKeysInGroupCommand, visitGetKeyValueCommand, visitInvalidateCommand, visitInvalidateL1Command, visitKeySetCommand, visitLockControlCommand, visitPrepareCommand, visitPutKeyValueCommand, visitPutMapCommand, visitReadOnlyKeyCommand, visitReadOnlyManyCommand, visitReadWriteKeyCommand, visitReadWriteKeyValueCommand, visitReadWriteManyCommand, visitReadWriteManyEntriesCommand, visitRemoveCommand, visitReplaceCommand, visitRollbackCommand, visitSizeCommand, visitUnknownCommand, visitWriteOnlyKeyCommand, visitWriteOnlyKeyValueCommand, visitWriteOnlyManyCommand, visitWriteOnlyManyEntriesCommand

Methods inherited from class java.lang.Object

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

Field Detail

cacheConfiguration

protected Configuration cacheConfiguration

Deprecated.

Constructor Detail

CommandInterceptor

public CommandInterceptor()

Deprecated.

Method Detail

getLog

protected Log getLog()

Deprecated.

injectConfiguration

public void injectConfiguration(Configuration configuration,
                                AsyncInterceptorChain interceptorChain)

Deprecated.

getNext

public final CommandInterceptor getNext()

Deprecated.

Retrieves the next interceptor in the chain. Since 9.0, it returns null if the next interceptor does not extend CommandInterceptor.

Returns:

the next interceptor in the chain.

hasNext

public final boolean hasNext()

Deprecated.

Note: Unlike getNext(), this method does not ignore interceptors that do not extend CommandInterceptor

Returns:

true if there is another interceptor in the chain after this; false otherwise.

setNext

public final void setNext(CommandInterceptor ignored)

Deprecated.

Does nothing since 9.0.

setNextInterceptor

public final void setNextInterceptor(AsyncInterceptor interceptorStage)

Deprecated.

Description copied from interface: AsyncInterceptor

Sets up the interceptor. Do not call explicitly.

Specified by:

setNextInterceptor in interface AsyncInterceptor

invokeNextInterceptor

public final Object invokeNextInterceptor(InvocationContext ctx,
                                          VisitableCommand command)
                                   throws Throwable

Deprecated.

Invokes the next interceptor in the chain. This is how interceptor implementations should pass a call up the chain to the next interceptor.

Parameters:

ctx - invocation context

command - command to pass up the chain.

Returns:

return value of the invocation

Throws:

Throwable - in the event of problems

handleDefault

protected Object handleDefault(InvocationContext ctx,
                               VisitableCommand command)
                        throws Throwable

Deprecated.

The default behaviour of the visitXXX methods, which is to ignore the call and pass the call up to the next interceptor in the chain.

Overrides:

handleDefault in class AbstractVisitor

Parameters:

ctx - invocation context

command - command to invoke

Returns:

return value

Throws:

Throwable - in the event of problems

getLockAcquisitionTimeout

protected final long getLockAcquisitionTimeout(FlagAffectedCommand command,
                                               boolean skipLocking)

Deprecated.

hasSkipLocking

protected final boolean hasSkipLocking(FlagAffectedCommand command)

Deprecated.

getCacheWithFlags

protected <K,V> Cache<K,V> getCacheWithFlags(Cache<K,V> cache,
                                             FlagAffectedCommand command)

Deprecated.

visitCommand

public Object visitCommand(InvocationContext ctx,
                           VisitableCommand command)
                    throws Throwable

Deprecated.

Description copied from interface: AsyncInterceptor

Perform some work for a command invocation. The interceptor is responsible for invoking the next interceptor in the chain, using BaseAsyncInterceptor.invokeNext(InvocationContext, VisitableCommand) or the other methods in BaseAsyncInterceptor.

Specified by:

visitCommand in interface AsyncInterceptor

Returns:

Either a regular value, or an InvocationStage created by the BaseAsyncInterceptor methods.

Throws:

Throwable