org.mmbase.notifications

Class Notifier

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.util.functions.DescribedFunctionProvider

org.mmbase.module.Module

org.mmbase.module.ReloadableModule

org.mmbase.module.WatchedReloadableModule

org.mmbase.notifications.Notifier

All Implemented Interfaces:

Runnable, Descriptor, EventListener, NodeEventListener, RelationEventListener

public class Notifier
extends WatchedReloadableModule
implements NodeEventListener, RelationEventListener, Runnable

This class maintains all notifyables and takes care of the actual submission of all notifications.

Version:

$Id$

Author:

Michiel Meeuwissen

Field Summary

Fields

Modifier and Type	Field and Description
(package private) DelayQueue<Notifyable>	queue
protected boolean	running

Fields inherited from class org.mmbase.module.Module

configurationPath, getMaintainerFunction, getVersionFunction, properties, STATE_START_TIME

Fields inherited from class org.mmbase.util.functions.DescribedFunctionProvider

description, guiName, name

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions, getFunctions

Constructor Summary

Constructors

Constructor and Description
Notifier()

Method Summary

Modifier and Type	Method and Description
protected boolean	determinActive()
protected Collection<String>	getRelevantBuilders()
void	init() Initializes the module.
protected void	loadNotifyables()
void	notify(NodeEvent ne)
void	notify(RelationEvent re)
void	reload() This method should be called when the module should be reloaded.
void	run()
void	shutdown() Shuts down the module.
protected void	startThread()

Methods inherited from class org.mmbase.module.WatchedReloadableModule

onload

Methods inherited from class org.mmbase.module.ReloadableModule

reloadConfiguration, reloadConfiguration

Methods inherited from class org.mmbase.module.Module

addInitParameters, getInitParameter, getInitParameter, getInitParameter, getInitParameters, getInitParameters, getMaintainer, getModule, getModule, getModule, getModule, getModuleInfo, getModuleLoader, getModuleReader, getModuleReader, getModules, getState, getStates, getVersion, hasModule, hasStarted, loadInitParameters, loadInitParameters, maintainance, setInitParameter, setMaintainer, setState, setVersion, shutdownModules, startModule, startModules

Methods inherited from class org.mmbase.util.functions.DescribedFunctionProvider

getDefaultLocale, getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, getName, setDescription, setDescription, setGUIName, setGUIName, setLocalizedDescription, setLocalizedGUIName, setName

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue, newFunctionInstance

Methods inherited from class java.lang.Object

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

Field Detail

running

protected boolean running

queue

DelayQueue<Notifyable> queue

Constructor Detail

Notifier

public Notifier()

Method Detail

getRelevantBuilders

protected Collection<String> getRelevantBuilders()

reload

public void reload()

Description copied from class: ReloadableModule

This method should be called when the module should be reloaded.

Specified by:

reload in class ReloadableModule

loadNotifyables

protected void loadNotifyables()

init

public void init()

Description copied from class: Module

Initializes the module. Init must be overridden to read the environment variables it needs.
This method is called by Module.startModule(), which makes sure it is not called more than once. You should not call init() directly, call startModule() instead.

Overrides:

init in class Module

startThread

protected void startThread()

determinActive

protected boolean determinActive()

To Do:

Similar code in org.mmbase.module.lucene.Lucene, org.mmbase.sms.Sender Generalize this.

shutdown

public void shutdown()

Description copied from class: Module

Shuts down the module. This method is called by shutdownModules.

Overrides:

shutdown in class Module

run

public void run()

Specified by:

run in interface Runnable

notify

public void notify(NodeEvent ne)

Specified by:

notify in interface NodeEventListener

notify

public void notify(RelationEvent re)

Specified by:

notify in interface RelationEventListener