org.infinispan.commands
Class CancelCommand

java.lang.Object
  org.infinispan.commands.remote.BaseRpcCommand
      org.infinispan.commands.CancelCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class CancelCommand
extends BaseRpcCommand

Command to cancel commands executing in remote VM

Since:

5.2

Author:

Vladimir Blagojevic

Field Summary

static byte

COMMAND_ID

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

cacheName

Constructor Summary

CancelCommand(String ownerCacheName)

CancelCommand(String ownerCacheName, UUID commandToCancel)

Method Summary

boolean	equals(Object obj)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object[]	getParameters() Used by marshallers to stream this command across a network
int	hashCode()
void	init(CancellationService service)
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.
String	toString()

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

canBlock, getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

CancelCommand

public CancelCommand(String ownerCacheName)

CancelCommand

public CancelCommand(String ownerCacheName,
                     UUID commandToCancel)

Method Detail

init

public void init(CancellationService service)

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.

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

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.

getParameters

public Object[] getParameters()

Description copied from interface: ReplicableCommand

Used by marshallers to stream this command across a network

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.

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class BaseRpcCommand