org.apache.jackrabbit.core.observation

Class ObservationManagerImpl

java.lang.Object

org.apache.jackrabbit.core.observation.ObservationManagerImpl

All Implemented Interfaces:

ObservationManager, JackrabbitObservationManager, EventStateCollectionFactory

public class ObservationManagerImpl
extends Object
implements EventStateCollectionFactory, JackrabbitObservationManager

Each Session instance has its own ObservationManager instance. The class SessionLocalObservationManager implements this behaviour.

Constructor Summary

Constructors

Constructor and Description
ObservationManagerImpl(ObservationDispatcher dispatcher, SessionImpl session, ClusterNode clusterNode) Creates an ObservationManager instance.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(EventListener listener, int eventTypes, String absPath, boolean isDeep, String[] uuid, String[] nodeTypeName, boolean noLocal)
void	addEventListener(EventListener listener, JackrabbitEventFilter filter) Adds an event listener that listens for the events specified by the passed JackrabbitEventFilter.
EventFilter	createEventFilter(int eventTypes, List<String> absPaths, boolean isDeep, String[] uuid, String[] nodeTypeName, boolean noLocal, boolean noExternal, boolean noInternal) Creates a new event filter with the given restrictions.
EventStateCollection	createEventStateCollection() Creates an EventStateCollection.
void	dispose() Unregisters all EventListeners.
EventJournal	getEventJournal() Returns an unfiltered event journal for this workspace.
EventJournal	getEventJournal(int eventTypes, String absPath, boolean isDeep, String[] uuid, String[] nodeTypeName) Returns the event journal for this workspace.
EventListenerIterator	getRegisteredEventListeners()
void	removeEventListener(EventListener listener)
void	setUserData(String userData)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservationManagerImpl

public ObservationManagerImpl(ObservationDispatcher dispatcher,
                              SessionImpl session,
                              ClusterNode clusterNode)

Creates an ObservationManager instance.

Parameters:

dispatcher - observation dispatcher

session - the Session this ObservationManager belongs to.

clusterNode -

Throws:

NullPointerException - if dispatcher, session or clusterNode is null.

Method Detail

addEventListener

public void addEventListener(EventListener listener,
                             int eventTypes,
                             String absPath,
                             boolean isDeep,
                             String[] uuid,
                             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)
                         throws RepositoryException

Specified by:

removeEventListener in interface ObservationManager

Throws:

RepositoryException

getRegisteredEventListeners

public EventListenerIterator getRegisteredEventListeners()
                                                  throws RepositoryException

Specified by:

getRegisteredEventListeners in interface ObservationManager

Throws:

RepositoryException

setUserData

public void setUserData(String userData)
                 throws RepositoryException

Specified by:

setUserData in interface ObservationManager

Throws:

RepositoryException

dispose

public void dispose()

Unregisters all EventListeners.

createEventFilter

public EventFilter createEventFilter(int eventTypes,
                                     List<String> absPaths,
                                     boolean isDeep,
                                     String[] uuid,
                                     String[] nodeTypeName,
                                     boolean noLocal,
                                     boolean noExternal,
                                     boolean noInternal)
                              throws RepositoryException

Creates a new event filter with the given restrictions.

Parameters:

eventTypes - A combination of one or more event type constants encoded as a bitmask.

absPaths - absolute paths.

isDeep - a boolean.

uuid - array of UUIDs.

nodeTypeName - array of node type names.

noLocal - a boolean.

noExternal - a boolean.

noInternal - a boolean.

Returns:

the event filter with the given restrictions.

Throws:

RepositoryException - if an error occurs.

getEventJournal

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

Returns the event journal for this workspace. The events are filtered according to the passed criteria.

Specified by:

getEventJournal in interface ObservationManager

Parameters:

eventTypes - A combination of one or more event type constants encoded as a bitmask.

absPath - an absolute path.

isDeep - a boolean.

uuid - array of UUIDs.

nodeTypeName - array of node type names.

Returns:

the event journal for this repository.

Throws:

UnsupportedRepositoryOperationException - if this repository does not support an event journal (cluster journal disabled).

RepositoryException - if another error occurs.

See Also:

ObservationManager.getEventJournal(int, String, boolean, String[], String[])

getEventJournal

public EventJournal getEventJournal()
                             throws RepositoryException

Returns an unfiltered event journal for this workspace.

Specified by:

getEventJournal in interface ObservationManager

Returns:

the event journal for this repository.

Throws:

UnsupportedRepositoryOperationException - if this repository does not support an event journal (cluster journal disabled).

RepositoryException - if another error occurs.

createEventStateCollection

public EventStateCollection createEventStateCollection()

Creates an EventStateCollection.

Creates an EventStateCollection tied to the session which is attached to this ObservationManager instance.

Specified by:

createEventStateCollection in interface EventStateCollectionFactory

Returns:

a new EventStateCollection