Class IracPutKeyValueCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.write.IracPutKeyValueCommand

All Implemented Interfaces:

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

@ProtoTypeId(1097)
public class IracPutKeyValueCommand
extends AbstractDataWriteCommand
implements MetadataAwareCommand

A WriteCommand used to handle updates from the remote site (for asynchronous cross-site replication).

Asynchronous cross-site replication may originate conflicts and this command allows to change its value based on the user's XSiteEntryMergePolicy installed. The value (and metadata) can change until the command reaches the end of the AsyncInterceptorChain, where the CallInterceptor checks its state and updates or removes the key.

Note, this command is non-transactional, even for transactional caches. This simplifies the conflict resolution.

Since:

12.0

Author:

Pedro Ruivo

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from class AbstractDataWriteCommand

commandInvocationId

Fields inherited from class AbstractDataCommand

cacheName, key, origin, segment, spanAttributes, topologyId

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Constructor	Description
IracPutKeyValueCommand(ByteString cacheName, Object key, int segment, CommandInvocationId commandInvocationId, Object value, Metadata metadata, PrivateMetadata privateMetadata)

Method Summary

Modifier and Type	Method	Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor)	Accept a visitor, and return the result of accepting this visitor.
SiteEntry<Object>	createSiteEntry(String site)	Creates the SiteEntry to be used in XSiteEntryMergePolicy.
boolean	equals(Object o)
void	fail()	Make subsequent invocations of WriteCommand.isSuccessful() return false.
PrivateMetadata	getInternalMetadata()
PrivateMetadata	getInternalMetadata(Object key)
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	isExpiration()
boolean	isRemove()
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	setExpiration(boolean expiration)
void	setInternalMetadata(Object key, PrivateMetadata internalMetadata)
void	setInternalMetadata(PrivateMetadata internalMetadata)
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()
void	updateCommand(SiteEntry<Object> siteEntry)	Updates this command state with the result of XSiteEntryMergePolicy.merge(Object, SiteEntry, SiteEntry).

Methods inherited from class AbstractDataWriteCommand

getAffectedKeys, getCommandInvocationId, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition, isReturnValueExpected

Methods inherited from class AbstractDataCommand

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

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 FlagAffectedCommand

addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, setFlagsBitSet

Methods inherited from interface ReplicableCommand

getCommandId, logThrowable, readFrom, 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

init, invokeAsync

Methods inherited from interface WriteCommand

isWriteOnly, shouldReplicate

Constructor Details

IracPutKeyValueCommand

public IracPutKeyValueCommand(ByteString cacheName,
 Object key,
 int segment,
 CommandInvocationId commandInvocationId,
 Object value,
 Metadata metadata,
 PrivateMetadata privateMetadata)

Method Details

getInternalMetadata

@ProtoField(10)
public PrivateMetadata getInternalMetadata()

Specified by:

getInternalMetadata in interface DataWriteCommand

setInternalMetadata

public void setInternalMetadata(PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface DataWriteCommand

getInternalMetadata

public PrivateMetadata getInternalMetadata(Object key)

Specified by:

getInternalMetadata in interface DataWriteCommand

Specified by:

getInternalMetadata in interface WriteCommand

setInternalMetadata

public void setInternalMetadata(Object key,
 PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface DataWriteCommand

Specified by:

setInternalMetadata in interface WriteCommand

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.

fail

public void fail()

Description copied from interface: WriteCommand

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

Specified by:

fail in interface WriteCommand

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.

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

getValue

public Object getValue()

isRemove

public boolean isRemove()

Returns:

true if this command state is a removal operation, false otherwise.

createSiteEntry

public SiteEntry<Object> createSiteEntry(String site)

Creates the SiteEntry to be used in XSiteEntryMergePolicy.

Parameters:

site - The remote site name.

Returns:

The SiteEntry.

updateCommand

public void updateCommand(SiteEntry<Object> siteEntry)

Updates this command state with the result of XSiteEntryMergePolicy.merge(Object, SiteEntry, SiteEntry).

Parameters:

siteEntry - The resolved SiteEntry.

isExpiration

public boolean isExpiration()

setExpiration

public void setExpiration(boolean expiration)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDataCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDataCommand

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.

toString

public String toString()

Overrides:

toString in class AbstractDataCommand