com.ecyrd.jspwiki.modules
Class ModuleManager

java.lang.Object
  extended by com.ecyrd.jspwiki.modules.ModuleManager
Direct Known Subclasses:
EditorManager, FilterManager, PageManager, PluginManager, TemplateManager

public abstract class ModuleManager
extends Object

Superclass for all JSPWiki managers for modules (plugins, etc).


Field Summary
protected  WikiEngine m_engine
           
static String PLUGIN_RESOURCE_LOCATION
          Location of the property-files of plugins.
 
Constructor Summary
ModuleManager(WikiEngine engine)
          Constructs the ModuleManager.
 
Method Summary
 boolean checkCompatibility(WikiModuleInfo info)
          Returns true, if the given module is compatible with this version of JSPWiki.
abstract  Collection modules()
          Returns a collection of modules currently managed by this ModuleManager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PLUGIN_RESOURCE_LOCATION

public static final String PLUGIN_RESOURCE_LOCATION
Location of the property-files of plugins. (Each plugin should include this property-file in its jar-file)

See Also:
Constant Field Values

m_engine

protected WikiEngine m_engine
Constructor Detail

ModuleManager

public ModuleManager(WikiEngine engine)
Constructs the ModuleManager.

Parameters:
engine - The WikiEngine which owns this manager.
Method Detail

checkCompatibility

public boolean checkCompatibility(WikiModuleInfo info)
Returns true, if the given module is compatible with this version of JSPWiki.

Parameters:
info - The module to check
Returns:
True, if the module is compatible.

modules

public abstract Collection modules()
Returns a collection of modules currently managed by this ModuleManager. Each entry is an instance of the WikiModuleInfo class. This method should return something which is safe to iterate over, even if the underlying collection changes.

Returns:
A Collection of WikiModuleInfo instances.