com.day.cq.commons.jcr

Class JcrObservationThrottle

java.lang.Object

com.day.cq.commons.jcr.JcrObservationThrottle

public class JcrObservationThrottle
extends java.lang.Object

Used to wait until all queued observation events have been delivered, useful to throttle down operations that modify lots of nodes.

Constructor Summary

Constructors

Constructor and Description
JcrObservationThrottle(Node tempNodeFolder) Create a JcrObservationThrottle

Method Summary

Modifier and Type	Method and Description
void	close() MUST be called to clean up, DELETES the temp folder node that was passed to constructor
void	onEvent(EventIterator events)
void	open() Setup temporary node to detect events, must be called before {link #waitForEvents}
long	waitForEvents() Block until all pending observation events have been delivered.

Methods inherited from class java.lang.Object

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

Constructor Detail

JcrObservationThrottle

public JcrObservationThrottle(Node tempNodeFolder)

Create a JcrObservationThrottle

Parameters:

tempNodeFolder - a node with a unique name is created in that folder to detect observation events.

Method Detail

open

public void open()
          throws RepositoryException

Setup temporary node to detect events, must be called before {link #waitForEvents}

Throws:

RepositoryException

close

public void close()

MUST be called to clean up, DELETES the temp folder node that was passed to constructor

onEvent

public void onEvent(EventIterator events)

waitForEvents

public long waitForEvents()
                   throws RepositoryException

Block until all pending observation events have been delivered. As JCR events are delivered in order of their creation, simply creates a new temp node and waits for the corresponding event to be delivered. Note that the Session of the temporary folder node passed to the constructor is saved by this method, in order to create temporary nodes and detect their observation events.

Returns:

the elapsed time in msec for this method call.

Throws:

RepositoryException