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

Class FilteredHandler

java.lang.Object

org.apache.jackrabbit.oak.plugins.observation.DefaultEventHandler

org.apache.jackrabbit.oak.plugins.observation.FilteredHandler

All Implemented Interfaces:

EventHandler

public class FilteredHandler
extends DefaultEventHandler

Filtered event handler. This decorator class applies an EventFilter on all detected changes, and forwards the filtered change events to a given delegate handler.

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.plugins.observation.DefaultEventHandler

INSTANCE

Constructor Summary

Constructors

Constructor	Description
FilteredHandler(EventFilter filter, EventHandler handler)

Method Summary

Modifier and Type	Method	Description
void	enter(NodeState before, NodeState after)	Called before the given before and after states are compared.
@Nullable EventHandler	getChildHandler(String name, NodeState before, NodeState after)	Returns a handler of events within the given child node, or null if changes within that child are not to be processed.
void	leave(NodeState before, NodeState after)	Called after the given before and after states are compared.
void	nodeAdded(String name, NodeState after)	Notification for an added node
void	nodeDeleted(String name, NodeState before)	Notification for a deleted node
void	nodeMoved(String sourcePath, String name, NodeState moved)	Notification for a moved node
void	nodeReordered(String destName, String name, NodeState reordered)	Notification for a reordered node
void	propertyAdded(PropertyState after)	Notification for an added property
void	propertyChanged(PropertyState before, PropertyState after)	Notification for a changed property
void	propertyDeleted(PropertyState before)	Notification for a deleted property

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredHandler

public FilteredHandler(EventFilter filter,
                       EventHandler handler)

Method Detail

enter

public void enter(NodeState before,
                  NodeState after)

Description copied from interface: EventHandler

Called before the given before and after states are compared. The implementation can use this method to initialize any internal state needed for processing the results of the comparison.

Specified by:

enter in interface EventHandler

Overrides:

enter in class DefaultEventHandler

Parameters:

before - before state, non-existent if this node was added

after - after state, non-existent if this node was removed

leave

public void leave(NodeState before,
                  NodeState after)

Description copied from interface: EventHandler

Called after the given before and after states are compared. The implementation can use this method to post-process information collected during the content diff.

Specified by:

leave in interface EventHandler

Overrides:

leave in class DefaultEventHandler

Parameters:

before - before state, non-existent if this node was added

after - after state, non-existent if this node was removed

getChildHandler

@Nullable
public @Nullable EventHandler getChildHandler(String name,
                                              NodeState before,
                                              NodeState after)

Description copied from interface: EventHandler

Returns a handler of events within the given child node, or null if changes within that child are not to be processed.

Specified by:

getChildHandler in interface EventHandler

Overrides:

getChildHandler in class DefaultEventHandler

Parameters:

name - name of the child node

before - before state of the child node, possibly non-existent

after - after state of the child node, possibly non-existent

Returns:

this

propertyAdded

public void propertyAdded(PropertyState after)

Description copied from interface: EventHandler

Notification for an added property

Specified by:

propertyAdded in interface EventHandler

Overrides:

propertyAdded in class DefaultEventHandler

Parameters:

after - added property

propertyChanged

public void propertyChanged(PropertyState before,
                            PropertyState after)

Description copied from interface: EventHandler

Notification for a changed property

Specified by:

propertyChanged in interface EventHandler

Overrides:

propertyChanged in class DefaultEventHandler

Parameters:

before - property before the change

after - property after the change

propertyDeleted

public void propertyDeleted(PropertyState before)

Description copied from interface: EventHandler

Notification for a deleted property

Specified by:

propertyDeleted in interface EventHandler

Overrides:

propertyDeleted in class DefaultEventHandler

Parameters:

before - deleted property

nodeAdded

public void nodeAdded(String name,
                      NodeState after)

Description copied from interface: EventHandler

Notification for an added node

Specified by:

nodeAdded in interface EventHandler

Overrides:

nodeAdded in class DefaultEventHandler

Parameters:

name - name of the node

after - added node

nodeDeleted

public void nodeDeleted(String name,
                        NodeState before)

Description copied from interface: EventHandler

Notification for a deleted node

Specified by:

nodeDeleted in interface EventHandler

Overrides:

nodeDeleted in class DefaultEventHandler

Parameters:

name - name of the deleted node

before - deleted node

nodeMoved

public void nodeMoved(String sourcePath,
                      String name,
                      NodeState moved)

Description copied from interface: EventHandler

Notification for a moved node

Specified by:

nodeMoved in interface EventHandler

Overrides:

nodeMoved in class DefaultEventHandler

Parameters:

sourcePath - source of the moved node

name - name of the moved node

moved - moved node

nodeReordered

public void nodeReordered(String destName,
                          String name,
                          NodeState reordered)

Description copied from interface: EventHandler

Notification for a reordered node

Specified by:

nodeReordered in interface EventHandler

Overrides:

nodeReordered in class DefaultEventHandler

Parameters:

destName - name of the orderBefore() destination node

name - name of the moved node

reordered - moved node