Class Lock

    • Constructor Summary

      Constructors 
      Constructor Description
      Lock()  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract void close()
      Releases exclusive access.
      abstract void ensureValid()
      Best effort check that this lock is still valid.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Lock

        public Lock()
    • Method Detail

      • close

        public abstract void close()
                            throws java.io.IOException
        Releases exclusive access.

        Note that exceptions thrown from close may require human intervention, as it may mean the lock was no longer valid, or that fs permissions prevent removal of the lock file, or other reasons.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        LockReleaseFailedException - optional specific exception) if the lock could not be properly released.
        java.io.IOException
      • ensureValid

        public abstract void ensureValid()
                                  throws java.io.IOException
        Best effort check that this lock is still valid. Locks could become invalidated externally for a number of reasons, for example if a user deletes the lock file manually or when a network filesystem is in use.
        Throws:
        java.io.IOException - if the lock is no longer valid.