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

Class IndexRootDirectory

java.lang.Object

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

public class IndexRootDirectory
extends Object

Represents the root directory on file system used for storing index copy locally. For each Oak index in repository it creates a container directory which is a function of index path and a unique id which stored in index node in Oak. Under that container directory various sub directories can be created for storing different types of indexes

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_METADATA_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
IndexRootDirectory(File indexRootDir)
IndexRootDirectory(File indexRootDir, boolean gcOnStart)

Method Summary

Modifier and Type	Method and Description
long	gcEmptyDirs(File subDir) Performs garbage collection of older version of index directories based on index directory derived from the passed sub directory.
List<LocalIndexDir>	getAllLocalIndexes() Returns the most recent directory for each index.
File	getIndexDir(org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition, String indexPath, String dirName)
List<LocalIndexDir>	getLocalIndexes(String jcrPath)
long	getSize()

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_METADATA_FILE_NAME

public static final String INDEX_METADATA_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

IndexRootDirectory

public IndexRootDirectory(File indexRootDir)
                   throws IOException

Throws:

IOException

IndexRootDirectory

public IndexRootDirectory(File indexRootDir,
                          boolean gcOnStart)
                   throws IOException

Throws:

IOException

Method Detail

getSize

public long getSize()

getIndexDir

public File getIndexDir(org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition,
                        String indexPath,
                        String dirName)
                 throws IOException

Throws:

IOException

getAllLocalIndexes

public List<LocalIndexDir> getAllLocalIndexes()
                                       throws IOException

Returns the most recent directory for each index. If for an index 2 versions are present then it would return the most recent version

Throws:

IOException

getLocalIndexes

public List<LocalIndexDir> getLocalIndexes(String jcrPath)
                                    throws IOException

Throws:

IOException

gcEmptyDirs

public long gcEmptyDirs(File subDir)
                 throws IOException

Performs garbage collection of older version of index directories based on index directory derived from the passed sub directory.

Parameters:

subDir - one of the sub directories like 'default' etc. Such that correct local index directory (container dir) can be checked for deletion

Throws:

IOException