org.apache.lucene.store

Class FSLockFactory

java.lang.Object

org.apache.lucene.store.LockFactory

org.apache.lucene.store.FSLockFactory

Direct Known Subclasses:

NativeFSLockFactory, SimpleFSLockFactory

public abstract class FSLockFactory
extends LockFactory

Base class for file system based locking implementation. This class is explicitly checking that the passed Directory is an FSDirectory.

Constructor Summary

Constructors

Constructor and Description
FSLockFactory()

Method Summary

Modifier and Type	Method and Description
static FSLockFactory	getDefault() Returns the default locking implementation for this platform.
protected abstract Lock	obtainFSLock(FSDirectory dir, java.lang.String lockName) Implement this method to obtain a lock for a FSDirectory instance.
Lock	obtainLock(Directory dir, java.lang.String lockName) Return a new obtained Lock instance identified by lockName.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSLockFactory

public FSLockFactory()

Method Detail

getDefault

public static final FSLockFactory getDefault()

Returns the default locking implementation for this platform. This method currently returns always NativeFSLockFactory.

obtainLock

public final Lock obtainLock(Directory dir,
                             java.lang.String lockName)
                      throws java.io.IOException

Description copied from class: LockFactory

Return a new obtained Lock instance identified by lockName.

Specified by:

obtainLock in class LockFactory

lockName - name of the lock to be created.

Throws:

LockObtainFailedException - (optional specific exception) if the lock could not be obtained because it is currently held elsewhere.

java.io.IOException - if any i/o error occurs attempting to gain the lock

obtainFSLock

protected abstract Lock obtainFSLock(FSDirectory dir,
                                     java.lang.String lockName)
                              throws java.io.IOException

Implement this method to obtain a lock for a FSDirectory instance.

Throws:

java.io.IOException - if the lock could not be obtained.