Package org.infinispan.commands.read
Class DistributedExecuteCommand<V>
- java.lang.Object
-
- org.infinispan.commands.remote.BaseRpcCommand
-
- org.infinispan.commands.read.DistributedExecuteCommand<V>
-
- All Implemented Interfaces:
CancellableCommand
,CacheRpcCommand
,ReplicableCommand
,VisitableCommand
public class DistributedExecuteCommand<V> extends BaseRpcCommand implements VisitableCommand, CancellableCommand
DistributedExecuteCommand is used to migrate Callable and execute it in remote JVM.- Since:
- 5.0
- Author:
- Vladimir Blagojevic, Mircea Markus
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand
VisitableCommand.LoadType
-
-
Field Summary
Fields Modifier and Type Field Description static int
COMMAND_ID
-
Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand
cacheName
-
-
Constructor Summary
Constructors Constructor Description DistributedExecuteCommand()
DistributedExecuteCommand(ByteString cacheName)
DistributedExecuteCommand(ByteString cacheName, Collection<Object> inputKeys, Callable<V> callable)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
acceptVisitor(InvocationContext ctx, Visitor visitor)
Accept a visitor, and return the result of accepting this visitor.boolean
canBlock()
If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.boolean
equals(Object obj)
Callable<V>
getCallable()
byte
getCommandId()
Used by marshallers to convert this command into an id for streaming.Set<Object>
getKeys()
UUID
getUUID()
Returns UUID of a commandint
hashCode()
boolean
hasKeys()
void
init(Cache<Object,Object> cache)
CompletableFuture<Object>
invokeAsync()
Performs invocation of Callable and returns resultboolean
isReturnValueExpected()
If true, a return value will be provided when performed remotely.VisitableCommand.LoadType
loadType()
Object
perform(InvocationContext ctx)
Performs the primary function of the command.void
readFrom(ObjectInput input)
Reads this instance from the stream written byReplicableCommand.writeTo(ObjectOutput)
.String
toString()
void
writeTo(ObjectOutput output)
Writes this instance to theObjectOutput
.-
Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand
getCacheName, getOrigin, setOrigin
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.infinispan.commands.remote.CacheRpcCommand
getCacheName, getOrigin, setOrigin
-
Methods inherited from interface org.infinispan.commands.ReplicableCommand
invoke, isSuccessful
-
Methods inherited from interface org.infinispan.commands.VisitableCommand
ignoreCommandOnStatus, shouldInvoke
-
-
-
-
Field Detail
-
COMMAND_ID
public static final int COMMAND_ID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DistributedExecuteCommand
public DistributedExecuteCommand(ByteString cacheName)
-
DistributedExecuteCommand
public DistributedExecuteCommand(ByteString cacheName, Collection<Object> inputKeys, Callable<V> callable)
-
DistributedExecuteCommand
public DistributedExecuteCommand()
-
-
Method Detail
-
acceptVisitor
public Object acceptVisitor(InvocationContext ctx, Visitor visitor) throws Throwable
Description copied from interface:VisitableCommand
Accept a visitor, and return the result of accepting this visitor.- Specified by:
acceptVisitor
in interfaceVisitableCommand
- Parameters:
ctx
- invocation contextvisitor
- visitor to accept- Returns:
- arbitrary return value
- Throws:
Throwable
- in the event of problems
-
loadType
public VisitableCommand.LoadType loadType()
- Specified by:
loadType
in interfaceVisitableCommand
- Returns:
- Nodes on which the command needs to read the previous values of the keys it acts on.
-
perform
public Object perform(InvocationContext ctx) throws Throwable
Description copied from interface:VisitableCommand
Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.- Specified by:
perform
in interfaceReplicableCommand
- Specified by:
perform
in interfaceVisitableCommand
- Parameters:
ctx
- invocation context- Returns:
- arbitrary return value generated by performing this command
- Throws:
Throwable
- in the event of problems.
-
invokeAsync
public CompletableFuture<Object> invokeAsync() throws Exception
Performs invocation of Callable and returns result- Specified by:
invokeAsync
in interfaceReplicableCommand
- Throws:
Exception
-
hasKeys
public boolean hasKeys()
-
getCommandId
public byte getCommandId()
Description copied from interface:ReplicableCommand
Used by marshallers to convert this command into an id for streaming.- Specified by:
getCommandId
in interfaceReplicableCommand
- Returns:
- the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.
-
getUUID
public UUID getUUID()
Description copied from interface:CancellableCommand
Returns UUID of a command- Specified by:
getUUID
in interfaceCancellableCommand
- Returns:
- command UUID
-
writeTo
public void writeTo(ObjectOutput output) throws IOException
Description copied from interface:ReplicableCommand
Writes this instance to theObjectOutput
.- Specified by:
writeTo
in interfaceReplicableCommand
- 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 byReplicableCommand.writeTo(ObjectOutput)
.- Specified by:
readFrom
in interfaceReplicableCommand
- 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 classBaseRpcCommand
-
isReturnValueExpected
public boolean isReturnValueExpected()
Description copied from interface:ReplicableCommand
If true, a return value will be provided when performed remotely. Otherwise, a remoteResponseGenerator
may choose to simply return null to save on marshalling costs.- Specified by:
isReturnValueExpected
in interfaceReplicableCommand
- Returns:
- true or false
-
canBlock
public boolean canBlock()
Description copied from interface:ReplicableCommand
If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread. This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.- Specified by:
canBlock
in interfaceReplicableCommand
- Overrides:
canBlock
in classBaseRpcCommand
- Returns:
true
if the command can block/wait,false
otherwise
-
-