info.magnolia.cms.util

Class ObservationUtil

java.lang.Object

info.magnolia.cms.util.ObservationUtil

Deprecated.

since 5.4.6 use WorkspaceEventListenerRegistration instead

@Deprecated
public class ObservationUtil
extends Object

Util to register JCR observations. Supports delayed execution of the listener to handle event bursts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObservationUtil.DeferringEventListener Deprecated. since 5.4.6 use DeferringEventListener instead
static class	ObservationUtil.ListBasedEventIterator Deprecated. since 5.4.6 use DeferringEventListener.ListBasedEventIterator instead
static class	ObservationUtil.ObservationBasedDelayedExecutor Deprecated. since 5.4.6 use DeferringEventListener.ObservationBasedDelayedExecutor instead

Constructor Summary

Constructors

Constructor and Description
ObservationUtil() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static void	dispose(String workspace) Deprecated. since 5.4.6 without replacement
static javax.jcr.observation.EventListener	instanciateDeferredEventListener(javax.jcr.observation.EventListener listener, long delay, long maxDelay) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, boolean includeSubnodes, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, boolean includeSubnodes, String[] nodeTypes, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, boolean includeSubnodes, String[] nodeTypes, int eventTypesMask, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, boolean includeSubnodes, String nodeType, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, boolean includeSubnodes, String nodeType, int eventTypesMask, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerChangeListener(String workspace, String observationPath, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerDeferredChangeListener(String workspace, String observationPath, boolean includeSubnodes, javax.jcr.observation.EventListener listener, long delay, long maxDelay) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerDeferredChangeListener(String workspace, String observationPath, boolean includeSubnodes, String[] nodeTypes, javax.jcr.observation.EventListener listener, long delay, long maxDelay) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerDeferredChangeListener(String workspace, String observationPath, boolean includeSubnodes, String nodeType, javax.jcr.observation.EventListener listener, long delay, long maxDelay) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	registerDeferredChangeListener(String workspace, String observationPath, javax.jcr.observation.EventListener listener, long delay, long maxDelay) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners
static void	unregisterChangeListener(String workspace, javax.jcr.observation.EventListener listener) Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Handle.unregister() to unregister listeners

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservationUtil

public ObservationUtil()

Deprecated.

Method Detail

dispose

@Deprecated
public static void dispose(String workspace)

Deprecated. since 5.4.6 without replacement

Unregisters all EventListeners for the given workspace.

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Registers an EventListener for any node type.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     boolean includeSubnodes,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Registers an EventListener for any node type.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     boolean includeSubnodes,
                                     String nodeType,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Registers an EventListener for a specific node type.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     boolean includeSubnodes,
                                     String nodeType,
                                     int eventTypesMask,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Registers an EventListener for a specific node type and event types.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     boolean includeSubnodes,
                                     String[] nodeTypes,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Registers an EventListener for a specific set of node types and event types.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerChangeListener

@Deprecated
public static void registerChangeListener(String workspace,
                                     String observationPath,
                                     boolean includeSubnodes,
                                     String[] nodeTypes,
                                     int eventTypesMask,
                                     javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Register a single event listener, bound to the given path.

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.

Finally, consider using ObservationManager directly, as ObservationUtil may become mostly deprecated in the near future.

Parameters:

observationPath - the absPath parameter of ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

includeSubnodes - the isDeep parameter of ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

nodeTypes - the nodeTypeName parameter of ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

eventTypesMask - the eventTypes parameter of ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

listener - the listener parameter of ObservationManager.addEventListener(javax.jcr.observation.EventListener, int, java.lang.String, boolean, java.lang.String[], java.lang.String[], boolean)

See Also:

ObservationManager.addEventListener(EventListener, int, String, boolean, String[], String[], boolean), Event, FilteredEventListener

registerDeferredChangeListener

@Deprecated
public static void registerDeferredChangeListener(String workspace,
                                             String observationPath,
                                             javax.jcr.observation.EventListener listener,
                                             long delay,
                                             long maxDelay)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

The event firing is deferred in case there is a series of fired events.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerDeferredChangeListener

@Deprecated
public static void registerDeferredChangeListener(String workspace,
                                             String observationPath,
                                             boolean includeSubnodes,
                                             javax.jcr.observation.EventListener listener,
                                             long delay,
                                             long maxDelay)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

The event firing is deferred in case there is a series of fired events.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerDeferredChangeListener

@Deprecated
public static void registerDeferredChangeListener(String workspace,
                                             String observationPath,
                                             boolean includeSubnodes,
                                             String nodeType,
                                             javax.jcr.observation.EventListener listener,
                                             long delay,
                                             long maxDelay)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

The event firing is deferred in case there is a series of fired events.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

registerDeferredChangeListener

@Deprecated
public static void registerDeferredChangeListener(String workspace,
                                             String observationPath,
                                             boolean includeSubnodes,
                                             String[] nodeTypes,
                                             javax.jcr.observation.EventListener listener,
                                             long delay,
                                             long maxDelay)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

The event firing is deferred in case there is a series of fired events.

See Also:

registerChangeListener(String, String, boolean, String[], int, EventListener)

instanciateDeferredEventListener

@Deprecated
public static javax.jcr.observation.EventListener instanciateDeferredEventListener(javax.jcr.observation.EventListener listener,
                                                                              long delay,
                                                                              long maxDelay)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Registrar instead to register listeners

Use this and register the returned EventListener with the registerChangeListener() methods, if you need to be able to later unregister your EventListener.

unregisterChangeListener

@Deprecated
public static void unregisterChangeListener(String workspace,
                                       javax.jcr.observation.EventListener listener)

Deprecated. since 5.4.6 use WorkspaceEventListenerRegistration.Handle.unregister() to unregister listeners