Package org.apache.jackrabbit.oak.jcr.observation

Class ObservationManagerImpl

java.lang.Object

org.apache.jackrabbit.oak.jcr.observation.ObservationManagerImpl

All Implemented Interfaces:

ObservationManager, JackrabbitObservationManager

public class ObservationManagerImpl
extends Object
implements JackrabbitObservationManager

Field Summary

Fields

Modifier and Type	Field	Description
static Marker	OBSERVATION

Constructor Summary

Constructors

Constructor	Description
ObservationManagerImpl(SessionContext sessionContext, ReadOnlyNodeTypeManager nodeTypeManager, Whiteboard whiteboard, int queueLength, CommitRateLimiter commitRateLimiter)	Create a new instance based on a ContentSession that needs to implement Observable.

Method Summary

Modifier and Type	Method	Description
void	addEventListener(EventListener listener, int eventTypes, String absPath, boolean isDeep, String[] uuids, String[] nodeTypeName, boolean noLocal)
void	addEventListener(EventListener listener, JackrabbitEventFilter filter)	Adds an event listener that listens for the events specified by the passed JackrabbitEventFilter.
void	addEventListener(EventListener listener, FilterProvider filterProvider)	Adds an event listener that listens for the events specified by the filterProvider passed to this method.
void	dispose()
EventJournal	getEventJournal()
EventJournal	getEventJournal(int eventTypes, String absPath, boolean isDeep, String[] uuid, String[] nodeTypeName)
EventListenerIterator	getRegisteredEventListeners()
void	removeEventListener(EventListener listener)
void	setUserData(@Nullable String userData)

Methods inherited from class java.lang.Object

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

Field Detail

OBSERVATION

public static final Marker OBSERVATION

Constructor Detail

ObservationManagerImpl

public ObservationManagerImpl(SessionContext sessionContext,
                              ReadOnlyNodeTypeManager nodeTypeManager,
                              Whiteboard whiteboard,
                              int queueLength,
                              CommitRateLimiter commitRateLimiter)

Create a new instance based on a ContentSession that needs to implement Observable.

Parameters:

sessionContext - session delegate of the session in whose context this observation manager operates.

nodeTypeManager - node type manager for the content session

whiteboard -

Throws:

IllegalArgumentException - if contentSession doesn't implement Observable.

Method Detail

dispose

public void dispose()

addEventListener

public void addEventListener(EventListener listener,
                             FilterProvider filterProvider)

Adds an event listener that listens for the events specified by the filterProvider passed to this method.

The set of events will be further filtered by the access rights of the current Session.

The filters of an already-registered EventListener can be changed at runtime by re-registering the same EventListener object (i.e. the same actual Java object) with a new filter provider. The implementation must ensure that no events are lost during the changeover.

Parameters:

listener - an EventListener object.

filterProvider - filter provider specifying the filter for this listener

addEventListener

public void addEventListener(EventListener listener,
                             int eventTypes,
                             String absPath,
                             boolean isDeep,
                             String[] uuids,
                             String[] nodeTypeName,
                             boolean noLocal)
                      throws RepositoryException

Specified by:

addEventListener in interface ObservationManager

Throws:

RepositoryException

addEventListener

public void addEventListener(EventListener listener,
                             JackrabbitEventFilter filter)
                      throws RepositoryException

Description copied from interface: JackrabbitObservationManager

Adds an event listener that listens for the events specified by the passed JackrabbitEventFilter.

In addition to the EventFilter, the set of events reported will be further filtered by the access rights of the current Session.

See JackrabbitEventFilter for a description of the filtering parameters available.

The filter of an already-registered EventListener can be changed at runtime by re-registering the same EventListener object (i.e. the same actual Java object) with a new filter. The implementation must ensure that no events are lost during the changeover.

In addition to the filters placed on a listener above, the scope of observation support, in terms of which parts of a workspace are observable, may also be subject to implementation-specific restrictions. For example, in some repositories observation of changes in the jcr:system subgraph may not be supported.

Specified by:

addEventListener in interface JackrabbitObservationManager

Parameters:

listener - an EventListener object.

filter - an JackrabbitEventFilter object.

Throws:

RepositoryException - If an error occurs.

removeEventListener

public void removeEventListener(EventListener listener)

Specified by:

removeEventListener in interface ObservationManager

getRegisteredEventListeners

public EventListenerIterator getRegisteredEventListeners()

Specified by:

getRegisteredEventListeners in interface ObservationManager

setUserData

public void setUserData(@Nullable
                        @Nullable String userData)

Specified by:

setUserData in interface ObservationManager

getEventJournal

public EventJournal getEventJournal()
                             throws RepositoryException

Specified by:

getEventJournal in interface ObservationManager

Throws:

RepositoryException

getEventJournal

public EventJournal getEventJournal(int eventTypes,
                                    String absPath,
                                    boolean isDeep,
                                    String[] uuid,
                                    String[] nodeTypeName)
                             throws RepositoryException

Specified by:

getEventJournal in interface ObservationManager

Throws:

RepositoryException