org.jboss.cache.commands.remote
Class StateTransferControlCommand

java.lang.Object
  org.jboss.cache.commands.remote.StateTransferControlCommand

All Implemented Interfaces:

ReplicableCommand

public class StateTransferControlCommand
extends Object
implements ReplicableCommand

A control command for communication between peers for non-blocking state transfer

Author:

Manik Surtani

Field Summary

static int

METHOD_ID

Constructor Summary

StateTransferControlCommand()

StateTransferControlCommand(boolean enabled)

Method Summary

int	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
void	init(RPCManager rpcManager)
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 java.lang.Object

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

Field Detail

METHOD_ID

public static final int METHOD_ID

See Also:

Constant Field Values

Constructor Detail

StateTransferControlCommand

public StateTransferControlCommand()

StateTransferControlCommand

public StateTransferControlCommand(boolean enabled)

Method Detail

init

public void init(RPCManager rpcManager)

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.

getCommandId

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

toString

public String toString()

Overrides:

toString in class Object