org.infinispan.commands.remote

Class MultipleRpcCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.remote.BaseRpcInvokingCommand

org.infinispan.commands.remote.MultipleRpcCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class MultipleRpcCommand
extends BaseRpcInvokingCommand

Command that implements cluster replication logic.

This is not a VisitableCommand and hence not passed up the CommandInterceptor chain.

Since:

4.0

Author:

Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

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

icf, interceptorChain

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

cacheName

Constructor Summary

Constructors

Constructor and Description
MultipleRpcCommand(List<ReplicableCommand> modifications, String cacheName)
MultipleRpcCommand(String cacheName)

Method Summary

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
boolean	equals(Object o)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
ReplicableCommand[]	getCommands()
int	hashCode()
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
Object	perform(InvocationContext ctx) Executes commands replicated to the current cache instance by other cache instances.
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.BaseRpcInvokingCommand

init, processVisitableCommand

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.ReplicableCommand

getParameters, setParameters

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

MultipleRpcCommand

public MultipleRpcCommand(List<ReplicableCommand> modifications,
                          String cacheName)

MultipleRpcCommand

public MultipleRpcCommand(String cacheName)

Method Detail

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Executes commands replicated to the current cache instance by other cache instances.

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

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.

getCommands

public ReplicableCommand[] getCommands()

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode 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.

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 interface ReplicableCommand

Overrides:

canBlock in class BaseRpcCommand

Returns:

true if the command can block/wait, false otherwise