org.infinispan.commands.tx

Class PrepareCommand

java.lang.Object

org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

org.infinispan.commands.tx.PrepareCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TransactionBoundaryCommand, VisitableCommand, RemoteLockCommand, TransactionalRemoteLockCommand

Direct Known Subclasses:

TotalOrderNonVersionedPrepareCommand, VersionedPrepareCommand

public class PrepareCommand
extends AbstractTransactionBoundaryCommand
implements TransactionalRemoteLockCommand

Command corresponding to the 1st phase of 2PC.

Since:

4.0

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID
protected WriteCommand[]	modifications
protected CacheNotifier	notifier
protected boolean	onePhaseCommit
protected RecoveryManager	recoveryManager
protected boolean	retriedCommand

Fields inherited from class org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

cacheName, globalTx, icf, invoker, txTable

Constructor Summary

Constructors

Constructor and Description
PrepareCommand(String cacheName)
PrepareCommand(String cacheName, GlobalTransaction gtx, boolean onePhaseCommit, WriteCommand... modifications)
PrepareCommand(String cacheName, GlobalTransaction gtx, List<WriteCommand> commands, boolean onePhaseCommit)

Method Summary

Modifier and Type	Method and Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
PrepareCommand	copy()
RemoteTxInvocationContext	createContext() It creates the transaction context.
Set<Object>	getAffectedKeys()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object	getKeyLockOwner() It returns the lock owner of the key.
Collection<Object>	getKeysToLock() It returns a Collection with the keys to be lock.
WriteCommand[]	getModifications()
protected RemoteTransaction	getRemoteTransaction()
boolean	hasModifications()
boolean	hasSkipLocking() It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
void	initialize(CacheNotifier notifier, RecoveryManager recoveryManager)
boolean	isOnePhaseCommit()
boolean	isReplayEntryWrapping() If set to true, then the keys touched by this transaction are to be wrapped again and original ones discarded.
boolean	isRetriedCommand()
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext ignored) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setReplayEntryWrapping(boolean replayEntryWrapping)
void	setRetriedCommand(boolean retriedCommand)
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

canBlock, equals, getCacheName, getGlobalTransaction, getOrigin, getTopologyId, hashCode, ignoreCommandOnStatus, init, invalidRemoteTxReturnValue, markTransactionAsRemote, readsExistingValues, setOrigin, setTopologyId, shouldInvoke, visitRemoteTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.VisitableCommand

alwaysReadsExistingValues

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getParameters, setParameters

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

modifications

protected WriteCommand[] modifications

onePhaseCommit

protected boolean onePhaseCommit

notifier

protected CacheNotifier notifier

recoveryManager

protected RecoveryManager recoveryManager

retriedCommand

protected boolean retriedCommand

Constructor Detail

PrepareCommand

public PrepareCommand(String cacheName,
                      GlobalTransaction gtx,
                      boolean onePhaseCommit,
                      WriteCommand... modifications)

PrepareCommand

public PrepareCommand(String cacheName,
                      GlobalTransaction gtx,
                      List<WriteCommand> commands,
                      boolean onePhaseCommit)

PrepareCommand

public PrepareCommand(String cacheName)

Method Detail

initialize

public void initialize(CacheNotifier notifier,
                       RecoveryManager recoveryManager)

perform

public Object perform(InvocationContext ignored)
               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

Overrides:

perform in class AbstractTransactionBoundaryCommand

Parameters:

ignored - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

createContext

public RemoteTxInvocationContext createContext()

Description copied from interface: TransactionalRemoteLockCommand

It creates the transaction context.

Specified by:

createContext in interface TransactionalRemoteLockCommand

Returns:

the TxInvocationContext.

getKeysToLock

public Collection<Object> getKeysToLock()

Description copied from interface: RemoteLockCommand

It returns a Collection with the keys to be lock.

It may return an empty collection if no keys needs to be locked independently of the return value of RemoteLockCommand.hasSkipLocking(). It may contains duplicated keys and null is not a valid return value.

Specified by:

getKeysToLock in interface RemoteLockCommand

Returns:

a Collection of keys to lock.

getKeyLockOwner

public Object getKeyLockOwner()

Description copied from interface: RemoteLockCommand

It returns the lock owner of the key.

Usually, in transaction caches it is the GlobalTransaction and in non-transactional caches the CommandInvocationId.

Specified by:

getKeyLockOwner in interface RemoteLockCommand

Returns:

the lock owner of the key.

hasZeroLockAcquisition

public boolean hasZeroLockAcquisition()

Specified by:

hasZeroLockAcquisition in interface RemoteLockCommand

Returns:

it the locks should be acquire with 0 (zero) acquisition timeout.

hasSkipLocking

public boolean hasSkipLocking()

Description copied from interface: RemoteLockCommand

It checks if this command should acquire locks.

Specified by:

hasSkipLocking in interface RemoteLockCommand

Returns:

true if locks should be acquired for the keys in RemoteLockCommand.getKeysToLock().

getRemoteTransaction

protected RemoteTransaction getRemoteTransaction()

Overrides:

getRemoteTransaction in class AbstractTransactionBoundaryCommand

acceptVisitor

public Object acceptVisitor(InvocationContext ctx,
                            Visitor visitor)
                     throws Throwable

Description copied from interface: VisitableCommand

Accept a visitor, and return the result of accepting this visitor.

Specified by:

acceptVisitor in interface VisitableCommand

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

getModifications

public WriteCommand[] getModifications()

isOnePhaseCommit

public boolean isOnePhaseCommit()

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Specified by:

getCommandId in interface ReplicableCommand

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

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

Overrides:

writeTo in class AbstractTransactionBoundaryCommand

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

Overrides:

readFrom in class AbstractTransactionBoundaryCommand

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.

copy

public PrepareCommand copy()

toString

public String toString()

Overrides:

toString in class AbstractTransactionBoundaryCommand

hasModifications

public boolean hasModifications()

getAffectedKeys

public Set<Object> getAffectedKeys()

isReplayEntryWrapping

public boolean isReplayEntryWrapping()

If set to true, then the keys touched by this transaction are to be wrapped again and original ones discarded.

setReplayEntryWrapping

public void setReplayEntryWrapping(boolean replayEntryWrapping)

See Also:

isReplayEntryWrapping()

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

Overrides:

isReturnValueExpected in class AbstractTransactionBoundaryCommand

Returns:

true or false

isRetriedCommand

public boolean isRetriedCommand()

setRetriedCommand

public void setRetriedCommand(boolean retriedCommand)