org.infinispan.commands.write

Class AbstractDataWriteCommand

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand, DataWriteCommand, WriteCommand, RemoteLockCommand

Direct Known Subclasses:

AbstractWriteKeyCommand, ApplyDeltaCommand, PutKeyValueCommand, RemoveCommand, ReplaceCommand

public abstract class AbstractDataWriteCommand
extends AbstractDataCommand
implements DataWriteCommand, RemoteLockCommand

Stuff common to WriteCommands

Since:

4.0

Author:

Manik Surtani

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandInvocationId	commandInvocationId

Fields inherited from class org.infinispan.commands.read.AbstractDataCommand

key

Fields inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

flags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataWriteCommand()
protected	AbstractDataWriteCommand(Object key, Set<Flag> flags, CommandInvocationId commandInvocationId)

Method Summary

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
Set<Object>	getAffectedKeys()
Object	getKeyLockOwner() It returns the lock owner of the key.
Collection<Object>	getKeysToLock() It returns a Collection with the keys to be lock.
boolean	hasSkipLocking() It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.

Methods inherited from class org.infinispan.commands.read.AbstractDataCommand

equals, getKey, hashCode, ignoreCommandOnStatus, setKey, shouldInvoke, toString

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getMetadata, getTopologyId, setMetadata, setTopologyId

Methods inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

getFlags, setFlags

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.write.WriteCommand

getValueMatcher, isConditional, isSuccessful, isWriteOnly, setValueMatcher, updateStatusFromRemoteResponse

Methods inherited from interface org.infinispan.commands.VisitableCommand

acceptVisitor, alwaysReadsExistingValues, ignoreCommandOnStatus, readsExistingValues, shouldInvoke

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getCommandId, getParameters, perform, readFrom, setParameters, writeTo

Methods inherited from interface org.infinispan.commands.MetadataAwareCommand

getMetadata, setMetadata

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Methods inherited from interface org.infinispan.commands.DataCommand

getKey

Field Detail

commandInvocationId

protected CommandInvocationId commandInvocationId

Constructor Detail

AbstractDataWriteCommand

protected AbstractDataWriteCommand()

AbstractDataWriteCommand

protected AbstractDataWriteCommand(Object key,
                                   Set<Flag> flags,
                                   CommandInvocationId commandInvocationId)

Method Detail

getAffectedKeys

public Set<Object> 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

canBlock

public boolean canBlock()

Description copied from interface: ReplicableCommand

If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread.

This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.

Specified by:

canBlock in interface ReplicableCommand

Overrides:

canBlock in class AbstractDataCommand

Returns:

true if the command can block/wait, false otherwise

getKeysToLock

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