Package org.apache.solr.core

Class CachingDirectoryFactory

java.lang.Object

org.apache.solr.core.DirectoryFactory

org.apache.solr.core.CachingDirectoryFactory

All Implemented Interfaces:

Closeable, AutoCloseable, NamedListInitializedPlugin

Direct Known Subclasses:

EphemeralDirectoryFactory, 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, LockFactory).

This is an expert class and these API's are subject to change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CachingDirectoryFactory.CacheValue
static interface	CachingDirectoryFactory.CloseListener
static class	CachingDirectoryFactory.ReleasableDirectory	Delegates to a filtered or unwrapped directory, and allows this caching factory to release correctly the corresponding cached directory.

Nested classes/interfaces inherited from class org.apache.solr.core.DirectoryFactory

DirectoryFactory.DirContext

Field Summary

Fields

Modifier and Type	Field	Description
protected IdentityHashMap<org.apache.lucene.store.Directory,CachingDirectoryFactory.CacheValue>	byDirectoryCache
protected Map<String,CachingDirectoryFactory.CacheValue>	byPathCache
protected Map<org.apache.lucene.store.Directory,List<CachingDirectoryFactory.CloseListener>>	closeListeners
protected Set<CachingDirectoryFactory.CacheValue>	removeEntries

Fields inherited from class org.apache.solr.core.DirectoryFactory

coreContainer, dataHomePath, INDEX_W_TIMESTAMP_REGEX, IOCONTEXT_NO_CACHE, LOCK_TYPE_NATIVE, LOCK_TYPE_NONE, LOCK_TYPE_SIMPLE, LOCK_TYPE_SINGLE

Constructor Summary

Constructors

Constructor	Description
CachingDirectoryFactory()

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(org.apache.lucene.store.Directory dir, CachingDirectoryFactory.CloseListener closeListener)	Adds a close listener for a Directory.
void	close()	Close this factory and all the Directories it contains.
protected boolean	deleteOldIndexDirectory(String oldDirPath)
void	doneWithDirectory(org.apache.lucene.store.Directory directory)	Indicates a Directory will no longer be used, and when its ref count hits 0, it can be closed.
boolean	exists(String path)	Returns true if a Directory exists for a given path in the underlying (stable) storage and contains at least one file.
protected org.apache.lucene.store.Directory	filterDirectory(org.apache.lucene.store.Directory dir, DirectoryFactory.DirContext dirContext)	Potentially filters or unwraps the cached Directory depending on the intended use defined by the DirectoryFactory.DirContext.
final org.apache.lucene.store.Directory	get(String path, DirectoryFactory.DirContext dirContext, String rawLockType)	Returns the Directory for a given path, using the specified rawLockType.
Set<String>	getLivePaths()	Method for inspecting the cache
protected String	getPath(org.apache.lucene.store.Directory directory)
void	incRef(org.apache.lucene.store.Directory directory)	Increment the number of references to the given Directory.
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.
String	normalize(String path)	Normalize a given path.
void	release(org.apache.lucene.store.Directory directory)	Releases the Directory so that it may be closed when it is no longer referenced.
void	remove(String path)	This remove is special in that it may be called even after the factory has been closed.
void	remove(String path, boolean deleteAfterCoreClose)	This remove is special in that it may be called even after the factory has been closed.
void	remove(org.apache.lucene.store.Directory dir)	Removes the Directory's persistent storage.
void	remove(org.apache.lucene.store.Directory dir, boolean deleteAfterCoreClose)	Removes the Directory's persistent storage.
protected void	removeDirectory(CachingDirectoryFactory.CacheValue cacheValue)
protected String	stripTrailingSlash(String path)

Methods inherited from class org.apache.solr.core.DirectoryFactory

cleanupOldIndexDirectories, create, createLockFactory, empty, getBaseDir, getDataHome, initCoreContainer, isAbsolute, isPersistent, isSharedStorage, move, newDefaultUpdateLog, renameWithOverwrite, searchersReserveCommitPoints, size, size, sizeOf, sizeOfDirectory

Methods inherited from class java.lang.Object

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

Field Details

byPathCache

protected Map<String,CachingDirectoryFactory.CacheValue> byPathCache

byDirectoryCache

protected IdentityHashMap<org.apache.lucene.store.Directory,CachingDirectoryFactory.CacheValue> byDirectoryCache

closeListeners

protected Map<org.apache.lucene.store.Directory,List<CachingDirectoryFactory.CloseListener>> closeListeners

removeEntries

protected Set<CachingDirectoryFactory.CacheValue> removeEntries

Constructor Details

CachingDirectoryFactory

public CachingDirectoryFactory()

Method Details

addCloseListener

public void addCloseListener(org.apache.lucene.store.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(org.apache.lucene.store.Directory directory)
                       throws IOException

Description copied from class: DirectoryFactory

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

Specified by:

doneWithDirectory in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

close

public void close()
           throws IOException

Description copied from class: DirectoryFactory

Close this factory and all the Directories it contains.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

exists

public boolean exists(String path)
               throws IOException

Description copied from class: DirectoryFactory

Returns true if a Directory exists for a given path in the underlying (stable) storage and contains at least one file. Note that the existence of a Directory Object as returned by a previous call to the DirectoryFactory.get(java.lang.String, org.apache.solr.core.DirectoryFactory.DirContext, java.lang.String) method (on the specified path) is not enough to cause this method to return true. Some prior user of that Directory must have written & synced at least one file to that Directory (and at least one file must still exist)

Specified by:

exists in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

get

public final org.apache.lucene.store.Directory get(String path,
 DirectoryFactory.DirContext dirContext,
 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 - If there is a low-level I/O error.

filterDirectory

protected org.apache.lucene.store.Directory filterDirectory(org.apache.lucene.store.Directory dir,
 DirectoryFactory.DirContext dirContext)

Potentially filters or unwraps the cached Directory depending on the intended use defined by the DirectoryFactory.DirContext.

Parameters:

dir - the Directory cached by this CachingDirectoryFactory.

dirContext - the nature or the intended use of the directory.

Returns:

a filtered or unwrapped version of the directory parameter, or directly the directory parameter if it does not need any filtering/unwrapping.

incRef

public void incRef(org.apache.lucene.store.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(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Parameters:

args - non-null list of initialization parameters (may be empty)

release

public void release(org.apache.lucene.store.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 - If there is a low-level I/O error.

remove

public void remove(String path)
            throws IOException

Description copied from class: DirectoryFactory

This remove is special in that it may be called even after the factory has been closed. Remove only makes sense for persistent directory factories.

Specified by:

remove in class DirectoryFactory

Parameters:

path - to remove

Throws:

IOException - If there is a low-level I/O error.

remove

public void remove(org.apache.lucene.store.Directory dir)
            throws IOException

Description copied from class: DirectoryFactory

Removes the Directory's persistent storage. For example: A file system impl may remove the on disk directory.

Specified by:

remove in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

remove

public void remove(String path,
 boolean deleteAfterCoreClose)
            throws IOException

Description copied from class: DirectoryFactory

This remove is special in that it may be called even after the factory has been closed. Remove only makes sense for persistent directory factories.

Specified by:

remove in class DirectoryFactory

Parameters:

path - to remove

deleteAfterCoreClose - whether to wait until after the core is closed.

Throws:

IOException - If there is a low-level I/O error.

remove

public void remove(org.apache.lucene.store.Directory dir,
 boolean deleteAfterCoreClose)
            throws IOException

Description copied from class: DirectoryFactory

Removes the Directory's persistent storage. For example: A file system impl may remove the on disk directory.

Specified by:

remove in class DirectoryFactory

Throws:

IOException - If there is a low-level I/O error.

removeDirectory

protected void removeDirectory(CachingDirectoryFactory.CacheValue cacheValue)
                        throws IOException

Throws:

IOException

normalize

public String normalize(String path)
                 throws IOException

Description copied from class: DirectoryFactory

Normalize a given path.

Overrides:

normalize in class DirectoryFactory

Parameters:

path - to normalize

Returns:

normalized path

Throws:

IOException - on io error

stripTrailingSlash

protected String stripTrailingSlash(String path)

getLivePaths

public Set<String> getLivePaths()

Method for inspecting the cache

Returns:

paths in the cache which have not been marked "done"

See Also:

• doneWithDirectory(org.apache.lucene.store.Directory)

deleteOldIndexDirectory

protected boolean deleteOldIndexDirectory(String oldDirPath)
                                   throws IOException

Overrides:

deleteOldIndexDirectory in class DirectoryFactory

Throws:

IOException

getPath

protected String getPath(org.apache.lucene.store.Directory directory)