org.wandora.modules.usercontrol

Class UserManagerAction

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.usercontrol.UserManagerAction

All Implemented Interfaces:

Module, ActionHandler, ServletModule.RequestListener

public class UserManagerAction
extends GenericTemplateAction

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 ModifyableUserStore	userStore

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

Method Summary

Modifier and Type	Method and Description
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.
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
protected java.util.HashMap<java.lang.String,java.lang.Object>	getTemplateContext(Template template, javax.servlet.http.HttpServletRequest req, ModulesServlet.HttpMethod method, java.lang.String action, User user) Gets the template context used for a request.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

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

doOutput, getCacheKeyParams, getForwardedParameters, getStaticTemplateContext, getTemplate, putStaticContext, returnOutput

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

userStore

protected ModifyableUserStore userStore

Constructor Detail

UserManagerAction

public UserManagerAction()

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 GenericTemplateAction

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

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.

Overrides:

getCacheKey in class GenericTemplateAction

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.

getTemplateContext

protected java.util.HashMap<java.lang.String,java.lang.Object> getTemplateContext(Template template,
                                                                                  javax.servlet.http.HttpServletRequest req,
                                                                                  ModulesServlet.HttpMethod method,
                                                                                  java.lang.String action,
                                                                                  User user)
                                                                           throws ActionException

Description copied from class: GenericTemplateAction

Gets the template context used for a request. Contains the static context as well forwarded request parameters. The static context contains both action specific context items and the template manager default context. In addition, the logged in user, if applicable, is added with the variable name user. Usually you don't want anything user specific cached so as a safety measure, the user variable is not added if caching is turned on. If you for some reason do, you will have to override this method.

This should be the main overriding point for extending classes. You can perform any tasks needed and then add things in the context. Often you don't need to override anything else besides this and the basic Module methods.

Overrides:

getTemplateContext in class GenericTemplateAction

Parameters:

template - The template to be used.

req - The HTTP request.

method - The method of the HTTP request.

action - The action parameter parsed from the HTTP request.

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

Returns:

The template context used with processing the template for this action.

Throws:

ActionException

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 GenericTemplateAction

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 GenericTemplateAction

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 GenericTemplateAction

Parameters:

manager - The module manager handling this module.