org.apache.jackrabbit.oak.plugins.index.lucene.directory

Class CopyOnReadDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.FilterDirectory

org.apache.jackrabbit.oak.plugins.index.lucene.directory.CopyOnReadDirectory

All Implemented Interfaces:

Closeable, AutoCloseable

public class CopyOnReadDirectory
extends org.apache.lucene.store.FilterDirectory

Directory implementation which lazily copies the index files from a remote directory in background.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.store.Directory

org.apache.lucene.store.Directory.IndexInputSlicer

Field Summary

Fields

Modifier and Type	Field and Description
long	DELETE_MARGIN_MILLIS
static String	DELETE_MARGIN_MILLIS_NAME

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

in

Constructor Summary

Constructors

Constructor and Description
CopyOnReadDirectory(IndexCopier indexCopier, org.apache.lucene.store.Directory remote, org.apache.lucene.store.Directory local, boolean prefetch, String indexPath, Executor executor)

Method Summary

Modifier and Type	Method and Description
void	close() On close file which are not present in remote are removed from local.
org.apache.lucene.store.IndexOutput	createOutput(String name, org.apache.lucene.store.IOContext context)
void	deleteFile(String name)
org.apache.lucene.store.Directory	getLocal()
org.apache.lucene.store.IndexInput	openInput(String name, org.apache.lucene.store.IOContext context)
String	toString()

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

clearLock, fileExists, fileLength, getDelegate, getLockFactory, getLockID, listAll, makeLock, setLockFactory, sync

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

copy, createSlicer, ensureOpen

Methods inherited from class java.lang.Object

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

Field Detail

DELETE_MARGIN_MILLIS_NAME

public static final String DELETE_MARGIN_MILLIS_NAME

See Also:

Constant Field Values

DELETE_MARGIN_MILLIS

public final long DELETE_MARGIN_MILLIS

Constructor Detail

CopyOnReadDirectory

public CopyOnReadDirectory(IndexCopier indexCopier,
                           org.apache.lucene.store.Directory remote,
                           org.apache.lucene.store.Directory local,
                           boolean prefetch,
                           String indexPath,
                           Executor executor)
                    throws IOException

Throws:

IOException

Method Detail

deleteFile

public void deleteFile(String name)
                throws IOException

Overrides:

deleteFile in class org.apache.lucene.store.FilterDirectory

Throws:

IOException

createOutput

public org.apache.lucene.store.IndexOutput createOutput(String name,
                                                        org.apache.lucene.store.IOContext context)
                                                 throws IOException

Overrides:

createOutput in class org.apache.lucene.store.FilterDirectory

Throws:

IOException

openInput

public org.apache.lucene.store.IndexInput openInput(String name,
                                                    org.apache.lucene.store.IOContext context)
                                             throws IOException

Overrides:

openInput in class org.apache.lucene.store.FilterDirectory

Throws:

IOException

getLocal

public org.apache.lucene.store.Directory getLocal()

close

public void close()
           throws IOException

On close file which are not present in remote are removed from local. CopyOnReadDir is opened at different revisions of the index state CDir1 - V1 CDir2 - V2 Its possible that two different IndexSearcher are opened at same local directory but pinned to different revisions. So while removing it must be ensured that any currently opened IndexSearcher does not get affected. The way IndexSearchers get created in IndexTracker it ensures that new searcher pinned to newer revision gets opened first and then existing ones are closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.lucene.store.FilterDirectory

Throws:

IOException

toString

public String toString()

Overrides:

toString in class org.apache.lucene.store.FilterDirectory