Class WhiteboardIndexEditorProvider
java.lang.Object
org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker<IndexEditorProvider>
org.apache.jackrabbit.oak.plugins.index.WhiteboardIndexEditorProvider
- All Implemented Interfaces:
AutoCloseable
,IndexEditorProvider
public class WhiteboardIndexEditorProvider
extends AbstractServiceTracker<IndexEditorProvider>
implements IndexEditorProvider
Dynamic
IndexEditorProvider
based on the available
whiteboard services.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetIndexEditor
(@NotNull String type, @NotNull NodeBuilder builder, @NotNull NodeState root, @NotNull IndexUpdateCallback callback) Each provider knows how to produce a certain type of index.Methods inherited from class org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker
getServices, start, stop
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.jackrabbit.oak.plugins.index.IndexEditorProvider
close
-
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 thetype
param is of an unknown value, the provider is expected to returnnull
.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 typeContextAwareCallback
and that can be used to accessIndexingContext
- Specified by:
getIndexEditor
in interfaceIndexEditorProvider
- Parameters:
type
- index typebuilder
- index definition node builder, used for updatesroot
- root node state, used for things like node type informationcallback
- used to register for index update notifications- Returns:
- index update editor, or
null
if type is unknown - Throws:
CommitFailedException
-