Package org.apache.jackrabbit.oak.plugins.observation

Class ChangeCollectorProvider

java.lang.Object

org.apache.jackrabbit.oak.spi.commit.ValidatorProvider

org.apache.jackrabbit.oak.plugins.observation.ChangeCollectorProvider

All Implemented Interfaces:

EditorProvider

public class ChangeCollectorProvider
extends ValidatorProvider

A ChangeCollectorProvider can be hooked into Oak thus enabling the collection of ChangeSets of changed items of a commit, which downstream Observers can then use at their convenience.

See Also:

for details on what is tracked and how that data should be interpreted

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMMIT_CONTEXT_OBSERVATION_CHANGESET
static String	TYPE

Constructor Summary

Constructors

Constructor	Description
ChangeCollectorProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.apache.jackrabbit.oak.plugins.observation.ChangeCollectorProvider.Configuration config)
protected int	getMaxItems()	FOR TESTING-ONLY
protected int	getMaxPathDepth()	FOR TESTING-ONLY
protected Validator	getRootValidator(NodeState before, NodeState after, CommitInfo info)	Returns a validator for checking the changes between the given two root states.
protected void	modified(org.apache.jackrabbit.oak.plugins.observation.ChangeCollectorProvider.Configuration config)
protected void	setMaxItems(int maxItems)	FOR TESTING-ONLY
protected void	setMaxPathDepth(int maxPathDepth)	FOR TESTING-ONLY

Methods inherited from class org.apache.jackrabbit.oak.spi.commit.ValidatorProvider

getRootEditor

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

COMMIT_CONTEXT_OBSERVATION_CHANGESET

public static final String COMMIT_CONTEXT_OBSERVATION_CHANGESET

See Also:

Constant Field Values

Constructor Detail

ChangeCollectorProvider

public ChangeCollectorProvider()

Method Detail

activate

protected void activate(org.apache.jackrabbit.oak.plugins.observation.ChangeCollectorProvider.Configuration config)

modified

protected void modified(org.apache.jackrabbit.oak.plugins.observation.ChangeCollectorProvider.Configuration config)

setMaxPathDepth

protected void setMaxPathDepth(int maxPathDepth)

FOR TESTING-ONLY

getMaxPathDepth

protected int getMaxPathDepth()

FOR TESTING-ONLY

setMaxItems

protected void setMaxItems(int maxItems)

FOR TESTING-ONLY

getMaxItems

protected int getMaxItems()

FOR TESTING-ONLY

getRootValidator

protected Validator getRootValidator(NodeState before,
                                     NodeState after,
                                     CommitInfo info)

Description copied from class: ValidatorProvider

Returns a validator for checking the changes between the given two root states.

Specified by:

getRootValidator in class ValidatorProvider

Parameters:

before - original root state

after - modified root state

info - metadata about this commit

Returns:

validator for checking the modifications, or null if this validator is not needed for this commit