Package org.infinispan.commands.remote.recovery

Class CompleteTransactionCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.remote.recovery.CompleteTransactionCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class CompleteTransactionCommand
extends BaseRpcCommand

Command used by the recovery tooling for forcing transaction completion .

Since:

5.0

Author:

Mircea Markus

Field Summary

Fields

Modifier and Type	Field	Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand

cacheName, origin

Constructor Summary

Constructors

Constructor	Description
CompleteTransactionCommand(ByteString cacheName)
CompleteTransactionCommand(ByteString cacheName, org.infinispan.commons.tx.XidImpl xid, boolean commit)

Method Summary

Modifier and Type	Method	Description
boolean	canBlock()	If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
CompletionStage<?>	invokeAsync(ComponentRegistry componentRegistry)	Invoke the command asynchronously.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
void	readFrom(ObjectInput input)	Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
String	toString()
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.ReplicableCommand

invoke, invokeAsync, isSuccessful

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

CompleteTransactionCommand

public CompleteTransactionCommand(ByteString cacheName)

CompleteTransactionCommand

public CompleteTransactionCommand(ByteString cacheName,
                                  org.infinispan.commons.tx.XidImpl xid,
                                  boolean commit)

Method Detail

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry componentRegistry)
                               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.

Throws:

Throwable

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.

Returns:

true or false

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

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

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.

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).

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.

canBlock

public 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.

Returns:

true if the command can block/wait, false otherwise

toString

public String toString()

Overrides:

toString in class BaseRpcCommand