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

Interface LuceneIndexMBean

  • All Superinterfaces:
    org.apache.jackrabbit.oak.plugins.index.search.IndexMBean
    All Known Implementing Classes:
    LuceneIndexMBeanImpl
    public interface LuceneIndexMBean
extends org.apache.jackrabbit.oak.plugins.index.search.IndexMBean

    • Method Detail

      • getBadIndexStats

        javax.management.openmbean.TabularData getBadIndexStats()

      • getBadPersistedIndexStats

        javax.management.openmbean.TabularData getBadPersistedIndexStats()

      • isFailing

        boolean isFailing()

      • getIndexedPaths

        @Description("Determines the set of index paths up to 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")
java.lang.String[] getIndexedPaths​(@Description("Index path for which stats are to be determined") @Name("indexPath")
                                   java.lang.String indexPath,
                                   @Name("maxLevel") @Description("Maximum depth to examine. E.g. 5. Stats calculation would break out after this limit")
                                   int maxLevel,
                                   @Description("Maximum number of unique paths to examine. E.g. 100. Stats calculation would break out after this limit") @Name("maxPathCount")
                                   int maxPathCount)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • getFieldInfo

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

      • getFieldTermsInfo

        @Description("Retrieves the terms, and number of documents for each term, for an index. This allows to closely investigate what is stored in the index.")
java.lang.String[] getFieldTermsInfo​(@Name("indexPath") @Description("The index path (empty for all indexes)")
                                     java.lang.String indexPath,
                                     @Name("field") @Description("The field name (empty for all fields)")
                                     java.lang.String field,
                                     @Name("max") @Description("The maximum number of entries to return (e.g. 100)")
                                     int max)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • getFieldTermsInfo

        @Description("Retrieves the terms, and number of documents for each term, for an index. This allows to closely investigate what is stored in the index.")
java.lang.String[] getFieldTermsInfo​(@Name("indexPath") @Description("The index path (empty for all indexes)")
                                     java.lang.String indexPath,
                                     @Name("field") @Description("The field name (empty for all fields)")
                                     java.lang.String field,
                                     @Name("fieldType") @Description("The type of the field (empty for string)")
                                     java.lang.String fieldType,
                                     @Name("max") @Description("The maximum number of entries to return (e.g. 100)")
                                     int max)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • getFieldTermInfo

        @Description("Retrieves the number of documents for a specific term, for an index. This allows to closely investigate what is stored in the index.")
java.lang.String[] getFieldTermInfo​(@Name("indexPath") @Description("The index path (empty for all indexes)")
                                    java.lang.String indexPath,
                                    @Name("field") @Description("The field name (empty for all fields)")
                                    java.lang.String field,
                                    @Name("term") @Description("The term")
                                    java.lang.String term)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • getStoredIndexDefinition

        @Description("Returns the stored index definition for index at given path in string form")
java.lang.String getStoredIndexDefinition​(@Name("indexPath")
                                          java.lang.String indexPath)

      • diffStoredIndexDefinition

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

      • checkConsistency

        @Description("Performs consistency check on given index")
java.lang.String checkConsistency​(@Name("indexPath")
                                  java.lang.String indexPath,
                                  @Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
                                  boolean fullCheck)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • checkAndReportConsistencyOfAllIndexes

        @Description("Performs consistency check for all Lucene indexes and reports in simple format")
java.lang.String[] checkAndReportConsistencyOfAllIndexes​(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
                                                         boolean fullCheck)
                                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • checkConsistencyOfAllIndexes

        @Description("Performs consistency check for all Lucene indexes and reports true if all indexes are found to be valid. False if any one of them was not found to be valid")
boolean checkConsistencyOfAllIndexes​(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
                                     boolean fullCheck)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • getHybridIndexInfo

        @Description("Fetches hybrid property index info as json for index at given path")
java.lang.String getHybridIndexInfo​(@Name("indexPath")
                                    java.lang.String indexPath)