org.apache.jackrabbit.oak.spi.commit

Class EditorHook

java.lang.Object

org.apache.jackrabbit.oak.spi.commit.EditorHook

All Implemented Interfaces:

CommitHook

public class EditorHook
extends Object
implements CommitHook

This commit hook implementation processes changes to be committed using the Editor instance provided by the EditorProvider passed to the constructor.

Since:

Oak 0.7

See Also:

Commit editors

Constructor Summary

Constructors

Constructor and Description
EditorHook(@NotNull EditorProvider provider)

Method Summary

Modifier and Type	Method and Description
@NotNull NodeState	processCommit(@NotNull NodeState before, @NotNull NodeState after, @NotNull CommitInfo info) Validates and/or modifies the given content change before it gets persisted.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EditorHook

public EditorHook(@NotNull
                  @NotNull EditorProvider provider)

Method Detail

processCommit

@NotNull
public @NotNull NodeState processCommit(@NotNull
                                                 @NotNull NodeState before,
                                                 @NotNull
                                                 @NotNull NodeState after,
                                                 @NotNull
                                                 @NotNull CommitInfo info)
                                          throws org.apache.jackrabbit.oak.api.CommitFailedException

Description copied from interface: CommitHook

Validates and/or modifies the given content change before it gets persisted.

Specified by:

processCommit in interface CommitHook

Parameters:

before - content tree before the commit

after - content tree prepared for the commit

info - metadata associated with this commit

Returns:

content tree to be committed

Throws:

org.apache.jackrabbit.oak.api.CommitFailedException - if the commit should be rejected

toString

public String toString()

Overrides:

toString in class Object