org.infinispan.commands.functional

Class WriteOnlyManyEntriesCommand<K,V>

java.lang.Object

org.infinispan.commands.functional.AbstractWriteManyCommand<K,V>

org.infinispan.commands.functional.WriteOnlyManyEntriesCommand<K,V>

All Implemented Interfaces:

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

public final class WriteOnlyManyEntriesCommand<K,V>
extends AbstractWriteManyCommand<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Constructor Summary

Constructors

Constructor and Description
WriteOnlyManyEntriesCommand()
WriteOnlyManyEntriesCommand(Map<? extends K,? extends V> entries, BiConsumer<V,EntryView.WriteEntryView<V>> f, Params params)
WriteOnlyManyEntriesCommand(WriteOnlyManyEntriesCommand<K,V> command)

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.
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.
Map<? extends K,? extends V>	getEntries()
Set<? extends K>	getKeys()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
boolean	isWriteOnly() Indicates whether the command is write-only, meaning that it makes no attempt to read the previously associated value with key for which the command is directed.
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	setEntries(Map<? extends K,? extends V> entries)
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, getTopologyId, getValueMatcher, hasFlag, isConditional, isForwarded, isSuccessful, setFlags, setFlags, setForwarded, setMetadata, setParams, setTopologyId, setValueMatcher, shouldInvoke

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

WriteOnlyManyEntriesCommand

public WriteOnlyManyEntriesCommand(Map<? extends K,? extends V> entries,
                                   BiConsumer<V,EntryView.WriteEntryView<V>> f,
                                   Params params)

WriteOnlyManyEntriesCommand

public WriteOnlyManyEntriesCommand(WriteOnlyManyEntriesCommand<K,V> command)

WriteOnlyManyEntriesCommand

public WriteOnlyManyEntriesCommand()

Method Detail

getEntries

public Map<? extends K,? extends V> getEntries()

setEntries

public void setEntries(Map<? extends K,? extends V> entries)

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.

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.

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.

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.

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

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.

isWriteOnly

public boolean isWriteOnly()

Description copied from interface: WriteCommand

Indicates whether the command is write-only, meaning that it makes no attempt to read the previously associated value with key for which the command is directed.

Returns:

true is the command is write only, false otherwise.

getKeys

public Set<? extends K> getKeys()