Package org.infinispan.interceptors.impl

Class TxInterceptor

java.lang.Object

org.infinispan.interceptors.BaseAsyncInterceptor

org.infinispan.interceptors.DDAsyncInterceptor

org.infinispan.interceptors.impl.TxInterceptor

All Implemented Interfaces:

Visitor, AsyncInterceptor, JmxStatisticsExposer, CustomMetricsSupplier

@MBean(objectName="Transactions",
       description="Component that manages the cache\'s participation in JTA transactions.")
public class TxInterceptor
extends DDAsyncInterceptor
implements JmxStatisticsExposer, CustomMetricsSupplier

Interceptor in charge with handling transaction related operations, e.g enlisting cache as an transaction participant, propagating remotely initiated changes.

Since:

9.0

Author:

Manik Surtani (manik@jboss.org), Mircea.Markus@jboss.com

See Also:

• TransactionXaAdapter

Field Summary

Fields inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

cacheConfiguration

Constructor Summary

Constructors

Constructor	Description
TxInterceptor()

Method Summary

Modifier and Type	Method	Description
long	getCommits()
Collection<org.infinispan.commons.stat.MetricInfo>	getCustomMetrics(GlobalMetricsConfiguration configuration)	Extra metrics to be registered.
long	getPrepares()
long	getRollbacks()
boolean	getStatisticsEnabled()	Returns whether an interceptor's statistics are being captured.
boolean	isStatisticsEnabled()
void	resetStatistics()	Resets an interceptor's cache statistics
void	setStatisticsEnabled(boolean enabled)	Enables an interceptor's cache statistics If true, the interceptor will capture statistics and make them available through the mbean.
void	start()
Object	visitClearCommand(InvocationContext ctx, ClearCommand command)
Object	visitCommitCommand(TxInvocationContext ctx, CommitCommand command)
Object	visitComputeCommand(InvocationContext ctx, ComputeCommand command)
Object	visitComputeIfAbsentCommand(InvocationContext ctx, ComputeIfAbsentCommand command)
Object	visitEntrySetCommand(InvocationContext ctx, EntrySetCommand command)
Object	visitGetAllCommand(InvocationContext ctx, GetAllCommand command)
final Object	visitGetCacheEntryCommand(InvocationContext ctx, GetCacheEntryCommand command)
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command)
Object	visitInvalidateCommand(InvocationContext ctx, InvalidateCommand invalidateCommand)
Object	visitKeySetCommand(InvocationContext ctx, KeySetCommand command)
Object	visitLockControlCommand(TxInvocationContext ctx, LockControlCommand command)
Object	visitPrepareCommand(TxInvocationContext ctx, PrepareCommand command)
Object	visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command)
Object	visitPutMapCommand(InvocationContext ctx, PutMapCommand command)
Object	visitReadOnlyKeyCommand(InvocationContext ctx, ReadOnlyKeyCommand command)
Object	visitReadOnlyManyCommand(InvocationContext ctx, ReadOnlyManyCommand command)
Object	visitReadWriteKeyCommand(InvocationContext ctx, ReadWriteKeyCommand command)
Object	visitReadWriteKeyValueCommand(InvocationContext ctx, ReadWriteKeyValueCommand command)
Object	visitReadWriteManyCommand(InvocationContext ctx, ReadWriteManyCommand command)
Object	visitReadWriteManyEntriesCommand(InvocationContext ctx, ReadWriteManyEntriesCommand command)
Object	visitRemoveCommand(InvocationContext ctx, RemoveCommand command)
Object	visitRemoveExpiredCommand(InvocationContext ctx, RemoveExpiredCommand command)
Object	visitReplaceCommand(InvocationContext ctx, ReplaceCommand command)
Object	visitRollbackCommand(TxInvocationContext ctx, RollbackCommand command)
Object	visitSizeCommand(InvocationContext ctx, SizeCommand command)
Object	visitWriteOnlyKeyCommand(InvocationContext ctx, WriteOnlyKeyCommand command)
Object	visitWriteOnlyKeyValueCommand(InvocationContext ctx, WriteOnlyKeyValueCommand command)
Object	visitWriteOnlyManyCommand(InvocationContext ctx, WriteOnlyManyCommand command)
Object	visitWriteOnlyManyEntriesCommand(InvocationContext ctx, WriteOnlyManyEntriesCommand command)

Methods inherited from class org.infinispan.interceptors.DDAsyncInterceptor

handleDefault, visitCommand, visitEvictCommand, visitInvalidateL1Command, visitIracPutKeyValueCommand, visitTouchCommand, visitUnknownCommand

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

Constructor Details

TxInterceptor

public TxInterceptor()

Method Details

start

public void start()

visitPrepareCommand

public Object visitPrepareCommand(TxInvocationContext ctx,
 PrepareCommand command)
                           throws Throwable

Specified by:

visitPrepareCommand in interface Visitor

Overrides:

visitPrepareCommand in class DDAsyncInterceptor

Throws:

Throwable

visitCommitCommand

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

Specified by:

visitCommitCommand in interface Visitor

Overrides:

visitCommitCommand in class DDAsyncInterceptor

Throws:

Throwable

visitRollbackCommand

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

Specified by:

visitRollbackCommand in interface Visitor

Overrides:

visitRollbackCommand in class DDAsyncInterceptor

Throws:

Throwable

visitLockControlCommand

public Object visitLockControlCommand(TxInvocationContext ctx,
 LockControlCommand command)
                               throws Throwable

Specified by:

visitLockControlCommand in interface Visitor

Overrides:

visitLockControlCommand in class DDAsyncInterceptor

Throws:

Throwable

visitPutKeyValueCommand

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

Specified by:

visitPutKeyValueCommand in interface Visitor

Overrides:

visitPutKeyValueCommand in class DDAsyncInterceptor

Throws:

Throwable

visitRemoveCommand

public Object visitRemoveCommand(InvocationContext ctx,
 RemoveCommand command)
                          throws Throwable

Specified by:

visitRemoveCommand in interface Visitor

Overrides:

visitRemoveCommand in class DDAsyncInterceptor

Throws:

Throwable

visitRemoveExpiredCommand

public Object visitRemoveExpiredCommand(InvocationContext ctx,
 RemoveExpiredCommand command)

Specified by:

visitRemoveExpiredCommand in interface Visitor

visitReplaceCommand

public Object visitReplaceCommand(InvocationContext ctx,
 ReplaceCommand command)
                           throws Throwable

Specified by:

visitReplaceCommand in interface Visitor

Overrides:

visitReplaceCommand in class DDAsyncInterceptor

Throws:

Throwable

visitComputeCommand

public Object visitComputeCommand(InvocationContext ctx,
 ComputeCommand command)
                           throws Throwable

Specified by:

visitComputeCommand in interface Visitor

Overrides:

visitComputeCommand in class DDAsyncInterceptor

Throws:

Throwable

visitComputeIfAbsentCommand

public Object visitComputeIfAbsentCommand(InvocationContext ctx,
 ComputeIfAbsentCommand command)
                                   throws Throwable

Specified by:

visitComputeIfAbsentCommand in interface Visitor

Overrides:

visitComputeIfAbsentCommand in class DDAsyncInterceptor

Throws:

Throwable

visitClearCommand

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

Specified by:

visitClearCommand in interface Visitor

Overrides:

visitClearCommand in class DDAsyncInterceptor

Throws:

Throwable

visitPutMapCommand

public Object visitPutMapCommand(InvocationContext ctx,
 PutMapCommand command)
                          throws Throwable

Specified by:

visitPutMapCommand in interface Visitor

Overrides:

visitPutMapCommand in class DDAsyncInterceptor

Throws:

Throwable

visitSizeCommand

public Object visitSizeCommand(InvocationContext ctx,
 SizeCommand command)
                        throws Throwable

Specified by:

visitSizeCommand in interface Visitor

Overrides:

visitSizeCommand in class DDAsyncInterceptor

Throws:

Throwable

visitKeySetCommand

public Object visitKeySetCommand(InvocationContext ctx,
 KeySetCommand command)
                          throws Throwable

Specified by:

visitKeySetCommand in interface Visitor

Overrides:

visitKeySetCommand in class DDAsyncInterceptor

Throws:

Throwable

visitEntrySetCommand

public Object visitEntrySetCommand(InvocationContext ctx,
 EntrySetCommand command)
                            throws Throwable

Specified by:

visitEntrySetCommand in interface Visitor

Overrides:

visitEntrySetCommand in class DDAsyncInterceptor

Throws:

Throwable

visitInvalidateCommand

public Object visitInvalidateCommand(InvocationContext ctx,
 InvalidateCommand invalidateCommand)
                              throws Throwable

Specified by:

visitInvalidateCommand in interface Visitor

Overrides:

visitInvalidateCommand in class DDAsyncInterceptor

Throws:

Throwable

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 final Object visitGetCacheEntryCommand(InvocationContext ctx,
 GetCacheEntryCommand command)
                                       throws Throwable

Specified by:

visitGetCacheEntryCommand in interface Visitor

Overrides:

visitGetCacheEntryCommand in class DDAsyncInterceptor

Throws:

Throwable

visitGetAllCommand

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

Specified by:

visitGetAllCommand in interface Visitor

Overrides:

visitGetAllCommand 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

visitReadOnlyManyCommand

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

Specified by:

visitReadOnlyManyCommand in interface Visitor

Overrides:

visitReadOnlyManyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitWriteOnlyKeyCommand

public Object visitWriteOnlyKeyCommand(InvocationContext ctx,
 WriteOnlyKeyCommand command)
                                throws Throwable

Specified by:

visitWriteOnlyKeyCommand in interface Visitor

Overrides:

visitWriteOnlyKeyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadWriteKeyValueCommand

public Object visitReadWriteKeyValueCommand(InvocationContext ctx,
 ReadWriteKeyValueCommand command)
                                     throws Throwable

Specified by:

visitReadWriteKeyValueCommand in interface Visitor

Overrides:

visitReadWriteKeyValueCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadWriteKeyCommand

public Object visitReadWriteKeyCommand(InvocationContext ctx,
 ReadWriteKeyCommand command)
                                throws Throwable

Specified by:

visitReadWriteKeyCommand in interface Visitor

Overrides:

visitReadWriteKeyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitWriteOnlyManyEntriesCommand

public Object visitWriteOnlyManyEntriesCommand(InvocationContext ctx,
 WriteOnlyManyEntriesCommand command)
                                        throws Throwable

Specified by:

visitWriteOnlyManyEntriesCommand in interface Visitor

Overrides:

visitWriteOnlyManyEntriesCommand in class DDAsyncInterceptor

Throws:

Throwable

visitWriteOnlyKeyValueCommand

public Object visitWriteOnlyKeyValueCommand(InvocationContext ctx,
 WriteOnlyKeyValueCommand command)
                                     throws Throwable

Specified by:

visitWriteOnlyKeyValueCommand in interface Visitor

Overrides:

visitWriteOnlyKeyValueCommand in class DDAsyncInterceptor

Throws:

Throwable

visitWriteOnlyManyCommand

public Object visitWriteOnlyManyCommand(InvocationContext ctx,
 WriteOnlyManyCommand command)
                                 throws Throwable

Specified by:

visitWriteOnlyManyCommand in interface Visitor

Overrides:

visitWriteOnlyManyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadWriteManyCommand

public Object visitReadWriteManyCommand(InvocationContext ctx,
 ReadWriteManyCommand command)
                                 throws Throwable

Specified by:

visitReadWriteManyCommand in interface Visitor

Overrides:

visitReadWriteManyCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReadWriteManyEntriesCommand

public Object visitReadWriteManyEntriesCommand(InvocationContext ctx,
 ReadWriteManyEntriesCommand command)
                                        throws Throwable

Specified by:

visitReadWriteManyEntriesCommand in interface Visitor

Overrides:

visitReadWriteManyEntriesCommand in class DDAsyncInterceptor

Throws:

Throwable

getStatisticsEnabled

public boolean getStatisticsEnabled()

Description copied from interface: JmxStatisticsExposer

Returns whether an interceptor's statistics are being captured.

Specified by:

getStatisticsEnabled in interface JmxStatisticsExposer

Returns:

true if statistics are captured

setStatisticsEnabled

public void setStatisticsEnabled(boolean enabled)

Description copied from interface: JmxStatisticsExposer

Enables an interceptor's cache statistics If true, the interceptor will capture statistics and make them available through the mbean.

Specified by:

setStatisticsEnabled in interface JmxStatisticsExposer

Parameters:

enabled - true if statistics should be captured

resetStatistics

@ManagedOperation(description="Resets statistics gathered by this component",
                  displayName="Reset Statistics")
public void resetStatistics()

Description copied from interface: JmxStatisticsExposer

Resets an interceptor's cache statistics

Specified by:

resetStatistics in interface JmxStatisticsExposer

isStatisticsEnabled

@ManagedAttribute(displayName="Statistics enabled",
                  dataType=TRAIT,
                  writable=true)
public boolean isStatisticsEnabled()

getPrepares

@ManagedAttribute(description="Number of transaction prepares performed since last reset",
                  displayName="Prepares",
                  measurementType=TRENDSUP)
public long getPrepares()

getCommits

@ManagedAttribute(description="Number of transaction commits performed since last reset",
                  displayName="Commits",
                  measurementType=TRENDSUP)
public long getCommits()

getRollbacks

@ManagedAttribute(description="Number of transaction rollbacks performed since last reset",
                  displayName="Rollbacks",
                  measurementType=TRENDSUP)
public long getRollbacks()

getCustomMetrics

public Collection<org.infinispan.commons.stat.MetricInfo> getCustomMetrics(GlobalMetricsConfiguration configuration)

Description copied from interface: CustomMetricsSupplier

Extra metrics to be registered.

These can be dynamic metrics that cannot use ManagedAttribute annotation. Extra tags can be set in MBeanMetadata.AttributeMetadata.

Specified by:

getCustomMetrics in interface CustomMetricsSupplier

Parameters:

configuration - The GlobalMetricsConfiguration. Implementation can make decision based on GlobalMetricsConfiguration.namesAsTags() or GlobalMetricsConfiguration.histograms().

Returns:

A list of MBeanMetadata.AttributeMetadata to be registered.