public class SimpleFSLockFactory extends FSLockFactory
Implements LockFactory using File.createNewFile().
NOTE: the javadocs
for File.createNewFile contain a vague
yet spooky warning about not using the API for file
locking. This warning was added due to this
bug, and in fact the only known problem with using
this API for locking is that the Lucene write lock may
not be released when the JVM exits abnormally.
When this happens, a LockObtainFailedException
is hit when trying to create a writer, in which case you
need to explicitly clear the lock file first. You can
either manually remove the file, or use the IndexWriter.unlock(Directory)
API. But, first be certain that no writer is in fact
writing to the index otherwise you can easily corrupt
your index.
If you suspect that this or any other LockFactory is
not working properly in your environment, you can easily
test it by using VerifyingLockFactory, LockVerifyServer and LockStressTest.
LockFactorylockDirlockPrefix| Constructor and Description |
|---|
SimpleFSLockFactory()
Create a SimpleFSLockFactory instance, with null (unset)
lock directory.
|
SimpleFSLockFactory(File lockDir)
Instantiate using the provided directory (as a File instance).
|
SimpleFSLockFactory(String lockDirName)
Instantiate using the provided directory name (String).
|
| Modifier and Type | Method and Description |
|---|---|
void |
clearLock(String lockName)
Attempt to clear (forcefully unlock and remove) the
specified lock.
|
Lock |
makeLock(String lockName)
Return a new Lock instance identified by lockName.
|
getLockDir, setLockDirgetLockPrefix, setLockPrefixpublic SimpleFSLockFactory()
throws IOException
FSDirectory
subclass, the lock directory is automatically set to the
directory itself. Be sure to create one instance for each directory
your create!IOExceptionpublic SimpleFSLockFactory(File lockDir) throws IOException
lockDir - where lock files should be created.IOExceptionpublic SimpleFSLockFactory(String lockDirName) throws IOException
lockDirName - where lock files should be created.IOExceptionpublic Lock makeLock(String lockName)
LockFactorymakeLock in class LockFactorylockName - name of the lock to be created.public void clearLock(String lockName) throws IOException
LockFactoryclearLock in class LockFactorylockName - name of the lock to be cleared.IOException