Class WhiteboardEditorProvider

java.lang.Object
org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker<EditorProvider>
org.apache.jackrabbit.oak.spi.commit.WhiteboardEditorProvider
All Implemented Interfaces:
EditorProvider

public class WhiteboardEditorProvider extends AbstractServiceTracker<EditorProvider> implements EditorProvider
Dynamic EditorProvider based on the available whiteboard services.
  • Constructor Details

    • WhiteboardEditorProvider

      public WhiteboardEditorProvider()
  • Method Details

    • getRootEditor

      @Nullable public @Nullable Editor getRootEditor(NodeState before, NodeState after, NodeBuilder builder, CommitInfo info) throws CommitFailedException
      Description copied from interface: EditorProvider
      Returns an editor for processing changes between the given two states. Returns null if the changes don't require processing.

      An implementation of this method should generally not compare the given before and after states, as the caller is expected to compare the states and invoke the respective callback methods on the Editor instance returned by this method. Instead the implementation can use the opportunity for other preparatory work.

      Specified by:
      getRootEditor in interface EditorProvider
      Parameters:
      before - original root state
      after - modified root state
      builder - node builder based on the after state
      info - metadata associated with this commit
      Returns:
      editor for processing the changes, or null
      Throws:
      CommitFailedException - if processing failed