Class PutMapCommand

java.lang.Object

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.AbstractTopologyAffectedCommand

org.infinispan.commands.write.PutMapCommand

All Implemented Interfaces:

FlagAffectedCommand, MetadataAwareCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, WriteCommand, VersionAware, RemoteLockCommand

@ProtoTypeId(1148)
public class PutMapCommand
extends AbstractTopologyAffectedCommand
implements WriteCommand, MetadataAwareCommand, RemoteLockCommand

A command writing multiple key/value pairs with the same metadata.

Since:

4.0

Author:

Mircea.Markus@jboss.com

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from class AbstractTopologyAffectedCommand

topologyId

Fields inherited from class AbstractFlagAffectedCommand

cacheName, flags, origin, spanAttributes

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Constructor	Description
PutMapCommand(PutMapCommand c)
PutMapCommand(ByteString cacheName, Map<?,?> map, Metadata metadata, 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.
Collection<?>	getAffectedKeys()
CommandInvocationId	getCommandInvocationId()
PrivateMetadata	getInternalMetadata(Object key)
Object	getKeyLockOwner()	It returns the lock owner of the key.
Collection<?>	getKeysToLock()	It returns a Collection with the keys to be lock.
Map<Object,Object>	getMap()
Metadata	getMetadata()	Get metadata of this command.
ValueMatcher	getValueMatcher()
int	hashCode()
boolean	hasSkipLocking()	It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
boolean	isConditional()	Certain commands only work based on a certain condition or state of the cache.
boolean	isForwarded()	For non transactional caches that support concurrent writes (default), the commands are forwarded between nodes, e.g.: - commands is executed on node A, but some of the keys should be locked on node B - the command is send to the main owner (B) - B tries to acquire lock on the keys it owns, then forwards the commands to the other owners as well - at this last stage, the command has the "isForwarded" flag set to true.
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.
VisitableCommand.LoadType	loadType()
void	setForwarded(boolean forwarded)
void	setInternalMetadata(Object key, PrivateMetadata internalMetadata)
void	setMap(Map<Object,Object> map)
void	setMetadata(Metadata metadata)	Sets metadata for this command.
void	setValueMatcher(ValueMatcher valueMatcher)
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.
String	toString()
final PutMapCommand	withMap(Map<Object,Object> map)

Methods inherited from class AbstractTopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from class AbstractFlagAffectedCommand

getCacheName, getFlagsBitSet, getFlagsWithoutRemote, getOrigin, getSpanAttributes, hasSameFlags, printFlags, setFlagsBitSet, setOrigin, setSpanAttributes

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 FlagAffectedCommand

addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, setFlagsBitSet

Methods inherited from interface ReplicableCommand

getCommandId, logThrowable, readFrom, writeTo

Methods inherited from interface TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface VisitableCommand

init, invokeAsync

Methods inherited from interface WriteCommand

isWriteOnly, shouldReplicate

Constructor Details

PutMapCommand

public PutMapCommand(ByteString cacheName,
 Map<?,?> map,
 Metadata metadata,
 long flagsBitSet,
 CommandInvocationId commandInvocationId)

PutMapCommand

public PutMapCommand(PutMapCommand c)

Method Details

getCommandInvocationId

@ProtoField(6)
public CommandInvocationId getCommandInvocationId()

Specified by:

getCommandInvocationId in interface WriteCommand

Returns:

the CommandInvocationId associated to the command.

isForwarded

@ProtoField(7)
public boolean isForwarded()

For non transactional caches that support concurrent writes (default), the commands are forwarded between nodes, e.g.: - commands is executed on node A, but some of the keys should be locked on node B - the command is send to the main owner (B) - B tries to acquire lock on the keys it owns, then forwards the commands to the other owners as well - at this last stage, the command has the "isForwarded" flag set to true.

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

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

getMap

public Map<Object,Object> getMap()

setMap

public void setMap(Map<Object,Object> map)

withMap

public final PutMapCommand withMap(Map<Object,Object> map)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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

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.

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.

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

Returns:

true or false

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.

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

setForwarded

public void setForwarded(boolean forwarded)

See Also:

• isForwarded()

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

supportedSince

public NodeVersion supportedSince()

Description copied from interface: ReplicableCommand

Returns a NodeVersion representing the Infinispan version in which this command was added. This value is used to ensure that when the cluster contains different Infinispan versions, only commands compatible with the oldest version are transmitted.

Abstract classes should not implement this method as the version should be specific to an individual implementation. Similarly, implementations which extend another ReplicableCommand should always override this method.

Specified by:

supportedSince in interface ReplicableCommand

Specified by:

supportedSince in interface VersionAware

Returns:

a NodeVersion corresponding to the Infinispan version this command was added.