Package org.infinispan.xsite.commands

Class XSiteTakeOfflineCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.xsite.commands.XSiteTakeOfflineCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class XSiteTakeOfflineCommand
extends BaseRpcCommand

Take a site offline.

Since:

11.0

Author:

Ryan Emerson

Field Summary

Fields

Modifier and Type	Field	Description
static int	COMMAND_ID

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

cacheName, origin

Constructor Summary

Constructors

Constructor	Description
XSiteTakeOfflineCommand()
XSiteTakeOfflineCommand(ByteString cacheName)
XSiteTakeOfflineCommand(ByteString cacheName, String siteName)

Method Summary

Modifier and Type	Method	Description
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
CompletionStage<?>	invokeAsync(ComponentRegistry registry)	Invoke the command asynchronously.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
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.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 int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

XSiteTakeOfflineCommand

public XSiteTakeOfflineCommand()

XSiteTakeOfflineCommand

public XSiteTakeOfflineCommand(ByteString cacheName)

XSiteTakeOfflineCommand

public XSiteTakeOfflineCommand(ByteString cacheName,
                               String siteName)

Method Detail

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry registry)
                               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

isReturnValueExpected

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

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.

toString

public String toString()

Overrides:

toString in class BaseRpcCommand