uk.ac.ed.epcc.webapp

Class CleanupService

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.CleanupService

All Implemented Interfaces:

AppContextCleanup, AppContextService<CleanupService>, Contexed

public class CleanupService
extends AbstractContexed
implements AppContextService<CleanupService>

A CleanupService implements deferred actions to be performed later (usually when the AppContext is closed. When running from a servlet this usually triggers the close to be performed in a background thread so as not to delay the browser.

Field Summary

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

conn

Constructor Summary

Constructors

Constructor and Description
CleanupService(AppContext conn)

Method Summary

Modifier and Type	Method and Description
void	action() action to be performed.
void	action(java.lang.Class template)
void	add(java.lang.Runnable r) Add a Runnable to the set of actions performed on cleanup.
void	cleanup() AppContext is being closed.
java.util.LinkedHashSet<java.lang.Runnable>	getActions()
java.lang.Class<? super CleanupService>	getType() Returns the type of service the class should be registered under.
boolean	hasActions()
void	reset()

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

CleanupService

public CleanupService(AppContext conn)

Method Detail

add

public void add(java.lang.Runnable r)

Add a Runnable to the set of actions performed on cleanup. The runnable object should implement Object.hashCode() and Object.equals(Object) so identical actions are not run twice. The class should also be annotated with PreRequisiteService if they use an AppContextService.

Parameters:

r -

cleanup

public final 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

action

public void action()

action to be performed.

action

public void action(java.lang.Class template)

hasActions

public boolean hasActions()

reset

public void reset()

getActions

public java.util.LinkedHashSet<java.lang.Runnable> getActions()

getType

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

Description copied from interface: AppContextService

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

Specified by:

getType in interface AppContextService<CleanupService>

Returns:

registration type