Class AbstractWriteManyCommand<K,V>

java.lang.Object

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

All Implemented Interfaces:

FlagAffectedCommand, FunctionalCommand<K,V>, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, WriteCommand, VersionAware, RemoteLockCommand

Direct Known Subclasses:

ReadWriteManyCommand, ReadWriteManyEntriesCommand, WriteOnlyManyCommand, WriteOnlyManyEntriesCommand

public abstract class AbstractWriteManyCommand<K,V>
extends Object
implements CacheRpcCommand, WriteCommand, FunctionalCommand<K,V>, RemoteLockCommand

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWriteManyCommand(AbstractWriteManyCommand<K,V> c)
protected	AbstractWriteManyCommand(ByteString cacheName, CommandInvocationId commandInvocationId, boolean forwarded, int topologyId, Params params, long flags, DataConversion keyDataConversion, DataConversion valueDataConversion, MarshallableMap<Object, PrivateMetadata> internalMetadataMap)
protected	AbstractWriteManyCommand(ByteString cacheName, CommandInvocationId commandInvocationId, Params params, DataConversion keyDataConversion, DataConversion valueDataConversion)

Method Summary

Modifier and Type	Method	Description
void	fail()	Make subsequent invocations of WriteCommand.isSuccessful() return false.
ByteString	getCacheName()
CommandInvocationId	getCommandInvocationId()
long	getFlagsBitSet()
PrivateMetadata	getInternalMetadata(Object key)
DataConversion	getKeyDataConversion()
Object	getKeyLockOwner()	It returns the lock owner of the key.
Address	getOrigin()	Get the origin of the command
Params	getParams()
int	getTopologyId()
DataConversion	getValueDataConversion()
ValueMatcher	getValueMatcher()
boolean	hasSkipLocking()	It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
void	init(ComponentRegistry componentRegistry)
boolean	isConditional()	Certain commands only work based on a certain condition or state of the cache.
boolean	isForwarded()
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
boolean	isSuccessful()	If true, a return value will be marshalled as a SuccessfulResponse, otherwise it will be marshalled as a UnsuccessfulResponse.
void	setFlagsBitSet(long bitSet)	Set the flags, replacing any existing flags.
void	setForwarded(boolean forwarded)
void	setInternalMetadata(Object key, PrivateMetadata internalMetadata)
void	setOrigin(Address origin)	Set the origin of the command
void	setParams(Params params)
void	setTopologyId(int topologyId)
void	setValueMatcher(ValueMatcher valueMatcher)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FlagAffectedCommand

addFlags, getFlags, hasAllFlags, hasAnyFlag

Methods inherited from interface FunctionalCommand

toMutation

Methods inherited from interface RemoteLockCommand

getKeysToLock

Methods inherited from interface ReplicableCommand

getCommandId, logThrowable, readFrom, supportedSince, writeTo

Methods inherited from interface TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface VisitableCommand

acceptVisitor, invokeAsync, loadType

Methods inherited from interface WriteCommand

getAffectedKeys, isWriteOnly, shouldReplicate

Constructor Details

AbstractWriteManyCommand

protected AbstractWriteManyCommand(ByteString cacheName,
 CommandInvocationId commandInvocationId,
 boolean forwarded,
 int topologyId,
 Params params,
 long flags,
 DataConversion keyDataConversion,
 DataConversion valueDataConversion,
 MarshallableMap<Object, PrivateMetadata> internalMetadataMap)

AbstractWriteManyCommand

protected AbstractWriteManyCommand(ByteString cacheName,
 CommandInvocationId commandInvocationId,
 Params params,
 DataConversion keyDataConversion,
 DataConversion valueDataConversion)

AbstractWriteManyCommand

protected AbstractWriteManyCommand(AbstractWriteManyCommand<K,V> c)

Method Details

init

public void init(ComponentRegistry componentRegistry)

Specified by:

init in interface VisitableCommand

getCacheName

public ByteString getCacheName()

Specified by:

getCacheName in interface CacheRpcCommand

Returns:

the name of the cache that produced this command. This will also be the name of the cache this command is intended for.

getOrigin

public Address getOrigin()

Description copied from interface: CacheRpcCommand

Get the origin of the command

Specified by:

getOrigin in interface CacheRpcCommand

setOrigin

public void setOrigin(Address origin)

Description copied from interface: CacheRpcCommand

Set the origin of the command

Specified by:

setOrigin in interface CacheRpcCommand

Specified by:

setOrigin in interface ReplicableCommand

Parameters:

origin - the sender's Address

getTopologyId

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

isForwarded

public boolean isForwarded()

setForwarded

public void setForwarded(boolean forwarded)

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.

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

Returns:

true or false

isSuccessful

public boolean isSuccessful()

Description copied from interface: ReplicableCommand

If true, a return value will be marshalled as a SuccessfulResponse, otherwise it will be marshalled as a UnsuccessfulResponse.

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

fail

public void fail()

Description copied from interface: WriteCommand

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

Specified by:

fail in interface WriteCommand

getFlagsBitSet

public long getFlagsBitSet()

Specified by:

getFlagsBitSet in interface FlagAffectedCommand

Returns:

The command flags. Flags can be modified with FlagAffectedCommand.setFlagsBitSet(long), FlagAffectedCommand.addFlags(long) and FlagAffectedCommand.addFlags(long) methods.

setFlagsBitSet

public void setFlagsBitSet(long bitSet)

Description copied from interface: FlagAffectedCommand

Set the flags, replacing any existing flags.

Specified by:

setFlagsBitSet in interface FlagAffectedCommand

getParams

public Params getParams()

Specified by:

getParams in interface FunctionalCommand<K,V>

setParams

public void setParams(Params params)

getKeyLockOwner

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

getCommandInvocationId

public CommandInvocationId getCommandInvocationId()

Specified by:

getCommandInvocationId in interface WriteCommand

Returns:

the CommandInvocationId associated to the command.

hasZeroLockAcquisition

public boolean hasZeroLockAcquisition()

Specified by:

hasZeroLockAcquisition in interface RemoteLockCommand

Returns:

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

hasSkipLocking

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

getKeyDataConversion

public DataConversion getKeyDataConversion()

Specified by:

getKeyDataConversion in interface FunctionalCommand<K,V>

getValueDataConversion

public DataConversion getValueDataConversion()

Specified by:

getValueDataConversion in interface FunctionalCommand<K,V>

getInternalMetadata

public PrivateMetadata getInternalMetadata(Object key)

Specified by:

getInternalMetadata in interface WriteCommand

setInternalMetadata

public void setInternalMetadata(Object key,
 PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface WriteCommand