org.wandora.modules.servlet

Class StaticContentAction

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.servlet.AbstractAction

org.wandora.modules.servlet.StaticContentAction

All Implemented Interfaces:

Module, ActionHandler, ServletModule.RequestListener

public class StaticContentAction
extends AbstractAction

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.util.regex.Pattern>	forbidden
private org.eclipse.jetty.http.MimeTypes	mimeTypes
protected java.lang.String	mountPoint
protected java.lang.String	urlPrefix

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

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
protected java.lang.String	getLocalPath(javax.servlet.http.HttpServletRequest req)
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.
boolean	isHandleAction(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ModulesServlet.HttpMethod method) Checks if this action handler will try to handle the given action without handling it yet or causing any side effects.
protected boolean	returnFile(javax.servlet.http.HttpServletResponse response, java.io.File f)

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

addHandledAction, doReplacements, handleRequest, setActionParamKey, setHttpHeaders, start, stop

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

mountPoint

protected java.lang.String mountPoint

forbidden

protected java.util.ArrayList<java.util.regex.Pattern> forbidden

urlPrefix

protected java.lang.String urlPrefix

mimeTypes

private org.eclipse.jetty.http.MimeTypes mimeTypes

Constructor Detail

StaticContentAction

public StaticContentAction()

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 AbstractAction

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

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 AbstractAction

Parameters:

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

Throws:

ModuleException

getLocalPath

protected java.lang.String getLocalPath(javax.servlet.http.HttpServletRequest req)

returnFile

protected boolean returnFile(javax.servlet.http.HttpServletResponse response,
                             java.io.File f)
                      throws java.io.IOException

Throws:

java.io.IOException

isHandleAction

public boolean isHandleAction(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              ModulesServlet.HttpMethod method)

Description copied from interface: ActionHandler

Checks if this action handler will try to handle the given action without handling it yet or causing any side effects. Returning true means that the action handler will try to handle it, not necessarily that the action will succeed. You may also return false from the handleRequest method even if you return true here. The return value should be your best guess as to whether you will handle it without spending too much time checking.

Specified by:

isHandleAction in interface ActionHandler

Overrides:

isHandleAction in class AbstractAction

Parameters:

req - The HTTP request.

resp - The HTTP response.

method - The HTTP method of the request.

Returns:

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