info.magnolia.observation

Class WorkspaceEventListenerRegistration

java.lang.Object

info.magnolia.observation.WorkspaceEventListenerRegistration

public class WorkspaceEventListenerRegistration
extends Object

Helper class for registering EventListener for workspace observation.

Use observe(String, String, EventListener) to obtain a WorkspaceEventListenerRegistration.Registrar object for configuring the event listener and call WorkspaceEventListenerRegistration.Registrar.register() to perform the actual registration.

The returned WorkspaceEventListenerRegistration.Handle should be used to unregister the event listener.

See Also:

EventListener, ObservationManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkspaceEventListenerRegistration.Handle Handle used for unregistering EventListeners.
static class	WorkspaceEventListenerRegistration.Registrar Registrar for easing setup and de/registration of EventListener.
static class	WorkspaceEventListenerRegistration.WorkspaceEventListenerRegistrationException Exception thrown when same instance of a EventListener is already registered.

Method Summary

Methods

Modifier and Type	Method and Description
static WorkspaceEventListenerRegistration.Registrar	observe(String workspace, String observationPath, javax.jcr.observation.EventListener eventListener) Creates a WorkspaceEventListenerRegistration.Registrar object for configuring and registering the EventListener.

Methods inherited from class java.lang.Object

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

Method Detail

observe

public static WorkspaceEventListenerRegistration.Registrar observe(String workspace,
                                                   String observationPath,
                                                   javax.jcr.observation.EventListener eventListener)

Creates a WorkspaceEventListenerRegistration.Registrar object for configuring and registering the EventListener. Be careful that if you observe "/", events may be generated for jcr:system, which is "shared" across all workspaces. Use FilteredEventListener and JCR_SYSTEM_EXCLUDING_PREDICATE wherever appropriate.

Note that only one instance of the EventListener is allowed per workspace.

Parameters:

workspace - workspace to be observed

observationPath - path in the workspace to be observed

eventListener - event listener

Returns:

WorkspaceEventListenerRegistration.Registrar object for configuring and registering the EventListener

Throws:

NullPointerException - if any of the mandatory parameters is null