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

Class WhiteboardIndexEditorProvider

java.lang.Object
org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker<IndexEditorProvider>
org.apache.jackrabbit.oak.plugins.index.WhiteboardIndexEditorProvider
All Implemented Interfaces:
IndexEditorProvider
public class WhiteboardIndexEditorProvider extends AbstractServiceTracker<IndexEditorProvider> implements IndexEditorProvider
Dynamic IndexEditorProvider based on the available whiteboard services.

  • Constructor Details

    • WhiteboardIndexEditorProvider

      public WhiteboardIndexEditorProvider()

  • Method Details

    • getIndexEditor

      public Editor getIndexEditor(@NotNull @NotNull String type, @NotNull @NotNull NodeBuilder builder, @NotNull @NotNull NodeState root, @NotNull @NotNull IndexUpdateCallback callback) throws CommitFailedException
      Description copied from interface: IndexEditorProvider
      Each provider knows how to produce a certain type of index. If the type param is of an unknown value, the provider is expected to return null.

      The definition builder must points to the index definition node under which the indexer is expected to store the index content.

      The callback instance may be of type ContextAwareCallback and that can be used to access IndexingContext

      Specified by:
      getIndexEditor in interface IndexEditorProvider
      Parameters:
      type - index type
      builder - index definition node builder, used for updates
      root - root node state, used for things like node type information
      callback - used to register for index update notifications
      Returns:
      index update editor, or null if type is unknown
      Throws:
      CommitFailedException