Package org.apache.jackrabbit.oak.segment

Class LoggingHook

java.lang.Object

org.apache.jackrabbit.oak.segment.LoggingHook

All Implemented Interfaces:

CommitHook, NodeStateDiff

public class LoggingHook
extends Object
implements CommitHook, NodeStateDiff

Method Summary

Modifier and Type	Method	Description
boolean	childNodeAdded(String name, NodeState after)	Called for all added child nodes.
boolean	childNodeChanged(String name, NodeState before, NodeState after)	Called for all child nodes that may contain changes between the before and after states.
boolean	childNodeDeleted(String name, NodeState before)	Called for all deleted child nodes.
void	enter(NodeState before, NodeState after)
void	leave(NodeState before, NodeState after)
@NotNull NodeState	processCommit(NodeState before, NodeState after, CommitInfo info)	Validates and/or modifies the given content change before it gets persisted.
boolean	propertyAdded(PropertyState after)	Called for all added properties.
boolean	propertyChanged(PropertyState before, PropertyState after)	Called for all changed properties.
boolean	propertyDeleted(PropertyState before)	Called for all deleted properties.

Methods inherited from class java.lang.Object

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

Method Detail

enter

public void enter(NodeState before,
                  NodeState after)

leave

public void leave(NodeState before,
                  NodeState after)

propertyAdded

public boolean propertyAdded(PropertyState after)

Description copied from interface: NodeStateDiff

Called for all added properties.

Specified by:

propertyAdded in interface NodeStateDiff

Parameters:

after - property state after the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

propertyChanged

public boolean propertyChanged(PropertyState before,
                               PropertyState after)

Description copied from interface: NodeStateDiff

Called for all changed properties. The names of the given two property states are guaranteed to be the same.

Specified by:

propertyChanged in interface NodeStateDiff

Parameters:

before - property state before the change

after - property state after the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

propertyDeleted

public boolean propertyDeleted(PropertyState before)

Description copied from interface: NodeStateDiff

Called for all deleted properties.

Specified by:

propertyDeleted in interface NodeStateDiff

Parameters:

before - property state before the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

childNodeAdded

public boolean childNodeAdded(String name,
                              NodeState after)

Description copied from interface: NodeStateDiff

Called for all added child nodes.

Specified by:

childNodeAdded in interface NodeStateDiff

Parameters:

name - name of the added child node

after - child node state after the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

childNodeChanged

public boolean childNodeChanged(String name,
                                NodeState before,
                                NodeState after)

Description copied from interface: NodeStateDiff

Called for all child nodes that may contain changes between the before and after states. The comparison implementation is expected to make an effort to avoid calling this method on child nodes under which nothing has changed.

Specified by:

childNodeChanged in interface NodeStateDiff

Parameters:

name - name of the changed child node

before - child node state before the change

after - child node state after the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

childNodeDeleted

public boolean childNodeDeleted(String name,
                                NodeState before)

Description copied from interface: NodeStateDiff

Called for all deleted child nodes.

Specified by:

childNodeDeleted in interface NodeStateDiff

Parameters:

name - name of the deleted child node

before - child node state before the change

Returns:

true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

processCommit

@NotNull
public @NotNull NodeState processCommit(NodeState before,
                                        NodeState after,
                                        CommitInfo info)

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