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

Interface LuceneIndexMBean

All Known Implementing Classes:

LuceneIndexMBeanImpl

public interface LuceneIndexMBean

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Method Summary

Modifier and Type	Method and Description
String	diffStoredIndexDefinition(String indexPath)
TabularData	getBadIndexStats()
TabularData	getBadPersistedIndexStats()
String[]	getFieldInfo(String indexPath)
String[]	getIndexedPaths(String indexPath, int maxLevel, int maxPathCount)
TabularData	getIndexStats()
String	getStoredIndexDefinition(String indexPath)
boolean	isFailing()

Field Detail

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

getIndexStats

TabularData getIndexStats()
                   throws IOException

Throws:

IOException

getBadIndexStats

TabularData getBadIndexStats()

getBadPersistedIndexStats

TabularData getBadPersistedIndexStats()

isFailing

boolean isFailing()

getIndexedPaths

@Description(value="Determines the set of index paths upto given maxLevel. This can be used to determine the value for[includedPaths]. For this to work you should have [evaluatePathRestrictions] set to true in your index definition")
String[] getIndexedPaths(@Description(value="Index path for which stats are to be determined") @Name(value="indexPath")
                                                                                                                                                                                                                                                                   String indexPath,
                                                                                                                                                                                                                                                                   @Name(value="maxLevel") @Description(value="Maximum depth to examine. E.g. 5. Stats calculation would break out after this limit")
                                                                                                                                                                                                                                                                   int maxLevel,
                                                                                                                                                                                                                                                                   @Description(value="Maximum number of unique paths to examine. E.g. 100. Stats calculation would break out after this limit") @Name(value="maxPathCount")
                                                                                                                                                                                                                                                                   int maxPathCount)
                                                                                                                                                                                                                                                            throws IOException

Throws:

IOException

getFieldInfo

@Description(value="Retrieves the fields, and number of documents for each field, for an index. This allows to investigate what is stored in the index.")
String[] getFieldInfo(@Name(value="indexPath") @Description(value="The index path (empty for all indexes)")
                                                                                                                                                                                String indexPath)
                                                                                                                                                                         throws IOException

Throws:

IOException

getStoredIndexDefinition

@Description(value="Returns the stored index definition for index at given path in string form")
String getStoredIndexDefinition(@Name(value="indexPath")
                                                                                                                                 String indexPath)

diffStoredIndexDefinition

@Description(value="Returns the diff of index definition for index at given path from the stored index definition in string form")
String diffStoredIndexDefinition(@Name(value="indexPath")
                                                                                                                                                                    String indexPath)