Interface LockManager

All Known Implementing Classes:
DirectoryLockManager

public interface LockManager
Author:
james
  • Method Summary

    Modifier and Type
    Method
    Description
    Technical description of where the lock is located, such as a URL.
    boolean
    Determines if the SAIL is locked.
    Creates a lock in a SAIL if it does not yet exist.
    boolean
    Revokes a lock owned by another process.
    Creates a lock in a SAIL if it does not yet exist.
  • Method Details

    • getLocation

      String getLocation()
      Technical description of where the lock is located, such as a URL.
    • isLocked

      boolean isLocked()
      Determines if the SAIL is locked.
      Returns:
      true if the SAIL is already locked.
    • tryLock

      Lock tryLock()
      Creates a lock in a SAIL if it does not yet exist.
      Returns:
      a newly acquired lock or null if the SAIL is already locked.
    • lockOrFail

      Lock lockOrFail() throws SailLockedException
      Creates a lock in a SAIL if it does not yet exist.
      Returns:
      a newly acquired lock.
      Throws:
      SailLockedException - if the directory is already locked.
    • revokeLock

      boolean revokeLock()
      Revokes a lock owned by another process.
      Returns:
      true if a lock was successfully revoked.