Class LockControlCommand

java.lang.Object

org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

org.infinispan.commands.control.LockControlCommand

All Implemented Interfaces:

FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, TransactionBoundaryCommand, VisitableCommand, VersionAware, RemoteLockCommand, TransactionalRemoteLockCommand

@ProtoTypeId(1118)
public class LockControlCommand
extends AbstractTransactionBoundaryCommand
implements FlagAffectedCommand, TopologyAffectedCommand, TransactionalRemoteLockCommand

LockControlCommand is a command that enables distributed locking across infinispan nodes. For more details refer to: https://jira.jboss.org/jira/browse/ISPN-70 https://jira.jboss.org/jira/browse/ISPN-48

Since:

4.0

Author:

Vladimir Blagojevic (vblagoje@redhat.com), Mircea.Markus@jboss.com

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from class AbstractTransactionBoundaryCommand

cacheName, globalTx

Constructor Summary

Constructors

Constructor	Description
LockControlCommand(Object key, ByteString cacheName, long flags, GlobalTransaction globalTx)
LockControlCommand(Collection<?> keys, ByteString cacheName, long flags, GlobalTransaction globalTx)

Method Summary

Modifier and Type	Method	Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor)	Accept a visitor, and return the result of accepting this visitor.
RemoteTxInvocationContext	createContext(ComponentRegistry componentRegistry)	It creates the transaction context.
boolean	equals(Object o)
long	getFlagsBitSet()
Object	getKeyLockOwner()	It returns the lock owner of the key.
Collection<Object>	getKeys()
Collection<?>	getKeysToLock()	It returns a Collection with the keys to be lock.
Object	getSingleKey()
int	hashCode()
boolean	hasSkipLocking()	It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
CompletionStage<?>	invokeAsync(ComponentRegistry registry)	Invoke the command asynchronously.
boolean	isUnlock()
boolean	multipleKeys()
void	setFlagsBitSet(long bitSet)	Set the flags, replacing any existing flags.
void	setGlobalTransaction(GlobalTransaction gtx)
void	setUnlock(boolean unlock)
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.
String	toString()

Methods inherited from class AbstractTransactionBoundaryCommand

getCacheName, getGlobalTransaction, getOrigin, getTopologyId, invalidRemoteTxReturnValue, isReturnValueExpected, loadType, markTransactionAsRemote, setOrigin, setTopologyId, visitRemoteTransaction

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, hasAllFlags, hasAnyFlag

Methods inherited from interface ReplicableCommand

getCommandId, isReturnValueExpected, isSuccessful, logThrowable, readFrom, writeTo

Methods inherited from interface TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface VisitableCommand

init, loadType

Constructor Details

LockControlCommand

public LockControlCommand(Collection<?> keys,
 ByteString cacheName,
 long flags,
 GlobalTransaction globalTx)

LockControlCommand

public LockControlCommand(Object key,
 ByteString cacheName,
 long flags,
 GlobalTransaction globalTx)

Method Details

isUnlock

@ProtoField(5)
public boolean isUnlock()

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.

setGlobalTransaction

public void setGlobalTransaction(GlobalTransaction gtx)

getKeys

public Collection<Object> getKeys()

multipleKeys

public boolean multipleKeys()

getSingleKey

public Object getSingleKey()

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

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry registry)
                               throws Throwable

Description copied from interface: CacheRpcCommand

Invoke the command asynchronously.

Specified by:

invokeAsync in interface CacheRpcCommand

Specified by:

invokeAsync in interface VisitableCommand

Overrides:

invokeAsync in class AbstractTransactionBoundaryCommand

Throws:

Throwable

createContext

public RemoteTxInvocationContext createContext(ComponentRegistry componentRegistry)

Description copied from interface: TransactionalRemoteLockCommand

It creates the transaction context.

Specified by:

createContext in interface TransactionalRemoteLockCommand

Returns:

the TxInvocationContext.

setUnlock

public void setUnlock(boolean unlock)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractTransactionBoundaryCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTransactionBoundaryCommand

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 AbstractTransactionBoundaryCommand

setFlagsBitSet

public void setFlagsBitSet(long bitSet)

Description copied from interface: FlagAffectedCommand

Set the flags, replacing any existing flags.

Specified by:

setFlagsBitSet in interface FlagAffectedCommand

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