Package org.infinispan.util.concurrent.locks

Interface RemoteLockCommand

All Superinterfaces:
ReplicableCommand, TracedCommand
All Known Subinterfaces:
TransactionalRemoteLockCommand
public interface RemoteLockCommand extends ReplicableCommand
Simple interface to extract all the keys that may need to be locked.

A CacheRpcCommand that needs to acquire locks should implement this interface. This way, Infinispan tries to provide a better management to optimize the system resources usage.

Since:
8.0
Author:
Pedro Ruivo

  • Method Details

    • getKeysToLock

      Collection<?> getKeysToLock()
      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 hasSkipLocking(). It may contains duplicated keys and null is not a valid return value.

      Returns:
      a Collection of keys to lock.

    • getKeyLockOwner

      Object getKeyLockOwner()
      It returns the lock owner of the key.

      Usually, in transaction caches it is the GlobalTransaction and in non-transactional caches the CommandInvocationId.

      Returns:
      the lock owner of the key.

    • hasZeroLockAcquisition

      boolean hasZeroLockAcquisition()
      Returns:
      it the locks should be acquire with 0 (zero) acquisition timeout.

    • hasSkipLocking

      boolean hasSkipLocking()
      It checks if this command should acquire locks.
      Returns:
      true if locks should be acquired for the keys in getKeysToLock().