Infinispan Distribution 5.2.6.Final-redhat-2

org.infinispan.commands.read
Class DistributedExecuteCommand<V>

java.lang.Object
  extended by org.infinispan.commands.remote.BaseRpcCommand
      extended by 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

Field Summary
static int COMMAND_ID
           
 
Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand
cacheName
 
Constructor Summary
DistributedExecuteCommand()
           
DistributedExecuteCommand(String cacheName)
           
DistributedExecuteCommand(String cacheName, Collection<Object> inputKeys, Callable<V> callable)
           
 
Method Summary
 Object acceptVisitor(InvocationContext ctx, Visitor visitor)
          Accept a visitor, and return the result of accepting this visitor.
 boolean equals(Object obj)
           
 Callable<V> getCallable()
           
 byte getCommandId()
          Used by marshallers to convert this command into an id for streaming.
 Set<Object> getKeys()
           
 Object[] getParameters()
          Used by marshallers to stream this command across a network
 UUID getUUID()
          Returns UUID of a command
 int hashCode()
           
 boolean hasKeys()
           
 boolean ignoreCommandOnStatus(ComponentStatus status)
          Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
 void init(Cache<Object,Object> cache)
           
 boolean isReturnValueExpected()
          If true, a return value will be provided when performed remotely.
 Object perform(InvocationContext context)
          Performs invocation of Callable and returns result
 void setParameters(int commandId, Object[] args)
          Used by the CommandsFactory to create a command from raw data read off a stream.
 boolean shouldInvoke(InvocationContext ctx)
          Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
 String toString()
           
 
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
 

Field Detail

COMMAND_ID

public static final int COMMAND_ID
See Also:
Constant Field Values
Constructor Detail

DistributedExecuteCommand

public DistributedExecuteCommand(String cacheName)

DistributedExecuteCommand

public DistributedExecuteCommand(String cacheName,
                                 Collection<Object> inputKeys,
                                 Callable<V> callable)

DistributedExecuteCommand

public DistributedExecuteCommand()
Method Detail

init

public void init(Cache<Object,Object> cache)

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 interface VisitableCommand
Parameters:
ctx - invocation context
visitor - visitor to accept
Returns:
arbitrary return value
Throws:
Throwable - in the event of problems

ignoreCommandOnStatus

public boolean ignoreCommandOnStatus(ComponentStatus status)
Description copied from interface: VisitableCommand
Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor. Commands can opt to be discarded in case the cache status is not suited (as InvalidateCommand)

Specified by:
ignoreCommandOnStatus in interface VisitableCommand
Returns:
true if the command should NOT be invoked.

shouldInvoke

public boolean shouldInvoke(InvocationContext ctx)
Description copied from interface: VisitableCommand
Used by the InboundInvocationHandler to determine whether the command should be invoked or not.

Specified by:
shouldInvoke in interface VisitableCommand
Returns:
true if the command should be invoked, false otherwise.

perform

public Object perform(InvocationContext context)
               throws Throwable
Performs invocation of Callable and returns result

Specified by:
perform in interface ReplicableCommand
Parameters:
ctx - invocation context
Returns:
result of Callable invocations
Throws:
Throwable - in the event of problems.

getCallable

public Callable<V> getCallable()

getKeys

public Set<Object> getKeys()

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 interface ReplicableCommand
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 interface CancellableCommand
Returns:
command UUID

getParameters

public Object[] getParameters()
Description copied from interface: ReplicableCommand
Used by marshallers to stream this command across a network

Specified by:
getParameters in interface ReplicableCommand
Returns:
an object array of arguments, compatible with pre-2.2.0 MethodCall args.

setParameters

public void setParameters(int commandId,
                          Object[] args)
Description copied from interface: ReplicableCommand
Used by the CommandsFactory to create a command from raw data read off a stream.

Specified by:
setParameters in interface ReplicableCommand
Parameters:
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.
args - object array of args

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class BaseRpcCommand

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.

Specified by:
isReturnValueExpected in interface ReplicableCommand
Returns:
true or false

Infinispan Distribution 5.2.6.Final-redhat-2

Copyright © 2013 JBoss, a division of Red Hat. All Rights Reserved.