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

Class OakDirectory

java.lang.Object

org.apache.lucene.store.Directory

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class OakDirectory
extends org.apache.lucene.store.Directory

Implementation of the Lucene Directory (a flat list of files) based on an Oak NodeBuilder.

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
protected org.apache.jackrabbit.oak.spi.state.NodeBuilder	builder
protected String	dataNodeName
protected org.apache.jackrabbit.oak.spi.state.NodeBuilder	directoryBuilder
static String	PROP_DIR_LISTING
static String	PROP_UNSAFE_FOR_ACTIVE_DELETION

Constructor Summary

Constructors

Constructor and Description
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, LuceneIndexDefinition definition, boolean readOnly)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly, BlobFactory blobFactory)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly, BlobFactory blobFactory, ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly, BlobFactory blobFactory, ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback, boolean streamingWriteEnabled)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly, @Nullable org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore blobStore)
OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder, String dataNodeName, LuceneIndexDefinition definition, boolean readOnly, @Nullable org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore blobStore, ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback)

Method Summary

Modifier and Type	Method and Description
void	clearLock(String name)
void	close()
void	copy(OakDirectory dest, String name) Copies the file with the given name to the dest directory.
org.apache.lucene.store.IndexOutput	createOutput(String name, org.apache.lucene.store.IOContext context)
void	deleteFile(String name)
boolean	fileExists(String name)
long	fileLength(String name)
org.apache.lucene.store.LockFactory	getLockFactory()
boolean	isDirty()
String[]	listAll()
org.apache.lucene.store.Lock	makeLock(String name)
org.apache.lucene.store.IndexInput	openInput(String name, org.apache.lucene.store.IOContext context)
void	setLockFactory(org.apache.lucene.store.LockFactory lockFactory)
void	sync(Collection<String> names)
String	toString()

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

copy, createSlicer, ensureOpen, getLockID

Methods inherited from class java.lang.Object

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

Field Detail

PROP_DIR_LISTING

public static final String PROP_DIR_LISTING

See Also:

Constant Field Values

PROP_UNSAFE_FOR_ACTIVE_DELETION

public static final String PROP_UNSAFE_FOR_ACTIVE_DELETION

See Also:

Constant Field Values

builder

protected final org.apache.jackrabbit.oak.spi.state.NodeBuilder builder

dataNodeName

protected final String dataNodeName

directoryBuilder

protected final org.apache.jackrabbit.oak.spi.state.NodeBuilder directoryBuilder

Constructor Detail

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    LuceneIndexDefinition definition,
                    boolean readOnly)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly,
                    @Nullable
                    @Nullable org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore blobStore)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly,
                    @Nullable
                    @Nullable org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore blobStore,
                    @NotNull
                    ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly,
                    BlobFactory blobFactory)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly,
                    BlobFactory blobFactory,
                    @NotNull
                    ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback)

OakDirectory

public OakDirectory(org.apache.jackrabbit.oak.spi.state.NodeBuilder builder,
                    String dataNodeName,
                    LuceneIndexDefinition definition,
                    boolean readOnly,
                    BlobFactory blobFactory,
                    @NotNull
                    ActiveDeletedBlobCollectorFactory.BlobDeletionCallback blobDeletionCallback,
                    boolean streamingWriteEnabled)

Method Detail

listAll

public String[] listAll()
                 throws IOException

Specified by:

listAll in class org.apache.lucene.store.Directory

Throws:

IOException

fileExists

public boolean fileExists(String name)
                   throws IOException

Specified by:

fileExists in class org.apache.lucene.store.Directory

Throws:

IOException

deleteFile

public void deleteFile(String name)
                throws IOException

Specified by:

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

Throws:

IOException

fileLength

public long fileLength(String name)
                throws IOException

Specified by:

fileLength in class org.apache.lucene.store.Directory

Throws:

IOException

createOutput

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

Specified by:

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

Throws:

IOException

openInput

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

Specified by:

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

Throws:

IOException

makeLock

public org.apache.lucene.store.Lock makeLock(String name)

Specified by:

makeLock in class org.apache.lucene.store.Directory

clearLock

public void clearLock(String name)
               throws IOException

Specified by:

clearLock in class org.apache.lucene.store.Directory

Throws:

IOException

sync

public void sync(Collection<String> names)
          throws IOException

Specified by:

sync in class org.apache.lucene.store.Directory

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

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

Throws:

IOException

setLockFactory

public void setLockFactory(org.apache.lucene.store.LockFactory lockFactory)
                    throws IOException

Specified by:

setLockFactory in class org.apache.lucene.store.Directory

Throws:

IOException

getLockFactory

public org.apache.lucene.store.LockFactory getLockFactory()

Specified by:

getLockFactory in class org.apache.lucene.store.Directory

toString

public String toString()

Overrides:

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

copy

public void copy(OakDirectory dest,
                 String name)
          throws IOException

Copies the file with the given name to the dest directory. The file is copied 'by reference'. That is, the file in the destination directory will reference the same blob values as the source file.

This method is a no-op if the file does not exist in this directory.

Parameters:

dest - the destination directory.

name - the name of the file to copy.

Throws:

IOException - if an error occurs while copying the file.

IllegalArgumentException - if the destination directory does not use the same BlobFactory as this directory.

isDirty

public boolean isDirty()