org.wandora.application.modulesserver

Class ViewTopicWebApp

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.servlet.AbstractAction

org.wandora.modules.servlet.CachedAction

org.wandora.modules.servlet.GenericTemplateAction

org.wandora.modules.topicmap.ViewTopicAction

org.wandora.application.modulesserver.ViewTopicWebApp

All Implemented Interfaces:

ModulesWebApp, Module, ActionHandler, ServletModule.RequestListener

public class ViewTopicWebApp
extends ViewTopicAction
implements ModulesWebApp

Author:

olli

Nested Class Summary

Nested classes/interfaces inherited from class org.wandora.modules.servlet.CachedAction

CachedAction.OutputProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	appStartPage
protected java.lang.String	webAppName

Fields inherited from class org.wandora.modules.topicmap.ViewTopicAction

defaultLang, defaultTopic, noTopic, tmManager, topicContextKey, topicMapContextKey, topicRequestKey

Fields inherited from class org.wandora.modules.servlet.GenericTemplateAction

defaultRequestParameters, forwardRequestParameters, requestContextKey, staticContext, templateKey, templateManager

Fields inherited from class org.wandora.modules.servlet.CachedAction

cache, caching, threadPool

Fields inherited from class org.wandora.modules.servlet.AbstractAction

actionParamKey, handledActions, httpHeaders, isDefaultAction, replacements, replacementsInitialized, servletModule

Fields inherited from class org.wandora.modules.ScriptModule

engine, initScript, persistentObjects, scriptManager, startScript, stopScript

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
ViewTopicWebApp()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppName() Returns the name of the web app.
java.lang.String	getAppStartPage() Returns the URL for the start page of the web app.
java.lang.String	getAppTopicPage(java.lang.String si) Returns the URL representing the topic with the given subject identifier.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
void	start(ModuleManager manager) Starts the module.

Methods inherited from class org.wandora.modules.topicmap.ViewTopicAction

getCacheKey, getCacheKeyParams, getDependencies, getStaticTemplateContext, getTemplateContext, getTopic, getTopics, handleAction, stop

Methods inherited from class org.wandora.modules.servlet.GenericTemplateAction

doOutput, getForwardedParameters, getTemplate, putStaticContext, returnOutput

Methods inherited from class org.wandora.modules.servlet.CachedAction

buildCacheKey, readMetadata, writeMetadata

Methods inherited from class org.wandora.modules.servlet.AbstractAction

addHandledAction, doReplacements, handleRequest, isHandleAction, setActionParamKey, setHttpHeaders

Methods inherited from class org.wandora.modules.ScriptModule

getScriptEngine

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.modules.Module

getDependencies, isInitialized, isRunning, stop

Field Detail

webAppName

protected java.lang.String webAppName

appStartPage

protected java.lang.String appStartPage

Constructor Detail

ViewTopicWebApp

public ViewTopicWebApp()

Method Detail

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class ViewTopicAction

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class ViewTopicAction

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

getAppName

public java.lang.String getAppName()

Description copied from interface: ModulesWebApp

Returns the name of the web app.

Specified by:

getAppName in interface ModulesWebApp

Returns:

The name of the web app.

getAppStartPage

public java.lang.String getAppStartPage()

Description copied from interface: ModulesWebApp

Returns the URL for the start page of the web app. If the web app doesn't have a meaningful start page, return null instead.

Specified by:

getAppStartPage in interface ModulesWebApp

Returns:

The start page of the web app.

getAppTopicPage

public java.lang.String getAppTopicPage(java.lang.String si)

Description copied from interface: ModulesWebApp

Returns the URL representing the topic with the given subject identifier. If there is no meaningful page for the topic, return null. This should not be dependent on whether the topic exists or not, the returned page should be the URL if the topic is assumed to exist.

Specified by:

getAppTopicPage in interface ModulesWebApp

Parameters:

si - The subject identifier of the topic.

Returns:

The URL of the page representing the topic.