org.apache.jackrabbit.oak.plugins.version

Class VersionHook

java.lang.Object

org.apache.jackrabbit.oak.plugins.version.VersionHook

All Implemented Interfaces:

CommitHook

public class VersionHook
extends java.lang.Object
implements CommitHook

This class gathers together editors related to handling version storage:

1. VersionEditorProvider
   • VersionEditor - creates version history, handles checking-in, checking-out and restoring, prevents a checked-in node from being modified,
   • VersionStorageEditor - validates changes on the version storage,
2. VersionableCollector - collects all existing versionable UUIDs, so assigned histories won't be removed in the next step,
3. OrphanedVersionCleaner - removes all histories that are empty and have no longer a parent versionable node.

Constructor Summary

Constructors

Constructor and Description
VersionHook()

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersionHook

public VersionHook()

Method Detail

processCommit

@NotNull
public @NotNull NodeState processCommit(NodeState before,
                                                 NodeState after,
                                                 CommitInfo info)
                                          throws 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:

CommitFailedException - if the commit should be rejected