org.apache.lucene.store
Class SimpleFSLockFactory

java.lang.Object
  org.apache.lucene.store.LockFactory
      org.apache.lucene.store.SimpleFSLockFactory

public class SimpleFSLockFactory
extends LockFactory

Implements LockFactory using File.createNewFile(). This is currently the default LockFactory used for FSDirectory if no LockFactory instance is otherwise provided. Note that there are known problems with this locking implementation on NFS.

See Also:

LockFactory

Field Summary

Fields inherited from class org.apache.lucene.store.LockFactory

lockPrefix

Constructor Summary

SimpleFSLockFactory(File lockDir)
Instantiate using the provided directory (as a File instance).

SimpleFSLockFactory(String lockDirName)
Instantiate using the provided directory name (String).

Method Summary

void	clearLock(String lockName) Attempt to clear (forcefully unlock and remove) the specified lock.
protected void	init(File lockDir)
Lock	makeLock(String lockName) Return a new Lock instance identified by lockName.

Methods inherited from class org.apache.lucene.store.LockFactory

getLockPrefix, setLockPrefix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleFSLockFactory

public SimpleFSLockFactory(File lockDir)
                    throws IOException

Instantiate using the provided directory (as a File instance).

Parameters:

lockDir - where lock files should be created.

Throws:

IOException

SimpleFSLockFactory

public SimpleFSLockFactory(String lockDirName)
                    throws IOException

Instantiate using the provided directory name (String).

Parameters:

lockDirName - where lock files should be created.

Throws:

IOException

Method Detail

init

protected void init(File lockDir)
             throws IOException

Throws:

IOException

makeLock

public Lock makeLock(String lockName)

Description copied from class: LockFactory

Return a new Lock instance identified by lockName.

Specified by:

makeLock in class LockFactory

Parameters:

lockName - name of the lock to be created.

clearLock

public void clearLock(String lockName)
               throws IOException

Description copied from class: LockFactory

Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.

Specified by:

clearLock in class LockFactory

Parameters:

lockName - name of the lock to be cleared.

Throws:

IOException