org.wandora.application.modulesserver

Class SameAsService

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.SameAsService

All Implemented Interfaces:

ModulesWebApp, Module, ActionHandler, ServletModule.RequestListener

public class SameAsService
extends AbstractTopicWebApp

SameAsService implements a simple web service that returns all subject identifiers of a given topic. Given topic is recognized with a single subject identifier given in URL parameter.

The response format is similar to the JSON response format of the sameAs.org service. Thus, Wandora can be used as a part of LOD machinery, a web service returning similar URIs.

Wandora features a subject expander, SameAsAnywhereSubjectExpander, that can be used to retrieve subjects provided by the SameAsService.

Author:

akivela

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SameAsService.SameAs SameAs is a helper class to store the URL and all similar URLs.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	encodeJSON(java.lang.String string)
protected SameAsService.SameAs	getSameAs(java.lang.String u, Topic t)
boolean	handleAction(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, 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.
protected java.lang.String	makeJSON(SameAsService.SameAs sameas)
Topic	resolveTopic(java.lang.String query)

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

getDependencies, start, stop

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

Constructor Detail

SameAsService

public SameAsService()

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

handleAction

public boolean handleAction(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp,
                            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:

req - The HTTP Request.

resp - 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

resolveTopic

public Topic resolveTopic(java.lang.String query)

Overrides:

resolveTopic in class AbstractTopicWebApp

makeJSON

protected java.lang.String makeJSON(SameAsService.SameAs sameas)

getSameAs

protected SameAsService.SameAs getSameAs(java.lang.String u,
                                         Topic t)
                                  throws TopicMapException

Throws:

TopicMapException

encodeJSON

protected java.lang.String encodeJSON(java.lang.String string)