org.wandora.modules.usercontrol

Class AbstractControlledContext

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.servlet.GenericContext

org.wandora.modules.usercontrol.AbstractControlledContext

All Implemented Interfaces:

Module, ActionHandler, ServletModule, ServletModule.RequestListener

Direct Known Subclasses:

FrequencyRestrictedContext, RoleRestrictedContext

public abstract class AbstractControlledContext
extends GenericContext

Author:

olli

Nested Class Summary

Nested classes/interfaces inherited from class org.wandora.modules.servlet.GenericContext

GenericContext.ForwardResult

Nested classes/interfaces inherited from interface org.wandora.modules.servlet.ServletModule

ServletModule.RequestListener

Field Summary

Fields

Modifier and Type	Field and Description
protected UserAuthenticator	authenticator

Fields inherited from class org.wandora.modules.servlet.GenericContext

authenticationErrorMessage, checkActions, contextPath, exceptionHandler, exceptionOnAuthentication, requestListeners, servlet, urlPrefix

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
AbstractControlledContext()

Method Summary

Modifier and Type	Method and Description
protected UserAuthenticator.AuthenticationResult	authenticate(java.lang.String requiredRole, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ModulesServlet.HttpMethod method)
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

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

addRequestListener, doForwardRequest, getContextPath, getHandlingAction, getServletURL, handleRequest, init, isHandleAction, removeRequestListener

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

authenticator

protected UserAuthenticator authenticator

Constructor Detail

AbstractControlledContext

public AbstractControlledContext()

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 GenericContext

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 GenericContext

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 GenericContext

Parameters:

manager - The module manager handling this module.

authenticate

protected UserAuthenticator.AuthenticationResult authenticate(java.lang.String requiredRole,
                                                              javax.servlet.http.HttpServletRequest req,
                                                              javax.servlet.http.HttpServletResponse resp,
                                                              ModulesServlet.HttpMethod method)
                                                       throws java.io.IOException,
                                                              AuthenticationException

Throws:

java.io.IOException

AuthenticationException