org.apache.lucene.store

Class Lock

    • Constructor Detail

      • Lock

        public Lock()
    • Method Detail

      • close

        public abstract void close()
                            throws 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 Closeable
        Specified by:
        close in interface AutoCloseable
        Throws:
        LockReleaseFailedException - optional specific exception) if the lock could not be properly released.
        IOException
      • ensureValid

        public abstract void ensureValid()
                                  throws 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:
        IOException - if the lock is no longer valid.