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

Interface IndexInfoService

All Known Implementing Classes:
IndexInfoServiceImpl
@ProviderType public interface IndexInfoService

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<IndexInfo>
    getAllIndexInfo()
    Returns IndexInfo for all the indexes present in the repository
    @Nullable IndexInfo
    getInfo(String indexPath)
    Returns IndexInfo for index at given path
    boolean
    isValid(String indexPath)
    Determined if the index is valid and usable.

  • Method Details

    • getAllIndexInfo

      Iterable<IndexInfo> getAllIndexInfo()
      Returns IndexInfo for all the indexes present in the repository

    • getInfo

      @Nullable @Nullable IndexInfo getInfo(String indexPath) throws IOException
      Returns IndexInfo for index at given path
      Parameters:
      indexPath - path repository
      Returns:
      indexInfo for the index or null if there is no index node found at given path
      Throws:
      IOException

    • isValid

      boolean isValid(String indexPath) throws IOException
      Determined if the index is valid and usable. If the index is corrupt then it returns false
      Throws:
      IOException