org.infinispan.xsite.statetransfer

Class XSiteStateTransferControlCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.xsite.XSiteReplicateCommand

org.infinispan.xsite.statetransfer.XSiteStateTransferControlCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class XSiteStateTransferControlCommand
extends XSiteReplicateCommand

Command used to control the state transfer between sites.

Since:

7.0

Author:

Pedro Ruivo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XSiteStateTransferControlCommand.StateTransferControl

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID

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

cacheName

Constructor Summary

Constructors

Constructor and Description
XSiteStateTransferControlCommand()
XSiteStateTransferControlCommand(String cacheName)
XSiteStateTransferControlCommand(String cacheName, XSiteStateTransferControlCommand.StateTransferControl control, String siteName)

Method Summary

Modifier and Type	Method and Description
XSiteStateTransferControlCommand	copyForCache(String cacheName)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
String	getSiteName()
void	initialize(XSiteStateProvider provider, XSiteStateConsumer consumer, XSiteStateTransferManager stateTransferManager)
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext ctx) Performs the primary function of the command.
Object	performInLocalSite(BackupReceiver receiver)
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setSiteName(String siteName)
void	setStatusOk(boolean statusOk)
void	setTopologyId(int topologyId)
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.xsite.XSiteReplicateCommand

getOriginSite, setOriginSite

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

canBlock, 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

getParameters, setParameters

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

XSiteStateTransferControlCommand

public XSiteStateTransferControlCommand(String cacheName,
                                        XSiteStateTransferControlCommand.StateTransferControl control,
                                        String siteName)

XSiteStateTransferControlCommand

public XSiteStateTransferControlCommand(String cacheName)

XSiteStateTransferControlCommand

public XSiteStateTransferControlCommand()

Method Detail

performInLocalSite

public Object performInLocalSite(BackupReceiver receiver)
                          throws Throwable

Specified by:

performInLocalSite in class XSiteReplicateCommand

Throws:

Throwable

initialize

public final void initialize(XSiteStateProvider provider,
                             XSiteStateConsumer consumer,
                             XSiteStateTransferManager stateTransferManager)

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.

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.

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

setStatusOk

public void setStatusOk(boolean statusOk)

setSiteName

public void setSiteName(String siteName)

getSiteName

public String getSiteName()

setTopologyId

public void setTopologyId(int topologyId)

copyForCache

public XSiteStateTransferControlCommand copyForCache(String cacheName)

toString

public String toString()

Overrides:

toString in class BaseRpcCommand