org.infinispan.commands.tx

Class AbstractTransactionBoundaryCommand

java.lang.Object

org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TransactionBoundaryCommand, VisitableCommand

Direct Known Subclasses:

CommitCommand, LockControlCommand, PrepareCommand, RollbackCommand

public abstract class AbstractTransactionBoundaryCommand
extends Object
implements TransactionBoundaryCommand

An abstract transaction boundary command that holds a reference to a GlobalTransaction

Since:

4.0

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheName
protected GlobalTransaction	globalTx
protected InvocationContextFactory	icf
protected InterceptorChain	invoker
protected TransactionTable	txTable

Constructor Summary

Constructors

Constructor and Description
AbstractTransactionBoundaryCommand(String cacheName)

Method Summary

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
boolean	equals(Object o)
String	getCacheName()
GlobalTransaction	getGlobalTransaction()
Address	getOrigin() Get the origin of the command
protected RemoteTransaction	getRemoteTransaction()
int	getTopologyId()
int	hashCode()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
void	init(InterceptorChain chain, InvocationContextFactory icf, TransactionTable txTable)
protected Object	invalidRemoteTxReturnValue() This is what is returned to remote callers when an invalid RemoteTransaction is encountered.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
void	markTransactionAsRemote(boolean isRemote)
Object	perform(InvocationContext ctx) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
boolean	readsExistingValues()
void	setOrigin(Address origin) Set the origin of the command
void	setTopologyId(int topologyId)
boolean	shouldInvoke(InvocationContext ctx) Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
String	toString()
protected void	visitRemoteTransaction(RemoteTransaction tx)
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commands.VisitableCommand

acceptVisitor, alwaysReadsExistingValues

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getCommandId, getParameters, setParameters

Field Detail

globalTx

protected GlobalTransaction globalTx

cacheName

protected final String cacheName

invoker

protected InterceptorChain invoker

icf

protected InvocationContextFactory icf

txTable

protected TransactionTable txTable

Constructor Detail

AbstractTransactionBoundaryCommand

public AbstractTransactionBoundaryCommand(String cacheName)

Method Detail

init

public void init(InterceptorChain chain,
                 InvocationContextFactory icf,
                 TransactionTable txTable)

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getCacheName

public String getCacheName()

Specified by:

getCacheName in interface CacheRpcCommand

Returns:

the name of the cache that produced this command. This will also be the name of the cache this command is intended for.

getGlobalTransaction

public GlobalTransaction getGlobalTransaction()

Specified by:

getGlobalTransaction in interface TransactionBoundaryCommand

markTransactionAsRemote

public void markTransactionAsRemote(boolean isRemote)

Specified by:

markTransactionAsRemote in interface TransactionBoundaryCommand

invalidRemoteTxReturnValue

protected Object invalidRemoteTxReturnValue()

This is what is returned to remote callers when an invalid RemoteTransaction is encountered. Can happen if a remote node propagates a transactional call to the current node, and the current node has no idea of the transaction in question. Can happen during rehashing, when ownerships are reassigned during a transactions. Returning a null usually means the transactional command succeeded.

Returns:

return value to respond to a remote caller with if the transaction context is invalid.

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from interface: ReplicableCommand

Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Specified by:

perform in interface ReplicableCommand

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

visitRemoteTransaction

protected void visitRemoteTransaction(RemoteTransaction tx)

getRemoteTransaction

protected RemoteTransaction getRemoteTransaction()

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

Specified by:

writeTo in interface ReplicableCommand

Parameters:

output - the stream.

Throws:

IOException - if an error occurred during the I/O.

readFrom

public void readFrom(ObjectInput input)
              throws IOException,
                     ClassNotFoundException

Description copied from interface: ReplicableCommand

Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).

Specified by:

readFrom in interface ReplicableCommand

Parameters:

input - the stream to read.

Throws:

IOException - if an error occurred during the I/O.

ClassNotFoundException - if it tries to load an undefined class.

shouldInvoke

public boolean shouldInvoke(InvocationContext ctx)

Description copied from interface: VisitableCommand

Used by the InboundInvocationHandler to determine whether the command should be invoked or not.

Specified by:

shouldInvoke in interface VisitableCommand

Returns:

true if the command should be invoked, false otherwise.

ignoreCommandOnStatus

public boolean ignoreCommandOnStatus(ComponentStatus status)

Description copied from interface: VisitableCommand

Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor. Commands can opt to be discarded in case the cache status is not suited (as InvalidateCommand)

Specified by:

ignoreCommandOnStatus in interface VisitableCommand

Returns:

true if the command should NOT be invoked.

readsExistingValues

public boolean readsExistingValues()

Specified by:

readsExistingValues in interface VisitableCommand

Returns:

true if the command needs to read the previous values of the keys it acts on.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getOrigin

public Address getOrigin()

Description copied from interface: CacheRpcCommand

Get the origin of the command

Specified by:

getOrigin in interface CacheRpcCommand

Returns:

setOrigin

public void setOrigin(Address origin)

Description copied from interface: CacheRpcCommand

Set the origin of the command

Specified by:

setOrigin in interface CacheRpcCommand

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

canBlock

public final boolean canBlock()

Description copied from interface: ReplicableCommand

If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread.

This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.

Specified by:

canBlock in interface ReplicableCommand

Returns:

true if the command can block/wait, false otherwise