public class StateRequestCommand extends BaseRpcCommand
Modifier and Type | Class and Description |
---|---|
static class |
StateRequestCommand.Type |
Modifier and Type | Field and Description |
---|---|
static byte |
COMMAND_ID |
cacheName
Constructor and Description |
---|
StateRequestCommand(String cacheName) |
StateRequestCommand(String cacheName,
StateRequestCommand.Type type,
Address origin,
int topologyId,
Set<Integer> segments) |
Modifier and Type | Method and Description |
---|---|
byte |
getCommandId()
Used by marshallers to convert this command into an id for streaming.
|
Object[] |
getParameters()
Used by marshallers to stream this command across a network
|
StateRequestCommand.Type |
getType() |
void |
init(StateProvider stateProvider) |
boolean |
isReturnValueExpected()
If true, a return value will be provided when performed remotely.
|
Object |
perform(InvocationContext ctx)
Performs the primary function of the command.
|
void |
setParameters(int commandId,
Object[] parameters)
Used by the
CommandsFactory to create a command from raw data read off a stream. |
String |
toString() |
getCacheName, getOrigin, setOrigin
public static final byte COMMAND_ID
public StateRequestCommand(String cacheName)
public StateRequestCommand(String cacheName, StateRequestCommand.Type type, Address origin, int topologyId, Set<Integer> segments)
public void init(StateProvider stateProvider)
public Object perform(InvocationContext ctx) throws Throwable
ReplicableCommand
ctx
- invocation contextThrowable
- in the event of problems.public boolean isReturnValueExpected()
ReplicableCommand
ResponseGenerator
may choose to simply return null to save on marshalling costs.public StateRequestCommand.Type getType()
public byte getCommandId()
ReplicableCommand
public Object[] getParameters()
ReplicableCommand
public void setParameters(int commandId, Object[] parameters)
ReplicableCommand
CommandsFactory
to create a command from raw data read off a stream.commandId
- command id to set. This is usually unused but *could* be used in the event of a command having
multiple IDs, such as PutKeyValueCommand
.parameters
- object array of argspublic String toString()
toString
in class BaseRpcCommand
Copyright © 2017 JBoss, a division of Red Hat. All Rights Reserved.