org.infinispan.xsite

Class SingleXSiteRpcCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.xsite.XSiteReplicateCommand

org.infinispan.xsite.SingleXSiteRpcCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class SingleXSiteRpcCommand
extends XSiteReplicateCommand

RPC command to replicate cache operations (such as put, remove, replace, etc.) to the backup site.

Since:

7.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.xsite.XSiteReplicateCommand

originSite

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

cacheName, origin

Constructor Summary

Constructors

Constructor and Description
SingleXSiteRpcCommand()
SingleXSiteRpcCommand(ByteString cacheName)
SingleXSiteRpcCommand(ByteString cacheName, VisitableCommand command)

Method Summary

Modifier and Type	Method and Description
CompletionStage<?>	invokeAsync(ComponentRegistry componentRegistry) Invoke the command asynchronously.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
CompletionStage<Void>	performInLocalSite(BackupReceiver receiver, boolean preserveOrder)
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.xsite.XSiteReplicateCommand

getCommandId, setOriginSite

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

canBlock, invoke, invokeAsync, isSuccessful

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

SingleXSiteRpcCommand

public SingleXSiteRpcCommand(ByteString cacheName,
                             VisitableCommand command)

SingleXSiteRpcCommand

public SingleXSiteRpcCommand(ByteString cacheName)

SingleXSiteRpcCommand

public SingleXSiteRpcCommand()

Method Detail

performInLocalSite

public CompletionStage<Void> performInLocalSite(BackupReceiver receiver,
                                                boolean preserveOrder)

Specified by:

performInLocalSite in class XSiteReplicateCommand

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

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.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Overrides:

isReturnValueExpected in class XSiteReplicateCommand

Returns:

true or false

toString

public String toString()

Overrides:

toString in class BaseRpcCommand