org.infinispan.commands.remote.recovery

Class TxCompletionNotificationCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.remote.recovery.RecoveryCommand

org.infinispan.commands.remote.recovery.TxCompletionNotificationCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand

public class TxCompletionNotificationCommand
extends RecoveryCommand
implements TopologyAffectedCommand

Command for removing recovery related information from the cluster.

Since:

5.0

Author:

Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID

Fields inherited from class org.infinispan.commands.remote.recovery.RecoveryCommand

recoveryManager

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

cacheName

Constructor Summary

Constructors

Constructor and Description
TxCompletionNotificationCommand(long internalId, String cacheName)
TxCompletionNotificationCommand(String cacheName)
TxCompletionNotificationCommand(Xid xid, GlobalTransaction gtx, String cacheName)

Method Summary

Methods

Modifier and Type	Method and 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.
GlobalTransaction	getGlobalTransaction()
Object[]	getParameters() Used by marshallers to stream this command across a network
int	getTopologyId()
void	init(TransactionTable tt, LockManager lockManager, RecoveryManager rm, StateTransferManager stm)
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext ctx) Performs the primary function of the command.
void	setParameters(int commandId, Object[] parameters) Used by the CommandsFactory to create a command from raw data read off a stream.
void	setTopologyId(int topologyId)
String	toString()

Methods inherited from class org.infinispan.commands.remote.recovery.RecoveryCommand

init

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

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

TxCompletionNotificationCommand

public TxCompletionNotificationCommand(Xid xid,
                               GlobalTransaction gtx,
                               String cacheName)

TxCompletionNotificationCommand

public TxCompletionNotificationCommand(long internalId,
                               String cacheName)

TxCompletionNotificationCommand

public TxCompletionNotificationCommand(String cacheName)

Method Detail

init

public void init(TransactionTable tt,
        LockManager lockManager,
        RecoveryManager rm,
        StateTransferManager stm)

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

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 RecoveryCommand

Returns:

true or false

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.

getGlobalTransaction

public GlobalTransaction getGlobalTransaction()

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.

getParameters

public Object[] getParameters()

Description copied from interface: ReplicableCommand

Used by marshallers to stream this command across a network

Specified by:

getParameters in interface ReplicableCommand

Returns:

an object array of arguments, compatible with pre-2.2.0 MethodCall args.

setParameters

public void setParameters(int commandId,
                 Object[] parameters)

Description copied from interface: ReplicableCommand

Used by the CommandsFactory to create a command from raw data read off a stream.

Specified by:

setParameters in interface ReplicableCommand

Parameters:

commandId - command id to set. This is usually unused but *could* be used in the event of a command having multiple IDs, such as PutKeyValueCommand.

parameters - object array of args

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.

Specified by:

canBlock in interface ReplicableCommand

Overrides:

canBlock in class BaseRpcCommand

Returns:

true if the command can block/wait, false otherwise

toString

public String toString()

Overrides:

toString in class BaseRpcCommand