org.wandora.modules.usercontrol

Class SourceRestrictedContext

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.servlet.GenericContext

org.wandora.modules.usercontrol.SourceRestrictedContext

All Implemented Interfaces:

Module, ActionHandler, ServletModule, ServletModule.RequestListener

public class SourceRestrictedContext
extends GenericContext

A context which restricts access to the source IP address. The allowed addresses are specified in the initialisation parameters using parameter names address and mask. The address specifies an IP address and mask a mask to use with the address. Any incoming request which matches the IP address where the mask bits are 1, are allowed access, all others are denied access. The default value for mask is 255.255.255.255, so if you only specify the IP address, only that single IP address will be allowed access. The default value for address is 127.0.0.1 for local access only.

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 int	address
protected int	mask

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

Method Summary

Modifier and Type	Method and Description
protected GenericContext.ForwardResult	doForwardRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ModulesServlet.HttpMethod method) Checks if a request should be forwarded to the registered listeners.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
static int	makeAddress(java.lang.String address)
static int	makeMask(java.lang.String mask)

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

addRequestListener, getContextPath, getDependencies, getHandlingAction, getServletURL, handleRequest, isHandleAction, removeRequestListener, start, stop

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

address

protected int address

mask

protected int mask

Constructor Detail

SourceRestrictedContext

public SourceRestrictedContext()

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 GenericContext

Parameters:

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

Throws:

ModuleException

makeAddress

public static int makeAddress(java.lang.String address)

makeMask

public static int makeMask(java.lang.String mask)

doForwardRequest

protected GenericContext.ForwardResult doForwardRequest(javax.servlet.http.HttpServletRequest req,
                                                        javax.servlet.http.HttpServletResponse resp,
                                                        ModulesServlet.HttpMethod method)
                                                 throws javax.servlet.ServletException,
                                                        java.io.IOException

Description copied from class: GenericContext

Checks if a request should be forwarded to the registered listeners. The return value is in the form of a ForwardResult object. This combines multiple things about how the request can be handled. See its documentation for more detail.

The default implementation simply returns new ForwardResult(true, false, null), thus forwarding all requests without any additional handling.

Overrides:

doForwardRequest in class GenericContext

Parameters:

req - The HTTP request.

resp - The HTTP response.

method - The HTTP method.

Returns:

A ForwardResult object indicating what to do, or what has been done, with the request.

Throws:

javax.servlet.ServletException

java.io.IOException