XSiteStatusCommand (Infinispan JavaDoc 14.0.6.Final API)

java.lang.Object
- org.infinispan.commands.remote.BaseRpcCommand
- - org.infinispan.xsite.commands.XSiteStatusCommand

All Implemented Interfaces:

org.infinispan.commands.remote.CacheRpcCommand, ReplicableCommand
```
public class XSiteStatusCommand
extends org.infinispan.commands.remote.BaseRpcCommand
```
Return the status of a BackupSender.

Since:

11.0

Author:

Ryan Emerson

Field Summary

Fields
Modifier and Type Field Description

static int COMMAND_ID

Constructor Summary

Constructors
Constructor Description

XSiteStatusCommand()

XSiteStatusCommand(ByteString cacheName)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte`	`getCommandId()`	Used by marshallers to convert this command into an id for streaming.
`CompletionStage<?>`	`invokeAsync(ComponentRegistry registry)`
`boolean`	`isReturnValueExpected()`	If true, a return value will be provided when performed remotely.
`String`	`toString()`

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, logThrowable, readFrom, writeTo

- Field Detail
  - COMMAND_ID
```
public static final int COMMAND_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XSiteStatusCommand
```
public XSiteStatusCommand()
```
  - XSiteStatusCommand
```
public XSiteStatusCommand(ByteString cacheName)
```
- Method Detail
  - invokeAsync
```
public CompletionStage<?> invokeAsync(ComponentRegistry registry)
                               throws Throwable
```
    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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class org.infinispan.commands.remote.BaseRpcCommand