org.infinispan.commands.functional

Class ReadWriteManyCommand<K,V,R>

java.lang.Object

org.infinispan.commands.functional.AbstractWriteManyCommand

org.infinispan.commands.functional.ReadWriteManyCommand<K,V,R>

All Implemented Interfaces:

FlagAffectedCommand, ParamsCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand, WriteCommand

public final class ReadWriteManyCommand<K,V,R>
extends AbstractWriteManyCommand

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Constructor Summary

Constructors

Constructor and Description
ReadWriteManyCommand()
ReadWriteManyCommand(ReadWriteManyCommand command)
ReadWriteManyCommand(Set<? extends K> keys, Function<EntryView.ReadWriteEntryView<K,V>,R> f, Params params)

Method Summary

Modifier and Type	Method and Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
void	addAllRemoteReturns(List<R> returns)
boolean	alwaysReadsExistingValues()
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
Set<Object>	getAffectedKeys()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Set<? extends K>	getKeys()
int	getTopologyId()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
boolean	isConditional() Certain commands only work based on a certain condition or state of the cache.
boolean	isForwarded()
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
boolean	isSuccessful() Some commands may want to provide information on whether the command was successful or not.
Object	perform(InvocationContext ctx) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
boolean	readsExistingValues()
void	setForwarded(boolean forwarded)
void	setKeys(Set<? extends K> keys)
void	setTopologyId(int topologyId)
boolean	shouldInvoke(InvocationContext ctx) Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
void	updateStatusFromRemoteResponse(Object remoteResponse) Used for conditional commands, to update the status of the command on the originator based on the result of its execution on the primary owner.
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.functional.AbstractWriteManyCommand

getFlags, getMetadata, getParams, getValueMatcher, hasFlag, setFlags, setFlags, setMetadata, setParams, setValueMatcher

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.commands.write.WriteCommand

isWriteOnly

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getParameters, setParameters

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

ReadWriteManyCommand

public ReadWriteManyCommand(Set<? extends K> keys,
                            Function<EntryView.ReadWriteEntryView<K,V>,R> f,
                            Params params)

ReadWriteManyCommand

public ReadWriteManyCommand(ReadWriteManyCommand command)

ReadWriteManyCommand

public ReadWriteManyCommand()

Method Detail

getKeys

public Set<? extends K> getKeys()

setKeys

public void setKeys(Set<? extends K> keys)

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.

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.

isForwarded

public boolean isForwarded()

Overrides:

isForwarded in class AbstractWriteManyCommand

setForwarded

public void setForwarded(boolean forwarded)

Overrides:

setForwarded in class AbstractWriteManyCommand

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

Overrides:

shouldInvoke in class AbstractWriteManyCommand

Returns:

true if the command should be invoked, false otherwise.

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

addAllRemoteReturns

public void addAllRemoteReturns(List<R> returns)

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

Overrides:

getTopologyId in class AbstractWriteManyCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

Overrides:

setTopologyId in class AbstractWriteManyCommand

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.

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from interface: ReplicableCommand

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.

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

isSuccessful

public boolean isSuccessful()

Description copied from interface: WriteCommand

Some commands may want to provide information on whether the command was successful or not. This is different from a failure, which usually would result in an exception being thrown. An example is a putIfAbsent() not doing anything because the key in question was present. This would result in a isSuccessful() call returning false.

Specified by:

isSuccessful in interface WriteCommand

Overrides:

isSuccessful in class AbstractWriteManyCommand

Returns:

true if the command completed successfully, false otherwise.

isConditional

public boolean isConditional()

Description copied from interface: WriteCommand

Certain commands only work based on a certain condition or state of the cache. For example, ConcurrentMap.putIfAbsent(Object, Object) only does anything if a condition is met, i.e., the entry in question is not already present. This method tests whether the command in question is conditional or not.

Specified by:

isConditional in interface WriteCommand

Overrides:

isConditional in class AbstractWriteManyCommand

Returns:

true if the command is conditional, false otherwise

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.

Returns:

true if the command can block/wait, false otherwise

getAffectedKeys

public Set<Object> getAffectedKeys()

Returns:

a collection of keys affected by this write command. Some commands - such as ClearCommand - may return an empty collection for this method.

updateStatusFromRemoteResponse

public void updateStatusFromRemoteResponse(Object remoteResponse)

Description copied from interface: WriteCommand

Used for conditional commands, to update the status of the command on the originator based on the result of its execution on the primary owner.

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)

Returns:

true if the command should NOT be invoked.

readsExistingValues

public boolean readsExistingValues()

Returns:

true if the command needs to read the previous values of the keys it acts on.

alwaysReadsExistingValues

public boolean alwaysReadsExistingValues()

Returns:

true if the command needs to read the previous values even on the backup owners. In transactional caches, this refers to all the owners except the originator.