info.magnolia.cms.util

Class WorkspaceObservingManager

java.lang.Object

info.magnolia.cms.util.WorkspaceObservingManager

Direct Known Subclasses:

ModuleConfigurationObservingManager

public abstract class WorkspaceObservingManager
extends Object

Manager that enables observing a specific workspace and specific node types.

Constructor Summary

Constructors

Constructor and Description
WorkspaceObservingManager(String workspace, String observedPath, boolean includeSubNodes, String nodeType)
WorkspaceObservingManager(String workspace, String observedPath, boolean includeSubNodes, String[] nodeTypes)
WorkspaceObservingManager(String workspace, String observedPath, boolean includeSubNodes, String[] nodeTypes, int eventTypesMask)

Method Summary

Modifier and Type	Method and Description
long	getDelay()
protected int	getEventTypesMask()
long	getMaxDelay()
protected String[]	getNodeTypes()
protected String	getObservedPath()
protected Object	getReloadMonitor() Returns the object used to synchronize on to keep multiple reload operations to occur at the same time.
protected String	getWorkspace()
protected javax.jcr.observation.EventListener	instantiateEventListener()
protected boolean	isIncludeSubNodes()
protected void	onStart()
protected void	registerChangeListener(javax.jcr.observation.EventListener eventListener)
protected abstract void	reload()
void	setDelay(long delay) Sets the delay of the deferred EventListener.
void	setMaxDelay(long maxDelay) Sets the maximum delay of the deferred EventListener.
void	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceObservingManager

public WorkspaceObservingManager(String workspace,
                                 String observedPath,
                                 boolean includeSubNodes,
                                 String[] nodeTypes,
                                 int eventTypesMask)

WorkspaceObservingManager

public WorkspaceObservingManager(String workspace,
                                 String observedPath,
                                 boolean includeSubNodes,
                                 String[] nodeTypes)

WorkspaceObservingManager

public WorkspaceObservingManager(String workspace,
                                 String observedPath,
                                 boolean includeSubNodes,
                                 String nodeType)

Method Detail

start

public void start()

onStart

protected void onStart()

registerChangeListener

protected void registerChangeListener(javax.jcr.observation.EventListener eventListener)

instantiateEventListener

protected javax.jcr.observation.EventListener instantiateEventListener()

reload

protected abstract void reload()
                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getWorkspace

protected String getWorkspace()

isIncludeSubNodes

protected boolean isIncludeSubNodes()

getNodeTypes

protected String[] getNodeTypes()

getObservedPath

protected String getObservedPath()

getEventTypesMask

protected int getEventTypesMask()

getReloadMonitor

protected Object getReloadMonitor()

Returns the object used to synchronize on to keep multiple reload operations to occur at the same time. Useful in subclasses to block calls while the reload is in progress.

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

Sets the delay of the deferred EventListener. Make sure to call this method before calling start().

getMaxDelay

public long getMaxDelay()

setMaxDelay

public void setMaxDelay(long maxDelay)

Sets the maximum delay of the deferred EventListener. Make sure to call this method before calling start().