Class XSiteSetStateTransferModeCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.xsite.commands.XSiteSetStateTransferModeCommand

All Implemented Interfaces:

org.infinispan.commands.remote.CacheRpcCommand, ReplicableCommand, TracedCommand, VersionAware

@ProtoTypeId(1261)
public class XSiteSetStateTransferModeCommand
extends org.infinispan.commands.remote.BaseRpcCommand

A CacheRpcCommand that sets the XSiteStateTransferMode cluster-wide.

Since:

12.1

Author:

Pedro Ruivo

Constructor Summary

Constructors

Constructor	Description
XSiteSetStateTransferModeCommand(ByteString cacheName, String site, XSiteStateTransferMode mode)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	invokeAsync(ComponentRegistry registry)
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.

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

getCommandId, isSuccessful, logThrowable, readFrom, writeTo

Methods inherited from interface org.infinispan.commands.TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Constructor Details

XSiteSetStateTransferModeCommand

@ProtoFactory
public XSiteSetStateTransferModeCommand(ByteString cacheName,
 String site,
 XSiteStateTransferMode mode)

Method Details

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

invokeAsync

public CompletionStage<Void> invokeAsync(ComponentRegistry registry)
                                  throws Throwable

Throws:

Throwable

supportedSince

public NodeVersion supportedSince()

Description copied from interface: ReplicableCommand

Returns a NodeVersion representing the Infinispan version in which this command was added. This value is used to ensure that when the cluster contains different Infinispan versions, only commands compatible with the oldest version are transmitted.

Abstract classes should not implement this method as the version should be specific to an individual implementation. Similarly, implementations which extend another ReplicableCommand should always override this method.

Returns:

a NodeVersion corresponding to the Infinispan version this command was added.