org.apache.solr.core

Class CachingDirectoryFactory

java.lang.Object

org.apache.solr.core.DirectoryFactory

org.apache.solr.core.CachingDirectoryFactory

All Implemented Interfaces:

Closeable, NamedListInitializedPlugin

Direct Known Subclasses:

MMapDirectoryFactory, NIOFSDirectoryFactory, SimpleFSDirectoryFactory, StandardDirectoryFactory

public abstract class CachingDirectoryFactory
extends DirectoryFactory

A DirectoryFactory impl base class for caching Directory instances per path. Most DirectoryFactory implementations will want to extend this class and simply implement DirectoryFactory.create(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CachingDirectoryFactory.CloseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Directory,org.apache.solr.core.CachingDirectoryFactory.CacheValue>	byDirectoryCache
protected Map<String,org.apache.solr.core.CachingDirectoryFactory.CacheValue>	byPathCache
protected Map<Directory,List<CachingDirectoryFactory.CloseListener>>	closeListeners

Constructor Summary

Constructors

Constructor and Description
CachingDirectoryFactory()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCloseListener(Directory dir, CachingDirectoryFactory.CloseListener closeListener) Adds a close listener for a Directory.
void	close() Close the this and all of the Directories it contains.
protected abstract Directory	create(String path) Creates a new Directory for a given path.
void	doneWithDirectory(Directory directory) Indicates a Directory will no longer be used, and when it's ref count hits 0, it can be closed.
boolean	exists(String path) Returns true if a Directory exists for a given path.
Directory	get(String path, String rawLockType) Returns the Directory for a given path, using the specified rawLockType.
Directory	get(String path, String rawLockType, boolean forceNew) Returns the Directory for a given path, using the specified rawLockType.
void	incRef(Directory directory) Increment the number of references to the given Directory.
void	init(NamedList args)
void	release(Directory directory) Releases the Directory so that it may be closed when it is no longer referenced.

Methods inherited from class java.lang.Object

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

Field Detail

byPathCache

protected Map<String,org.apache.solr.core.CachingDirectoryFactory.CacheValue> byPathCache

byDirectoryCache

protected Map<Directory,org.apache.solr.core.CachingDirectoryFactory.CacheValue> byDirectoryCache

closeListeners

protected Map<Directory,List<CachingDirectoryFactory.CloseListener>> closeListeners

Constructor Detail

CachingDirectoryFactory

public CachingDirectoryFactory()

Method Detail

addCloseListener

public void addCloseListener(Directory dir,
                    CachingDirectoryFactory.CloseListener closeListener)

Description copied from class: DirectoryFactory

Adds a close listener for a Directory.

Specified by:

addCloseListener in class DirectoryFactory

doneWithDirectory

public void doneWithDirectory(Directory directory)
                       throws IOException

Description copied from class: DirectoryFactory

Indicates a Directory will no longer be used, and when it's ref count hits 0, it can be closed. On shutdown all directories will be closed with this has been called or not. This is simply to allow early cleanup.

Specified by:

doneWithDirectory in class DirectoryFactory

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: DirectoryFactory

Close the this and all of the Directories it contains.

Specified by:

close in interface Closeable

Specified by:

close in class DirectoryFactory

Throws:

IOException

create

protected abstract Directory create(String path)
                             throws IOException

Description copied from class: DirectoryFactory

Creates a new Directory for a given path.

Specified by:

create in class DirectoryFactory

Throws:

IOException

exists

public boolean exists(String path)

Description copied from class: DirectoryFactory

Returns true if a Directory exists for a given path.

Specified by:

exists in class DirectoryFactory

get

public final Directory get(String path,
            String rawLockType)
                    throws IOException

Description copied from class: DirectoryFactory

Returns the Directory for a given path, using the specified rawLockType. Will return the same Directory instance for the same path.

Specified by:

get in class DirectoryFactory

Throws:

IOException

get

public final Directory get(String path,
            String rawLockType,
            boolean forceNew)
                    throws IOException

Description copied from class: DirectoryFactory

Returns the Directory for a given path, using the specified rawLockType. Will return the same Directory instance for the same path unless forceNew, in which case a new Directory is returned. There is no need to call DirectoryFactory.doneWithDirectory(Directory) in this case - the old Directory will be closed when it's ref count hits 0.

Specified by:

get in class DirectoryFactory

Throws:

IOException

incRef

public void incRef(Directory directory)

Description copied from class: DirectoryFactory

Increment the number of references to the given Directory. You must call release for every call to this method.

Specified by:

incRef in class DirectoryFactory

init

public void init(NamedList args)

release

public void release(Directory directory)
             throws IOException

Description copied from class: DirectoryFactory

Releases the Directory so that it may be closed when it is no longer referenced.

Specified by:

release in class DirectoryFactory

Throws:

IOException