org.wandora.modules.usercontrol

Class FrequencyRestrictedContext

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.servlet.GenericContext

org.wandora.modules.usercontrol.AbstractControlledContext

org.wandora.modules.usercontrol.FrequencyRestrictedContext

All Implemented Interfaces:

Module, ActionHandler, ServletModule, ServletModule.RequestListener

public class FrequencyRestrictedContext
extends AbstractControlledContext

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrequencyRestrictedContext.Keys

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
private java.lang.String	keyPrefix
private static java.lang.String	postfixCurrentTime
private static java.lang.String	postfixCurrentValue
private java.lang.String	requiredRole

Fields inherited from class org.wandora.modules.usercontrol.AbstractControlledContext

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

Method Summary

Modifier and Type	Method and Description
private static boolean	_access(User user, long time, boolean update, java.lang.String prefix)
static boolean	access(User user, long time, java.lang.String prefix)
static boolean	access(User user, java.lang.String prefix)
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.
private static long[]	getCurrent(User user, FrequencyRestrictedContext.Keys key, long time, java.lang.String prefix)
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
static boolean	isAccessAllowed(User user, long time, java.lang.String prefix)
static boolean	isAccessAllowed(User user, java.lang.String prefix)

Methods inherited from class org.wandora.modules.usercontrol.AbstractControlledContext

authenticate, getDependencies, start, stop

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

addRequestListener, getContextPath, getHandlingAction, getServletURL, handleRequest, 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

keyPrefix

private java.lang.String keyPrefix

postfixCurrentTime

private static java.lang.String postfixCurrentTime

postfixCurrentValue

private static java.lang.String postfixCurrentValue

requiredRole

private java.lang.String requiredRole

Constructor Detail

FrequencyRestrictedContext

public FrequencyRestrictedContext()

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

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,
                                                        ActionException

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

ActionException

getCurrent

private static long[] getCurrent(User user,
                                 FrequencyRestrictedContext.Keys key,
                                 long time,
                                 java.lang.String prefix)

_access

private static boolean _access(User user,
                               long time,
                               boolean update,
                               java.lang.String prefix)
                        throws UserStoreException

Throws:

UserStoreException

isAccessAllowed

public static boolean isAccessAllowed(User user,
                                      java.lang.String prefix)
                               throws UserStoreException

Throws:

UserStoreException

isAccessAllowed

public static boolean isAccessAllowed(User user,
                                      long time,
                                      java.lang.String prefix)
                               throws UserStoreException

Throws:

UserStoreException

access

public static boolean access(User user,
                             java.lang.String prefix)
                      throws UserStoreException

Throws:

UserStoreException

access

public static boolean access(User user,
                             long time,
                             java.lang.String prefix)
                      throws UserStoreException

Throws:

UserStoreException