org.infinispan.commands.control

Class LockControlCommand

java.lang.Object

org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

org.infinispan.commands.control.LockControlCommand

All Implemented Interfaces:

FlagAffectedCommand, LocalFlagAffectedCommand, MetadataAwareCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TransactionBoundaryCommand, VisitableCommand, RemoteLockCommand, TransactionalRemoteLockCommand

public class LockControlCommand
extends AbstractTransactionBoundaryCommand
implements FlagAffectedCommand, 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID

Fields inherited from class org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

cacheName, globalTx, icf, invoker, txTable

Constructor Summary

Constructors

Constructor and Description
LockControlCommand(Collection<?> keys, String cacheName, Set<Flag> flags, GlobalTransaction gtx)
LockControlCommand(Object key, String cacheName, Set<Flag> flags, GlobalTransaction gtx)
LockControlCommand(String cacheName)

Method Summary

Modifier and Type	Method and Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
RemoteTxInvocationContext	createContext() It creates the transaction context.
boolean	equals(Object o)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Set<Flag>	getFlags()
Object	getKeyLockOwner() It returns the lock owner of the key.
Collection<Object>	getKeys()
Collection<Object>	getKeysToLock() It returns a Collection with the keys to be lock.
Metadata	getMetadata() Get metadata of this command.
Object	getSingleKey()
int	hashCode()
boolean	hasSkipLocking() It checks if this command should acquire locks.
boolean	hasZeroLockAcquisition()
boolean	isUnlock()
boolean	multipleKeys()
Object	perform(InvocationContext ignored) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	replaceKey(Object oldKey, Object replacement)
void	replaceKeys(Map<Object,Object> replacements)
void	setFlags(Set<Flag> flags) Set the flags, replacing any existing flags.
void	setGlobalTransaction(GlobalTransaction gtx)
void	setMetadata(Metadata metadata) Sets metadata for this command.
void	setUnlock(boolean unlock)
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.tx.AbstractTransactionBoundaryCommand

canBlock, getCacheName, getGlobalTransaction, getOrigin, getRemoteTransaction, getTopologyId, ignoreCommandOnStatus, init, invalidRemoteTxReturnValue, isReturnValueExpected, markTransactionAsRemote, readsExistingValues, setOrigin, setTopologyId, shouldInvoke, visitRemoteTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.VisitableCommand

alwaysReadsExistingValues, ignoreCommandOnStatus, readsExistingValues, shouldInvoke

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, getParameters, isReturnValueExpected, setParameters

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, hasFlag, setFlags

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

LockControlCommand

public LockControlCommand(String cacheName)

LockControlCommand

public LockControlCommand(Collection<?> keys,
                          String cacheName,
                          Set<Flag> flags,
                          GlobalTransaction gtx)

LockControlCommand

public LockControlCommand(Object key,
                          String cacheName,
                          Set<Flag> flags,
                          GlobalTransaction gtx)

Method Detail

setGlobalTransaction

public void setGlobalTransaction(GlobalTransaction gtx)

getKeys

public Collection<Object> getKeys()

replaceKey

public void replaceKey(Object oldKey,
                       Object replacement)

replaceKeys

public void replaceKeys(Map<Object,Object> replacements)

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

perform

public Object perform(InvocationContext ignored)
               throws Throwable

Description copied from interface: ReplicableCommand

Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Specified by:

perform in interface ReplicableCommand

Overrides:

perform in class AbstractTransactionBoundaryCommand

Parameters:

ignored - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

createContext

public RemoteTxInvocationContext createContext()

Description copied from interface: TransactionalRemoteLockCommand

It creates the transaction context.

Specified by:

createContext in interface TransactionalRemoteLockCommand

Returns:

the TxInvocationContext.

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Specified by:

getCommandId in interface ReplicableCommand

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

Specified by:

writeTo in interface ReplicableCommand

Overrides:

writeTo in class AbstractTransactionBoundaryCommand

Parameters:

output - the stream.

Throws:

IOException - if an error occurred during the I/O.

readFrom

public void readFrom(ObjectInput input)
              throws IOException,
                     ClassNotFoundException

Description copied from interface: ReplicableCommand

Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).

Specified by:

readFrom in interface ReplicableCommand

Overrides:

readFrom in class AbstractTransactionBoundaryCommand

Parameters:

input - the stream to read.

Throws:

IOException - if an error occurred during the I/O.

ClassNotFoundException - if it tries to load an undefined class.

isUnlock

public boolean isUnlock()

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

toString

public String toString()

Overrides:

toString in class AbstractTransactionBoundaryCommand

getFlags

public Set<Flag> getFlags()

Specified by:

getFlags in interface LocalFlagAffectedCommand

Returns:

The command flags - only valid to invoke after LocalFlagAffectedCommand.setFlags(java.util.Set). The set should not be modified directly, only via the LocalFlagAffectedCommand.setFlags(Set), LocalFlagAffectedCommand.addFlag(Flag) and LocalFlagAffectedCommand.addFlags(Set) methods.

setFlags

public void setFlags(Set<Flag> flags)

Description copied from interface: LocalFlagAffectedCommand

Set the flags, replacing any existing flags.

Specified by:

setFlags in interface LocalFlagAffectedCommand

Parameters:

flags - The new flags.

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

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