org.infinispan.commands.functional

Class WriteOnlyKeyCommand<K,V>

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

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

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

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, ParamsCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand, DataWriteCommand, WriteCommand, RemoteLockCommand

public final class WriteOnlyKeyCommand<K,V>
extends AbstractWriteKeyCommand<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

commandInvocationId

Fields inherited from class org.infinispan.commands.read.AbstractDataCommand

key

Fields inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

flags

Constructor Summary

Constructors

Constructor and Description
WriteOnlyKeyCommand()
WriteOnlyKeyCommand(K key, Consumer<EntryView.WriteEntryView<V>> f, CommandInvocationId id, ValueMatcher valueMatcher, 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.
boolean	alwaysReadsExistingValues()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
boolean	isConditional() Certain commands only work based on a certain condition or state of the cache.
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	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.AbstractWriteKeyCommand

getParams, getValueMatcher, isSuccessful, setValueMatcher

Methods inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

canBlock, getAffectedKeys, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition, isReturnValueExpected

Methods inherited from class org.infinispan.commands.read.AbstractDataCommand

equals, getKey, hashCode, ignoreCommandOnStatus, setKey, shouldInvoke, toString

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getMetadata, getTopologyId, setMetadata, setTopologyId

Methods inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

getFlags, setFlags

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commands.VisitableCommand

ignoreCommandOnStatus, shouldInvoke

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getParameters, setParameters

Methods inherited from interface org.infinispan.commands.MetadataAwareCommand

getMetadata, setMetadata

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Methods inherited from interface org.infinispan.commands.DataCommand

getKey

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

WriteOnlyKeyCommand

public WriteOnlyKeyCommand(K key,
                           Consumer<EntryView.WriteEntryView<V>> f,
                           CommandInvocationId id,
                           ValueMatcher valueMatcher,
                           Params params)

WriteOnlyKeyCommand

public WriteOnlyKeyCommand()

Method Detail

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.

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.

Returns:

true if the command is conditional, false otherwise

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

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.

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.

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.

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.