uk.ac.ed.epcc.webapp.limits

Class LimitService

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.limits.LimitService

All Implemented Interfaces:

AppContextCleanup, AppContextService<LimitService>, Contexed

Direct Known Subclasses:

DefaultLimitService

public abstract class LimitService
extends AbstractContexed
implements AppContextService<LimitService>

A AppContextService that can be used to poll for high resource usage in a request and throw an exception to terminate the request. The application code needs to explicitly

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
LimitService(AppContext conn)

Method Summary

Modifier and Type	Method and Description
abstract void	checkLimit() Estimate the resources used by this request and throw a LimitException if these exceed a reasonable value for an interactive page.
void	cleanup() AppContext is being closed.
java.lang.Class<? super LimitService>	getType() Returns the type of service the class should be registered under.

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LimitService

public LimitService(AppContext conn)

Method Detail

checkLimit

public abstract void checkLimit()
                         throws LimitException

Estimate the resources used by this request and throw a LimitException if these exceed a reasonable value for an interactive page. In practice this will be the time since the start of the request and the increase of global memory consumption since the start of the request

Throws:

LimitException

cleanup

public void cleanup()

Description copied from interface: AppContextCleanup

AppContext is being closed. Only use this for cleanup that can't be handled by normal garbage collection or for state which is never returned by reference.

Specified by:

cleanup in interface AppContextCleanup

getType

public final java.lang.Class<? super LimitService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<LimitService>

Returns:

registration type