Package org.infinispan.commands.write

Class PutKeyValueCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.write.PutKeyValueCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, SegmentSpecificCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, DataWriteCommand, WriteCommand, RemoteLockCommand

public class PutKeyValueCommand
extends AbstractDataWriteCommand
implements MetadataAwareCommand

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

Note: Since 9.4, when the flag Flag.PUT_FOR_STATE_TRANSFER is set, the metadata is actually an InternalMetadata that includes the timestamps of the entry from the source node.

Since:

4.0

Author:

[email protected]

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	COMMAND_ID

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

commandInvocationId

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

key, segment

Constructor Summary

Constructors

Constructor	Description
PutKeyValueCommand()
PutKeyValueCommand(Object key, Object value, boolean putIfAbsent, boolean returnEntry, Metadata metadata, int segment, long flagsBitSet, CommandInvocationId commandInvocationId)

Method Summary

Modifier and Type	Method	Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor)	Accept a visitor, and return the result of accepting this visitor.
boolean	equals(Object o)
void	fail()	Make subsequent invocations of WriteCommand.isSuccessful() return false.
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
PrivateMetadata	getInternalMetadata()
Metadata	getMetadata()	Get metadata of this command.
Object	getValue()
ValueMatcher	getValueMatcher()
int	hashCode()
boolean	isConditional()	Certain commands only work based on a certain condition or state of the cache.
boolean	isPutIfAbsent()
boolean	isReturnEntryNecessary()
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.
VisitableCommand.LoadType	loadType()
void	readFrom(ObjectInput input)	Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setInternalMetadata(PrivateMetadata internalMetadata)
void	setMetadata(Metadata metadata)	Sets metadata for this command.
void	setPutIfAbsent(boolean putIfAbsent)
void	setValue(Object value)
void	setValueMatcher(ValueMatcher valueMatcher)
String	toString()
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

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

getAffectedKeys, getCommandInvocationId, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition

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

getFlagsBitSet, getKey, getSegment, getTopologyId, printFlags, setFlagsBitSet, setKey, setTopologyId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.DataCommand

getKey

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

getInternalMetadata, setInternalMetadata

Methods inherited from interface org.infinispan.commands.FlagAffectedCommand

addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, setFlagsBitSet

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, invoke, invokeAsync, logThrowable, setOrigin

Methods inherited from interface org.infinispan.commands.SegmentSpecificCommand

getSegment

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface org.infinispan.commands.VisitableCommand

init

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

isWriteOnly, shouldReplicate

Field Details

COMMAND_ID

public static final byte COMMAND_ID

See Also:

• Constant Field Values

Constructor Details

PutKeyValueCommand

public PutKeyValueCommand()

PutKeyValueCommand

public PutKeyValueCommand(Object key,
 Object value,
 boolean putIfAbsent,
 boolean returnEntry,
 Metadata metadata,
 int segment,
 long flagsBitSet,
 CommandInvocationId commandInvocationId)

Method Details

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

loadType

public VisitableCommand.LoadType loadType()

Specified by:

loadType in interface VisitableCommand

Returns:

Nodes on which the command needs to read the previous values of the keys it acts on.

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

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

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 ReplicableCommand

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.

fail

public void fail()

Description copied from interface: WriteCommand

Make subsequent invocations of WriteCommand.isSuccessful() return false.

Specified by:

fail in interface WriteCommand

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.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Overrides:

isReturnValueExpected in class AbstractDataWriteCommand

Returns:

true or false

getInternalMetadata

public PrivateMetadata getInternalMetadata()

Specified by:

getInternalMetadata in interface DataWriteCommand

setInternalMetadata

public void setInternalMetadata(PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface DataWriteCommand

isReturnEntryNecessary

public boolean isReturnEntryNecessary()