Class AbstractDataWriteCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, SegmentSpecificCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, DataWriteCommand, WriteCommand, VersionAware, RemoteLockCommand

Direct Known Subclasses:

AbstractWriteKeyCommand, ComputeCommand, ComputeIfAbsentCommand, IracPutKeyValueCommand, PutKeyValueCommand, RemoveCommand, ReplaceCommand

public abstract class AbstractDataWriteCommand
extends AbstractDataCommand
implements CacheRpcCommand, DataWriteCommand, RemoteLockCommand

Stuff common to WriteCommands

Since:

4.0

Author:

Manik Surtani

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandInvocationId	commandInvocationId

Fields inherited from class AbstractDataCommand

cacheName, key, origin, segment, spanAttributes, topologyId

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataWriteCommand(ByteString cacheName, Object key, int segment, long flagsBitSet, CommandInvocationId commandInvocationId)
protected	AbstractDataWriteCommand(ByteString cacheName, MarshallableObject<?> wrappedKey, long flags, int topologyId, int segment, CommandInvocationId commandInvocationId)

Method Summary

Modifier and Type	Method	Description
Collection<?>	getAffectedKeys()
CommandInvocationId	getCommandInvocationId()
final Object	getKeyLockOwner()	It returns the lock owner of the key.
Collection<?>	getKeysToLock()	It returns a Collection with the keys to be lock.
final boolean	hasSkipLocking()	It checks if this command should acquire locks.
final boolean	hasZeroLockAcquisition()
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.

Methods inherited from class AbstractDataCommand

equals, getCacheName, getFlagsBitSet, getFlagsWithoutRemote, getKey, getOrigin, getSegment, getSpanAttributes, getTopologyId, getWrappedKey, hashCode, printFlags, setFlagsBitSet, setKey, setOrigin, setSpanAttributes, setTopologyId, toString

Methods inherited from class Object

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

Methods inherited from interface CacheRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from interface DataCommand

getKey

Methods inherited from interface DataWriteCommand

getInternalMetadata, getInternalMetadata, setInternalMetadata, setInternalMetadata

Methods inherited from interface FlagAffectedCommand

addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, setFlagsBitSet

Methods inherited from interface ReplicableCommand

getCommandId, logThrowable, readFrom, supportedSince, writeTo

Methods inherited from interface SegmentSpecificCommand

getSegment

Methods inherited from interface TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface VisitableCommand

acceptVisitor, init, invokeAsync, loadType

Methods inherited from interface WriteCommand

fail, getValueMatcher, isConditional, isSuccessful, isWriteOnly, setValueMatcher, shouldReplicate

Field Details

commandInvocationId

protected CommandInvocationId commandInvocationId

Constructor Details

AbstractDataWriteCommand

protected AbstractDataWriteCommand(ByteString cacheName,
 MarshallableObject<?> wrappedKey,
 long flags,
 int topologyId,
 int segment,
 CommandInvocationId commandInvocationId)

AbstractDataWriteCommand

protected AbstractDataWriteCommand(ByteString cacheName,
 Object key,
 int segment,
 long flagsBitSet,
 CommandInvocationId commandInvocationId)

Method Details

getAffectedKeys

public Collection<?> getAffectedKeys()

Specified by:

getAffectedKeys in interface WriteCommand

Returns:

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

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 AbstractDataCommand

Returns:

true or false

getKeysToLock

public Collection<?> getKeysToLock()

Description copied from interface: RemoteLockCommand

It returns a Collection with the keys to be lock.

It may return an empty collection if no keys needs to be locked independently of the return value of RemoteLockCommand.hasSkipLocking(). It may contains duplicated keys and null is not a valid return value.

Specified by:

getKeysToLock in interface RemoteLockCommand

Returns:

a Collection of keys to lock.

getKeyLockOwner

public final Object getKeyLockOwner()

Description copied from interface: RemoteLockCommand

It returns the lock owner of the key.

Usually, in transaction caches it is the GlobalTransaction and in non-transactional caches the CommandInvocationId.

Specified by:

getKeyLockOwner in interface RemoteLockCommand

Returns:

the lock owner of the key.

hasZeroLockAcquisition

public final boolean hasZeroLockAcquisition()

Specified by:

hasZeroLockAcquisition in interface RemoteLockCommand

Returns:

it the locks should be acquire with 0 (zero) acquisition timeout.

hasSkipLocking

public final boolean hasSkipLocking()

Description copied from interface: RemoteLockCommand

It checks if this command should acquire locks.

Specified by:

hasSkipLocking in interface RemoteLockCommand

Returns:

true if locks should be acquired for the keys in RemoteLockCommand.getKeysToLock().

getCommandInvocationId

@ProtoField(6)
public CommandInvocationId getCommandInvocationId()

Specified by:

getCommandInvocationId in interface WriteCommand

Returns:

the CommandInvocationId associated to the command.