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

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteString	cacheName
protected GlobalTransaction	globalTx

Constructor Summary

Constructors

Constructor and Description
AbstractTransactionBoundaryCommand(ByteString cacheName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ByteString	getCacheName()
GlobalTransaction	getGlobalTransaction()
Address	getOrigin() Get the origin of the command
int	getTopologyId()
int	hashCode()
protected Object	invalidRemoteTxReturnValue(TransactionTable txTable) This is what is returned to remote callers when an invalid RemoteTransaction is encountered.
CompletionStage<?>	invokeAsync(ComponentRegistry registry) Invoke the command asynchronously.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
VisitableCommand.LoadType	loadType()
void	markTransactionAsRemote(boolean isRemote)
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setOrigin(Address origin) Sets the sender's Address.
void	setTopologyId(int topologyId)
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, init

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, getCommandId, invoke, invokeAsync, isSuccessful

Field Detail

globalTx

protected GlobalTransaction globalTx

cacheName

protected final ByteString cacheName

Constructor Detail

AbstractTransactionBoundaryCommand

public AbstractTransactionBoundaryCommand(ByteString cacheName)

Method Detail

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getCacheName

public ByteString 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(TransactionTable txTable)

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.

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry registry)
                               throws Throwable

Description copied from interface: CacheRpcCommand

Invoke the command asynchronously.

This method replaces ReplicableCommand.invoke() for remote execution. The default implementation and ReplicableCommand.invoke() will be removed in future versions.

Specified by:

invokeAsync in interface CacheRpcCommand

Throws:

Throwable

visitRemoteTransaction

protected void visitRemoteTransaction(RemoteTransaction tx)

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.

loadType

public VisitableCommand.LoadType loadType()

Specified by:

loadType in interface VisitableCommand

Returns:

Nodes on which 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

setOrigin

public void setOrigin(Address origin)

Description copied from interface: ReplicableCommand

Sets the sender's Address.

By default, it doesn't set anything. Implement this method if the sender's Address is needed.

Specified by:

setOrigin in interface CacheRpcCommand

Specified by:

setOrigin in interface ReplicableCommand

Parameters:

origin - the sender's Address

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