org.mmbase.module

Class ReloadableModule

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.util.functions.DescribedFunctionProvider

org.mmbase.module.Module

org.mmbase.module.ReloadableModule

All Implemented Interfaces:

Descriptor

Direct Known Subclasses:

Lucene, WatchedReloadableModule

public abstract class ReloadableModule
extends Module

A Reloadable Module has a 'reload' method. You can extend your own modules from this. If you need to happen the reload automaticly, then WatchedReloadableModule.

Since:

MMBase-1.8

Version:

$Id$

Author:

Michiel Meeuwissen

Field Summary

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
ReloadableModule()
ReloadableModule(String name)

Method Summary

Modifier and Type	Method and Description
abstract void	reload() This method should be called when the module should be reloaded.
protected boolean	reloadConfiguration() Reloads the configuration file.
protected boolean	reloadConfiguration(ModuleReader parser)

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, init, loadInitParameters, loadInitParameters, maintainance, onload, setInitParameter, setMaintainer, setState, setVersion, shutdown, 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

Constructor Detail

ReloadableModule

public ReloadableModule()

ReloadableModule

public ReloadableModule(String name)

Method Detail

reloadConfiguration

protected boolean reloadConfiguration()

Reloads the configuration file. The module cannot change class, so if you change that in the XML, an error is logged, and nothing will happen. This method should be called from your extension if and when the configuration must be reloaded.

Returns:

Whether successful.

reloadConfiguration

protected boolean reloadConfiguration(ModuleReader parser)

reload

public abstract void reload()

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