org.wandora.application.modulesserver

Class WaianaService

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.servlet.AbstractAction

org.wandora.application.modulesserver.AbstractWebApp

org.wandora.application.modulesserver.AbstractTopicWebApp

org.wandora.application.modulesserver.WaianaService

All Implemented Interfaces:

ModulesWebApp, Module, ActionHandler, ServletModule.RequestListener

public class WaianaService
extends AbstractTopicWebApp

WaianaService implements an API used to store and retrieve topic maps via JSON fragments submitted over HTTP. The service stores topic maps as XTM files into the directory of service. The API mimics Maiana API (http://projects.topicmapslab.de/projects/maiana/wiki/API_Controller) created in Topic Maps Labs (http://www.topicmapslab.de/).

Wandora features separate import and export tools that use original Maiana API, that can be used to import and export topic maps into Waiana too. These import and export tools locate in the org.wandora.application.tools.maiana package.

Author:

akivela

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WaianaService.WaianaAPIRequestUtils
class	WaianaService.WaianaStorage

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowURLParameterUsage
protected static java.text.DateFormat	df
private WaianaService.WaianaStorage	storage

Fields inherited from class org.wandora.application.modulesserver.AbstractTopicWebApp

tmManager

Fields inherited from class org.wandora.application.modulesserver.AbstractWebApp

appStartPage, topicRequestKey, webAppName

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
WaianaService()

Method Summary

Modifier and Type	Method and Description
protected static org.json.JSONObject	createReply(int code, java.lang.String msg)
protected static org.json.JSONObject	createReply(int code, java.lang.String msg, java.lang.String data)
protected static java.lang.String	getDateString()
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
protected org.json.JSONObject	getRequestJSON(javax.servlet.http.HttpServletRequest request)
boolean	handleAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ModulesServlet.HttpMethod _method, java.lang.String _action, User user) Handles this action.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
(package private) static java.lang.String	readFile(java.lang.String path)
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.
protected static void	writeFile(java.lang.String fname, java.lang.String data)
protected static void	writeStringToResponse(javax.servlet.http.HttpServletResponse response, java.lang.String str)

Methods inherited from class org.wandora.application.modulesserver.AbstractTopicWebApp

resolveTopic

Methods inherited from class org.wandora.application.modulesserver.AbstractWebApp

getAppName, getAppStartPage, getAppTopicPage

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

isInitialized, isRunning

Field Detail

storage

private WaianaService.WaianaStorage storage

allowURLParameterUsage

private boolean allowURLParameterUsage

df

protected static java.text.DateFormat df

Constructor Detail

WaianaService

public WaianaService()

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 AbstractWebApp

Parameters:

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

Throws:

ModuleException

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class AbstractTopicWebApp

Parameters:

manager - The module manager handling this module.

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 AbstractTopicWebApp

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class AbstractTopicWebApp

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

handleAction

public boolean handleAction(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            ModulesServlet.HttpMethod _method,
                            java.lang.String _action,
                            User user)
                     throws javax.servlet.ServletException,
                            java.io.IOException,
                            ActionException

Description copied from class: AbstractAction

Handles this action. Prior to calling this action, it's already been determined that this action should try to handle the action by either matching the action request parameter with the action id of this action, or this being the default action. Perform any operations needed here and then write the response into the response object. You will typically want to call setHttpHeaders to set the HTTP headers in the response after you know that you definitely will handle the request but before you write anything else into the response stream. If for whatever reason this method shouldn't handle the request after all, return false. Otherwise return true.

Specified by:

handleAction in class AbstractAction

Parameters:

request - The HTTP Request.

response - The HTTP response.

_method - The HTTP method of the request.

_action - The parsed action id.

user - The logged in user, or null if not applicable.

Returns:

True if the action was handled and a response sent. False otherwise in which case other actions may try to handle this action.

Throws:

javax.servlet.ServletException

java.io.IOException

ActionException

getRequestJSON

protected org.json.JSONObject getRequestJSON(javax.servlet.http.HttpServletRequest request)
                                      throws java.io.IOException

Throws:

java.io.IOException

createReply

protected static org.json.JSONObject createReply(int code,
                                                 java.lang.String msg,
                                                 java.lang.String data)

createReply

protected static org.json.JSONObject createReply(int code,
                                                 java.lang.String msg)

getDateString

protected static java.lang.String getDateString()

writeStringToResponse

protected static void writeStringToResponse(javax.servlet.http.HttpServletResponse response,
                                            java.lang.String str)

writeFile

protected static void writeFile(java.lang.String fname,
                                java.lang.String data)
                         throws java.io.IOException

Throws:

java.io.IOException

readFile

static java.lang.String readFile(java.lang.String path)
                          throws java.io.IOException

Throws:

java.io.IOException