Uses of Interface
org.wandora.modules.Module

Packages that use Module

Package	Description
org.wandora.application.modulesserver
org.wandora.modules	This package contains a modular framework for applications and services.
org.wandora.modules.cache
org.wandora.modules.fng
org.wandora.modules.servlet
org.wandora.modules.topicmap
org.wandora.modules.usercontrol

Uses of Module in org.wandora.application.modulesserver

Subinterfaces of Module in org.wandora.application.modulesserver

Modifier and Type	Interface and Description
interface	ModulesWebApp An interface for modules that are web apps.

Classes in org.wandora.application.modulesserver that implement Module

Modifier and Type	Class and Description
class	AbstractTopicWebApp
class	AbstractWebApp
class	Axis2Service
class	BrowserPluginService
class	BundleContext A servlet context for the bundle.
class	FNGAPIWebApp
class	GraphMLWebApp
class	IIIFWebApp
class	JettyModule A module that exposes the Jetty server object itself.
class	JTMWebApp
class	ModuleBundle An extension of the ScopedModuleManager, meant to represent a bundle of modules.
class	RDFWebApp
class	SameAsService SameAsService implements a simple web service that returns all subject identifiers of a given topic.
class	ScreenCastWebApp
class	ViewTopicWebApp
class	WaianaService WaianaService implements an API used to store and retrieve topic maps via JSON fragments submitted over HTTP.
class	WandoraModuleManager Module manager extension used by Wandora.
class	WandoraServletModule
class	XTMWebApp

Methods in org.wandora.application.modulesserver that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	AbstractTopicWebApp.getDependencies(ModuleManager manager)
java.util.Collection<Module>	AbstractWebApp.getDependencies(ModuleManager manager)
java.util.Collection<Module>	Axis2Service.getDependencies(ModuleManager manager)
java.util.Collection<Module>	BrowserPluginService.getDependencies(ModuleManager manager)
java.util.Collection<Module>	FNGAPIWebApp.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ScreenCastWebApp.getDependencies(ModuleManager manager)
java.util.Collection<Module>	WaianaService.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ModuleBundle.parseXMLConfigElement(org.w3c.dom.Node doc, java.lang.String source)

Uses of Module in org.wandora.modules

Subinterfaces of Module in org.wandora.modules

Modifier and Type	Interface and Description
interface	DatabaseInterface An interface for a module that provides database services.
interface	ReplacementsModule The interface for the replacements system.

Classes in org.wandora.modules that implement Module

Modifier and Type	Class and Description
class	AbstractModule A basic implementation of the Module interface.
class	DBTesterModule This does some stress testing of DatabaseInterface, mainly intended for debugging memory leaks.
class	DefaultReplacementsModule A basic implementation of the replacements system.
class	EmailModule A module that provides email sending services for other modules.
class	GenericDatabaseInterface A general purpose implementation of the DatabaseInterface using JDBC and thus being able to operate with many different relational databases.
class	LoggingModule A module that provides logging facilities for other modules.
class	ModuleGroup
class	NetAuthenticatorModule
class	ScopedModuleManager A module manager that can be placed inside other module managers in a hierarchical fashion.
class	ScriptModule A base module implementation that adds some scripting functionality into the module.

Fields in org.wandora.modules with type parameters of type Module

Modifier and Type	Field and Description
protected java.util.ArrayList<Module>	ModuleGroup.childModules
java.lang.Class<? extends Module>	ScopedModuleManager.Import.cls
protected java.util.HashMap<Module,java.util.ArrayList<Module>>	ModuleManager.isRequiredBy Modules that are used by some other running module are put here so that they cannot be stopped before the depending module is stopped.
protected java.util.HashMap<Module,java.util.ArrayList<Module>>	ModuleManager.isRequiredBy Modules that are used by some other running module are put here so that they cannot be stopped before the depending module is stopped.
protected java.util.HashMap<Module,java.util.HashMap<java.lang.String,java.lang.Object>>	ModuleManager.moduleParams Initialisation parameters that will be passed to module init method, read from the config file.
protected java.util.ArrayList<Module>	ModuleManager.modules A list containing all the modules this manager takes care of.
protected java.util.HashMap<Module,ModuleManager.ModuleSettings>	ModuleManager.moduleSettings Other settings about modules besides the parameters.
java.util.HashMap<java.lang.Class<? extends Module>,java.lang.String>	ModuleManager.ModuleSettings.serviceNames The explicitly defined dependencies.

Methods in org.wandora.modules with type parameters of type Module

Modifier and Type	Method and Description
<A extends Module> A	ModuleManager.findModule(java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	ModuleManager.findModule(Module context, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	ModuleManager.findModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	ScopedModuleManager.findModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls)
<A extends Module> A	ModuleManager.findModule(java.lang.String instanceName, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> java.util.ArrayList<A>	ModuleManager.findModules(java.lang.Class<A> cls) Finds all modules that are of the specified class or one extending it.
<A extends Module> java.util.ArrayList<A>	ScopedModuleManager.findModulesRecursive(java.lang.Class<A> cls)
<A extends Module> A	ModuleManager.optionalModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> java.util.ArrayList<A>	ModuleManager.optionalModules(java.lang.Class<A> cls, java.util.Collection<Module> dependencies)
<A extends Module> A	ModuleManager.requireModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.

Methods in org.wandora.modules that return Module

Modifier and Type	Method and Description
Module	ModuleDelegate.getModule()

Methods in org.wandora.modules that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.ArrayList<Module>	ModuleManager.getAllModules() Returns a list of all modules added to this manager.
java.util.Collection<Module>	ModuleGroup.getChildModules()
java.util.Collection<Module>	ModuleGroup.getChildModulesRecursive()
java.util.Collection<Module>	AbstractModule.getDependencies(ModuleManager manager)
java.util.Collection<Module>	DBTesterModule.getDependencies(ModuleManager manager)
java.util.Collection<Module>	EmailModule.getDependencies(ModuleManager manager)
java.util.Collection<Module>	GenericDatabaseInterface.getDependencies(ModuleManager manager)
java.util.Collection<Module>	Module.getDependencies(ModuleManager manager) Returns all the modules this module depends on.
java.util.Collection<Module>	ScopedModuleManager.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ModuleManager.parseXMLConfigElement(org.w3c.dom.Node doc, java.lang.String source) Parses an XML element as if it was the root element of a full configuration file.
java.util.Collection<Module>	ScopedModuleManager.parseXMLConfigElement(org.w3c.dom.Node doc, java.lang.String source)
java.util.Collection<Module>	ModuleManager.parseXMLInclude(org.w3c.dom.Element e) Parses an handles include element.
Tuples.T3<Module,java.util.HashMap<java.lang.String,java.lang.Object>,ModuleManager.ModuleSettings>	ModuleManager.parseXMLModuleElement(org.w3c.dom.Element e, java.lang.String source) Reads a module element and returns the module, its module parameters and module settings.
java.util.Collection<Module>	ModuleManager.readXMLOptionsFile(java.lang.String optionsFileName) Reads and parses a whole xml configuration file.
protected java.util.Collection<Module>	AbstractModule.requireLogging(ModuleManager manager, java.util.Collection<Module> dependencies) A helper method that adds logging into dependencies.

Methods in org.wandora.modules with parameters of type Module

Modifier and Type	Method and Description
void	ModuleGroup.addChildModule(Module m)
void	ModuleManager.addModule(Module module) Adds a module to this manager with default settings and no module parameters.
void	ModuleManager.addModule(Module module, java.util.HashMap<java.lang.String,java.lang.Object> params) Adds a module to this manager with the given module parameters and default settings.
void	ModuleManager.addModule(Module module, java.util.HashMap<java.lang.String,java.lang.Object> params, ModuleManager.ModuleSettings settings) Adds a module to this manager with the given module parameters and settings.
void	ModuleManager.addModule(Module module, ModuleManager.ModuleSettings settings) Adds a module to this manager with the given module settings but empty module parameters.
void	ModuleManager.addModule(Module module, java.lang.String name) Adds a module to this manager with default settings and no module parameters but with the provided name.
<A extends Module> A	ModuleManager.findModule(Module context, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	ModuleManager.findModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	ScopedModuleManager.findModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls)
org.apache.commons.logging.Log	LoggingModule.getLog(Module module)
java.lang.String	ModuleManager.getModuleName(Module m) Gets the module name.
ModuleManager.ModuleSettings	ModuleManager.getModuleSettings(Module m) Gets module settings.
boolean	ModuleManager.isModuleAutoStart(Module m) Checks if module is to be started automatically.
void	AbstractModuleListener.moduleStarted(Module module)
void	ModuleListener.moduleStarted(Module module) Called when a module has successfully started.
void	AbstractModuleListener.moduleStarting(Module module)
void	ModuleListener.moduleStarting(Module module) Called when a module is about to be started.
void	AbstractModuleListener.moduleStopped(Module module)
void	ModuleListener.moduleStopped(Module module) Called after a module has stopped.
void	AbstractModuleListener.moduleStopping(Module module)
void	ModuleListener.moduleStopping(Module module) Called immediately before a module will be stopped.
java.lang.String	ModuleManager.moduleToString(Module module) Creates a string representation of a module.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
void	ModuleManager.removeModule(Module module) Removes a module from the manager.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
void	ModuleManager.startModule(Module module) Starts a module.
void	ModuleManager.startModuleWithDependencies(Module module) Starts a module as well as all modules it depends on.
void	ModuleManager.stopCascading(Module module) Stops a single module along with all modules that depend on it.
void	ModuleManager.stopModule(Module module) Stops a single module, but fails if other modules depend on it.

Method parameters in org.wandora.modules with type arguments of type Module

Modifier and Type	Method and Description
void	ScopedModuleManager.addImport(java.lang.Class<? extends Module> cls, boolean optional)
void	ModuleManager.autostartModules(java.util.Collection<Module> modules) In a given modules collection, starts all modules that have not yet been started and that were set to start automatically in module settings.
<A extends Module> A	ModuleManager.optionalModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	ModuleManager.optionalModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> java.util.ArrayList<A>	ModuleManager.optionalModules(java.lang.Class<A> cls, java.util.Collection<Module> dependencies)
protected java.util.Collection<Module>	AbstractModule.requireLogging(ModuleManager manager, java.util.Collection<Module> dependencies) A helper method that adds logging into dependencies.
<A extends Module> A	ModuleManager.requireModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	ModuleManager.requireModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.

Constructor parameters in org.wandora.modules with type arguments of type Module

Constructor and Description
Import(java.lang.Class<? extends Module> cls)
Import(java.lang.Class<? extends Module> cls, boolean optional)
MissingDependencyException(java.lang.Class<? extends Module> cls)
MissingDependencyException(java.lang.Class<? extends Module> cls, java.lang.String instanceName)
MissingDependencyException(java.lang.String message, java.lang.Class<? extends Module> cls)
MissingDependencyException(java.lang.String message, java.lang.Class<? extends Module> cls, java.lang.String instanceName)
ModuleInUseException(java.util.ArrayList<Module> modules)
ModuleInUseException(java.lang.String message, java.util.ArrayList<Module> modules)
ModuleSettings(java.lang.String name, boolean autoStart, int servicePriority, java.util.HashMap<java.lang.Class<? extends Module>,java.lang.String> serviceNames)

Uses of Module in org.wandora.modules.cache

Subinterfaces of Module in org.wandora.modules.cache

Modifier and Type	Interface and Description
interface	CacheService An interface for caching services.

Classes in org.wandora.modules.cache that implement Module

Modifier and Type	Class and Description
class	DiskCacheModule Stores cached content on a file system.

Methods in org.wandora.modules.cache that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	DiskCacheModule.getDependencies(ModuleManager manager)

Uses of Module in org.wandora.modules.fng

Classes in org.wandora.modules.fng that implement Module

Modifier and Type	Class and Description
class	FNGAPIAction
class	FNGAPIExceptionHandler
class	NewAPIKeyAction

Methods in org.wandora.modules.fng that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	FNGAPIAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	NewAPIKeyAction.getDependencies(ModuleManager manager)

Uses of Module in org.wandora.modules.servlet

Subinterfaces of Module in org.wandora.modules.servlet

Modifier and Type	Interface and Description
interface	ActionExceptionHandler An interface for handlers that can take care of ActionExceptions thrown when handling an HTTP request.
interface	ServletModule A module that hooks to a servlet, or something similar.
interface	TemplateContextProvider This class can be used to define a default template context for template managers.

Classes in org.wandora.modules.servlet that implement Module

Modifier and Type	Class and Description
class	AbstractAction The base class for action modules, that is modules that respond to an HTTP request and return some content.
class	AbstractTemplate A base implementation for templates.
class	CachedAction This is a base class for actions that take advantage of caching services.
class	ChainedAction An action that makes it possible to chain together two, or more, actions into one.
class	GenericContext A base for context modules.
class	GenericTemplateAction A general purpose action that uses templates for output.
class	ImageResizeAction An action that reads images from a source directory and resizes them to fit specified dimensions.
class	ModulesServlet._ServletModule
class	ModulesWandoraWebAppHandler._ServletModule
class	RecaptchaAction
class	RedirectAction
class	RequestForwarder
class	SendEmailAction Sends an email composed using a template.
class	StaticContentAction
class	StaticTemplateContextProvider This class can be used to define a default context for template managers.
class	TemplateActionExceptionHandler An implementation of ActionExceptionHandler, a module that handles exceptions thrown by other actions.
class	TemplateManager A module where all Templates register themselves so that Actions, or other modules too, can find them.
class	VelocityEngineModule A module that makes an Apache Velocity engine available for any VelocityTemplates.
class	VelocityTemplate A Template implementation using the Apache Velocity templating engine.

Methods in org.wandora.modules.servlet that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	AbstractAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	AbstractTemplate.getDependencies(ModuleManager manager)
java.util.Collection<Module>	CachedAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ChainedAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	GenericContext.getDependencies(ModuleManager manager)
java.util.Collection<Module>	GenericTemplateAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ImageResizeAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	RecaptchaAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	RedirectAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	RequestForwarder.getDependencies(ModuleManager manager)
java.util.Collection<Module>	SendEmailAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	StaticContentAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	TemplateActionExceptionHandler.getDependencies(ModuleManager manager)
java.util.Collection<Module>	TemplateManager.getDependencies(ModuleManager manager)
java.util.Collection<Module>	VelocityTemplate.getDependencies(ModuleManager manager)

Uses of Module in org.wandora.modules.topicmap

Subinterfaces of Module in org.wandora.modules.topicmap

Modifier and Type	Interface and Description
interface	TopicMapManager The interface for a module that provides a topic map, and related services, for other modules.

Classes in org.wandora.modules.topicmap that implement Module

Modifier and Type	Class and Description
class	SimpleTopicMapManager Basic implementation of the topic map manager.
class	ViewTopicAction An action for displaying something about a single topic using a template.
class	WandoraTopicMapManager A TopicMapManager implementation that uses a running Wandora application for the topic map.

Methods in org.wandora.modules.topicmap that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	SimpleTopicMapManager.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ViewTopicAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	WandoraTopicMapManager.getDependencies(ModuleManager manager)

Uses of Module in org.wandora.modules.usercontrol

Subinterfaces of Module in org.wandora.modules.usercontrol

Modifier and Type	Interface and Description
interface	ModifyableUserStore An interface that adds to the basic UserBase interface methods which allow users to be modified.
interface	UserAuthenticator The base interface for authenticators.
interface	UserStore The base interface for a UserStore.

Classes in org.wandora.modules.usercontrol that implement Module

Modifier and Type	Class and Description
class	AbstractControlledContext
class	BasicUserAuthenticator A simple user authenticator that performs standard HTTP authentication using the BASIC scheme.
class	ChangeUserAction An action that changes something about a user.
class	ChangeUserRolesAction Deprecated.
class	DatabaseUserStore A user store which stores users in a relational database.
class	FileUserStore A user store that reads users from a json file.
class	FrequencyRestrictedContext
class	GetUserAuthenticator A simple user authenticator that takes the user name and password from the HTTP request parameters.
class	GetUserLogAction
class	PasswordResendAction
class	RoleRestrictedContext
class	SourceRestrictedContext A context which restricts access to the source IP address.
class	StaticUserStore A very simple user store which reads user names and passwords and roles straight from the initialisation parameters.
class	UserLoggerAction
class	UserManagerAction
class	UserStoreCopyTool This is a module you might include in the modules config to move users from one user store to another.

Methods in org.wandora.modules.usercontrol that return types with arguments of type Module

Modifier and Type	Method and Description
java.util.Collection<Module>	AbstractControlledContext.getDependencies(ModuleManager manager)
java.util.Collection<Module>	BasicUserAuthenticator.getDependencies(ModuleManager manager)
java.util.Collection<Module>	ChangeUserAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	DatabaseUserStore.getDependencies(ModuleManager manager)
java.util.Collection<Module>	FileUserStore.getDependencies(ModuleManager manager)
java.util.Collection<Module>	GetUserAuthenticator.getDependencies(ModuleManager manager)
java.util.Collection<Module>	GetUserLogAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	PasswordResendAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	StaticUserStore.getDependencies(ModuleManager manager)
java.util.Collection<Module>	UserLoggerAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	UserManagerAction.getDependencies(ModuleManager manager)
java.util.Collection<Module>	UserStoreCopyTool.getDependencies(ModuleManager manager)