org.apache.jackrabbit.oak.plugins.index

Interface IndexInfoProvider

All Known Implementing Classes:

LuceneIndexInfoProvider, PropertyIndexInfoProvider

@ConsumerType
public interface IndexInfoProvider

Service to be provided by various index implementations. This would then be used by IndexInfoService for collecting information related to index.

Method Summary

Modifier and Type	Method and Description
@Nullable IndexInfo	getInfo(java.lang.String indexPath)
java.lang.String	getType() Index type for this implementation can provide information
boolean	isValid(java.lang.String indexPath) Determined if the index is valid and usable.

Method Detail

getType

java.lang.String getType()

Index type for this implementation can provide information

getInfo

@Nullable
@Nullable IndexInfo getInfo(java.lang.String indexPath)
                               throws java.io.IOException

Throws:

java.io.IOException

isValid

boolean isValid(java.lang.String indexPath)
         throws java.io.IOException

Determined if the index is valid and usable. If the index is corrupt then it returns false

Throws:

java.io.IOException