org.wandora.modules.fng

Class FNGAPIAction

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.servlet.AbstractAction

org.wandora.modules.servlet.CachedAction

org.wandora.modules.fng.FNGAPIAction

All Implemented Interfaces:

Module, ActionHandler, ServletModule.RequestListener

Direct Known Subclasses:

FNGAPIWebApp

public class FNGAPIAction
extends CachedAction

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	ACQUISITION_SI
protected java.lang.String	ARTIST_SI
protected java.lang.String	ARTWORK_PARTIAL_SI
protected java.lang.String	ARTWORK_SI
protected java.lang.String	AUTHOR_SI
protected java.lang.String	BIRTH_SI
protected java.lang.String	COLLECTION_SI
protected java.lang.String	dataHandlerClassName
protected java.lang.String	DEATH_SI
protected java.lang.String	defaultOutputMode
protected java.lang.String	IS_IDENTIFIED_BY_ROLE1_SI
protected java.lang.String	IS_IDENTIFIED_BY_SI
protected java.lang.String	KEYWORD_SI
protected java.lang.String	LOCATION_SI
protected int	maxTopics
protected java.lang.String	outputModeParamKey
protected java.lang.String	PERSON_SI
protected java.lang.String	TECHNIQUE_SI
protected java.lang.String	TIME_SI
protected TopicMapManager	tmManager
protected java.lang.String	topicParamKey

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

Method Summary

Modifier and Type	Method and Description
protected boolean	doOutput(javax.servlet.http.HttpServletRequest req, ModulesServlet.HttpMethod method, java.lang.String action, CachedAction.OutputProvider out, User user) Does the output that might be either cached or returned directly.
protected java.lang.String	getCacheKey(javax.servlet.http.HttpServletRequest req, ModulesServlet.HttpMethod method, java.lang.String action) Should return a string that uniquely identifies this request.
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCacheKeyParams(javax.servlet.http.HttpServletRequest req, ModulesServlet.HttpMethod method, java.lang.String action)
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
protected java.lang.String	outputTopics(java.lang.String query, java.lang.String outputMode, TopicMap tm)
protected void	returnOutput(java.io.InputStream cacheIn, javax.servlet.http.HttpServletResponse resp) Writes a page read from an input stream into an HTTP servlet response.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.
protected void	trimLastComma(java.lang.StringBuilder sb)

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

buildCacheKey, handleAction, 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

Field Detail

ARTIST_SI

protected java.lang.String ARTIST_SI

ARTWORK_SI

protected java.lang.String ARTWORK_SI

ARTWORK_PARTIAL_SI

protected java.lang.String ARTWORK_PARTIAL_SI

COLLECTION_SI

protected java.lang.String COLLECTION_SI

AUTHOR_SI

protected java.lang.String AUTHOR_SI

KEYWORD_SI

protected java.lang.String KEYWORD_SI

TIME_SI

protected java.lang.String TIME_SI

IS_IDENTIFIED_BY_SI

protected java.lang.String IS_IDENTIFIED_BY_SI

IS_IDENTIFIED_BY_ROLE1_SI

protected java.lang.String IS_IDENTIFIED_BY_ROLE1_SI

BIRTH_SI

protected java.lang.String BIRTH_SI

DEATH_SI

protected java.lang.String DEATH_SI

PERSON_SI

protected java.lang.String PERSON_SI

LOCATION_SI

protected java.lang.String LOCATION_SI

ACQUISITION_SI

protected java.lang.String ACQUISITION_SI

TECHNIQUE_SI

protected java.lang.String TECHNIQUE_SI

outputModeParamKey

protected java.lang.String outputModeParamKey

defaultOutputMode

protected java.lang.String defaultOutputMode

topicParamKey

protected java.lang.String topicParamKey

tmManager

protected TopicMapManager tmManager

maxTopics

protected int maxTopics

dataHandlerClassName

protected java.lang.String dataHandlerClassName

Constructor Detail

FNGAPIAction

public FNGAPIAction()

Method Detail

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 CachedAction

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

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 CachedAction

Parameters:

manager - The module manager handling this module.

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 CachedAction

Parameters:

manager - The module manager handling this module.

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 CachedAction

Parameters:

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

Throws:

ModuleException

returnOutput

protected void returnOutput(java.io.InputStream cacheIn,
                            javax.servlet.http.HttpServletResponse resp)
                     throws java.io.IOException

Description copied from class: CachedAction

Writes a page read from an input stream into an HTTP servlet response. The input stream might be coming from a cached file, or directly from the doOutput method if caching is not in use. In any case, the contents of it need to be written to the response object. Note that any HTTP headers must be set before writing anything else.

If you used writeMetadata in doOutput, you have to override this method and use readMetadata correspondingly to read the metadata from the start of the stream. You can then, for example, set any HTTP headers you read from the metadata. After this, you can call this super implementation which will do the rest of the stream copying.

Make absolutely certain that the input stream is closed before returning from this method. Failing to do so may cause the caching service to become locked which can then lock the whole application. It is best to put the contents in a try-finally block and then call cacheIn.close in the finally part. Do this even if you call the super implementation as your code could possibly fail before reaching that part.

Overrides:

returnOutput in class CachedAction

Throws:

java.io.IOException

outputTopics

protected java.lang.String outputTopics(java.lang.String query,
                                        java.lang.String outputMode,
                                        TopicMap tm)
                                 throws TopicMapException,
                                        ActionException

Throws:

TopicMapException

ActionException

doOutput

protected boolean doOutput(javax.servlet.http.HttpServletRequest req,
                           ModulesServlet.HttpMethod method,
                           java.lang.String action,
                           CachedAction.OutputProvider out,
                           User user)
                    throws javax.servlet.ServletException,
                           java.io.IOException,
                           ActionException

Description copied from class: CachedAction

Does the output that might be either cached or returned directly. The OutputProvider is used to get the output stream where the output should be written. Before you get this stream, you may abort the action by returning false but after the output stream is retrieved, you are committed to outputting the page that then might be cached for future use. Therefore you should do all the preparations first, and only then get the output stream when you know that you will be able to output something sensible.

If you opened the output stream using the output provider, you must make sure that the stream is properly closed. It is best to place all your code after this in a try-finally block and close the stream in the finally part. Failing to do this may cause the caching service to become locked, which in turn could potentially lock the whole application.

Specified by:

doOutput in class CachedAction

Throws:

javax.servlet.ServletException

java.io.IOException

ActionException

getCacheKeyParams

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> getCacheKeyParams(javax.servlet.http.HttpServletRequest req,
                                                                                       ModulesServlet.HttpMethod method,
                                                                                       java.lang.String action)
                                                                                throws ActionException

Throws:

ActionException

getCacheKey

protected java.lang.String getCacheKey(javax.servlet.http.HttpServletRequest req,
                                       ModulesServlet.HttpMethod method,
                                       java.lang.String action)

Description copied from class: CachedAction

Should return a string that uniquely identifies this request. A future request with the same cache key may use the cached copy of the page. If you don't want some requests cached at all, return a null cache key for those pages. You can use the buildCacheKey method to create a cache key out of a map.

Specified by:

getCacheKey in class CachedAction

Parameters:

req - The HTTP request which, result of which is to be cached.

method - The method of the HTTP request.

action - The parsed action parameter from the request.

Returns:

A cache key that uniquely identifies the results of this request being processed.

trimLastComma

protected void trimLastComma(java.lang.StringBuilder sb)