Class RemoveCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.write.RemoveCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

EvictCommand, RemoveExpiredCommand

@ProtoTypeId(28)
public class RemoveCommand
extends AbstractDataWriteCommand
implements MetadataAwareCommand

Since:

4.0

Author:

Mircea.Markus@jboss.com, Galder Zamarreno

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
protected Metadata	metadata
protected boolean	successful
protected Object	value	When not null, value indicates that the entry should only be removed if the key is mapped to this value.
protected ValueMatcher	valueMatcher

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
RemoveCommand(ByteString cacheName, Object key, Object value, boolean returnEntry, 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.
PrivateMetadata	getInternalMetadata()
Metadata	getMetadata()	Get metadata of this command.
Object	getValue()
ValueMatcher	getValueMatcher()
protected MarshallableObject<Metadata>	getWrappedMetadata()
protected MarshallableObject<?>	getWrappedValue()
int	hashCode()
boolean	isConditional()	Certain commands only work based on a certain condition or state of the cache.
boolean	isReturnEntryNecessary()
final 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	nonExistant()
void	setInternalMetadata(PrivateMetadata internalMetadata)
void	setMetadata(Metadata metadata)	Sets metadata for this command.
void	setValue(Object value)
void	setValueMatcher(ValueMatcher valueMatcher)
boolean	shouldReplicate(InvocationContext ctx, boolean requireReplicateIfRemote)	Some commands may be successful but not need to be replicated to other nodes, stores or listeners.
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.
String	toString()

Methods inherited from class AbstractDataWriteCommand

getAffectedKeys, getCommandInvocationId, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition

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 DataWriteCommand

getInternalMetadata, setInternalMetadata

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

Field Details

successful

protected transient boolean successful

metadata

protected Metadata metadata

valueMatcher

protected ValueMatcher valueMatcher

value

protected Object value

When not null, value indicates that the entry should only be removed if the key is mapped to this value. When null, the entry should be removed regardless of what value it is mapped to.

Constructor Details

RemoveCommand

public RemoveCommand(ByteString cacheName,
 Object key,
 Object value,
 boolean returnEntry,
 int segment,
 long flagsBitSet,
 CommandInvocationId commandInvocationId)

Method Details

getWrappedValue

@ProtoField(number=7,
            name="value")
protected MarshallableObject<?> getWrappedValue()

getWrappedMetadata

@ProtoField(number=8,
            name="metadata")
protected MarshallableObject<Metadata> getWrappedMetadata()

getValueMatcher

@ProtoField(9)
public ValueMatcher getValueMatcher()

Specified by:

getValueMatcher in interface WriteCommand

Returns:

The current value matching policy.

getInternalMetadata

@ProtoField(10)
public PrivateMetadata getInternalMetadata()

Specified by:

getInternalMetadata in interface DataWriteCommand

setInternalMetadata

public void setInternalMetadata(PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface DataWriteCommand

isReturnEntryNecessary

@ProtoField(11)
public boolean isReturnEntryNecessary()

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

shouldReplicate

public boolean shouldReplicate(InvocationContext ctx,
 boolean requireReplicateIfRemote)

Description copied from interface: WriteCommand

Some commands may be successful but not need to be replicated to other nodes, stores or listeners. For example a unconditional remove may be performed on a key that doesn't exist. In that case the command is still successful but does not need to replicate that information other places.

Specified by:

shouldReplicate in interface WriteCommand

Parameters:

ctx - invocation context if present, may be null

requireReplicateIfRemote - if the command can replicate even if not a locally invoked command

Returns:

whether the command should replicate default just invokes WriteCommand.isSuccessful()

setMetadata

public void setMetadata(Metadata metadata)

Description copied from interface: MetadataAwareCommand

Sets metadata for this command.

Specified by:

setMetadata in interface MetadataAwareCommand

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

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: 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

nonExistant

public void nonExistant()

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

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.

getValue

public Object getValue()

setValue

public void setValue(Object value)

isReturnValueExpected

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

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.