org.infinispan.commands.write

Class PutKeyValueCommand

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.write.PutKeyValueCommand

All Implemented Interfaces:

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

public class PutKeyValueCommand
extends AbstractDataWriteCommand
implements MetadataAwareCommand

Implements functionality defined by BasicCache.put(Object, Object)

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.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
PutKeyValueCommand()
PutKeyValueCommand(Object key, Object value, boolean putIfAbsent, CacheNotifier notifier, Metadata metadata, Set<Flag> flags, Equivalence valueEquivalence, CommandInvocationId commandInvocationId)

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	equals(Object o)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Metadata	getMetadata() Get metadata of this command.
Object	getValue()
ValueMatcher	getValueMatcher()
int	hashCode()
void	init(CacheNotifier notifier, Configuration cfg)
boolean	isConditional() Certain commands only work based on a certain condition or state of the cache.
boolean	isPutIfAbsent()
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	setMetadata(Metadata metadata) Sets metadata for this command.
void	setPutIfAbsent(boolean putIfAbsent)
void	setValue(Object value)
void	setValueMatcher(ValueMatcher valueMatcher)
String	toString()
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.write.AbstractDataWriteCommand

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

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

getKey, ignoreCommandOnStatus, setKey, shouldInvoke

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getTopologyId, 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.write.WriteCommand

isWriteOnly

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

PutKeyValueCommand

public PutKeyValueCommand()

PutKeyValueCommand

public PutKeyValueCommand(Object key,
                          Object value,
                          boolean putIfAbsent,
                          CacheNotifier notifier,
                          Metadata metadata,
                          Set<Flag> flags,
                          Equivalence valueEquivalence,
                          CommandInvocationId commandInvocationId)

Method Detail

init

public void init(CacheNotifier notifier,
                 Configuration cfg)

getValue

public Object getValue()

setValue

public void setValue(Object value)

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

readsExistingValues

public boolean readsExistingValues()

Specified by:

readsExistingValues in interface VisitableCommand

Returns:

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

alwaysReadsExistingValues

public boolean alwaysReadsExistingValues()

Specified by:

alwaysReadsExistingValues in interface VisitableCommand

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.

Specified by:

perform in interface ReplicableCommand

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.

Specified by:

getCommandId in interface ReplicableCommand

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.

Specified by:

writeTo in interface ReplicableCommand

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

Specified by:

readFrom in interface ReplicableCommand

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.

getMetadata

public Metadata getMetadata()

Description copied from interface: MetadataAwareCommand

Get metadata of this command.

Specified by:

getMetadata in interface MetadataAwareCommand

Overrides:

getMetadata in class AbstractFlagAffectedCommand

Returns:

an instance of Metadata

setMetadata

public void setMetadata(Metadata metadata)

Description copied from interface: MetadataAwareCommand

Sets metadata for this command.

Specified by:

setMetadata in interface MetadataAwareCommand

Overrides:

setMetadata in class AbstractFlagAffectedCommand

isPutIfAbsent

public boolean isPutIfAbsent()

setPutIfAbsent

public void setPutIfAbsent(boolean putIfAbsent)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDataCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDataCommand

toString

public String toString()

Overrides:

toString in class AbstractDataCommand

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

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

Returns:

true if the command is conditional, false otherwise

getValueMatcher

public ValueMatcher getValueMatcher()

Specified by:

getValueMatcher in interface WriteCommand

Returns:

The current value matching policy.

setValueMatcher

public void setValueMatcher(ValueMatcher valueMatcher)

Specified by:

setValueMatcher in interface WriteCommand

Parameters:

valueMatcher - The new value matching policy.

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.

Specified by:

updateStatusFromRemoteResponse in interface WriteCommand