Interface LockRepository

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
DefaultLockRepository
public interface LockRepository extends Closeable
Encapsulation of the SQL shunting that is needed for locks. A JdbcLockRegistry needs a reference to a spring-managed (transactional) client service, so this component has to be declared as a bean.
Since:
4.3
Author:
Dave Syer, Alexandre Strubel, Artem Bilan, Eddie Cho

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acquire(String lock)
    Deprecated.
    since 7.0, we allow custom time-to-live value
    boolean
    acquire(String lock, Duration ttl)
    Acquire a lock for a key with specific time-to-live value
    void
    close()
     
    boolean
    delete(String lock)
    Remove a lock from this repository.
    void
    deleteExpired()
    Remove all the expired locks.
    boolean
    isAcquired(String lock)
    Check if a lock is held by this repository.
    boolean
    renew(String lock)
    Deprecated.
    since 7.0, we allow custom time-to-live value
    boolean
    renew(String lock, Duration ttl)
    Renew the lease for a lock with specific time-to-live value

  • Method Details

    • isAcquired

      boolean isAcquired(String lock)
      Check if a lock is held by this repository.
      Parameters:
      lock - the lock to check.
      Returns:
      acquired or not.

    • delete

      boolean delete(String lock)
      Remove a lock from this repository.
      Parameters:
      lock - the lock to remove.
      Returns:
      deleted or not.

    • deleteExpired

      void deleteExpired()
      Remove all the expired locks.

    • acquire

      @Deprecated(since="7.0") boolean acquire(String lock)
      Deprecated.
      since 7.0, we allow custom time-to-live value
      Acquire a lock for a key.
      Parameters:
      lock - the key for lock to acquire.
      Returns:
      acquired or not.

    • acquire

      boolean acquire(String lock, Duration ttl)
      Acquire a lock for a key with specific time-to-live value
      Parameters:
      lock - the key for lock to acquire.
      ttl - the custom time-to-live value
      Returns:
      acquired or not.

    • renew

      @Deprecated(since="7.0") boolean renew(String lock)
      Deprecated.
      since 7.0, we allow custom time-to-live value
      Renew the lease for a lock.
      Parameters:
      lock - the lock to renew.
      Returns:
      renewed or not.

    • renew

      boolean renew(String lock, Duration ttl)
      Renew the lease for a lock with specific time-to-live value
      Parameters:
      lock - the key for lock to acquire.
      ttl - the custom time-to-live value
      Returns:
      renewed or not.

    • close

      void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable