com.peterphi.std.guice.common.daemon

Class GuiceRecurringDaemon

java.lang.Object

com.peterphi.std.threading.Daemon

com.peterphi.std.guice.common.daemon.GuiceDaemon

com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon

All Implemented Interfaces:

GuiceLifecycleListener, StoppableService, java.lang.Runnable

public abstract class GuiceRecurringDaemon
extends GuiceDaemon

Field Summary

Fields

Modifier and Type	Field and Description
protected Timeout	sleepTime

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GuiceRecurringDaemon(boolean daemonThread, Timeout sleepTime) Creates a new Daemon; the Daemon will start once the guice object is fully constructed
protected	GuiceRecurringDaemon(Timeout sleepTime) Creates a new Daemon; the Daemon will start once the guice object is fully constructed

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	execute() Run one iteration of the daemon
protected void	executeException(java.lang.Throwable t) Called when the execute() method throws an exception.
void	postConstruct() Called after Guice has fully and successfully constructed this object
void	run()

Methods inherited from class com.peterphi.std.guice.common.daemon.GuiceDaemon

shouldStartAsDaemon, shutdown, sleep, sleep

Methods inherited from class com.peterphi.std.threading.Daemon

interrupt, isRunning, isThreadRunning, startThread, startThread, stopAll, stopThread, waitForTermination, waitForTermination

Methods inherited from class java.lang.Object

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

Field Detail

sleepTime

protected Timeout sleepTime

Constructor Detail

GuiceRecurringDaemon

protected GuiceRecurringDaemon(Timeout sleepTime)

Creates a new Daemon; the Daemon will start once the guice object is fully constructed

Parameters:

sleepTime - the amount of time to sleep between calls to the execute() method

GuiceRecurringDaemon

protected GuiceRecurringDaemon(boolean daemonThread,
                    Timeout sleepTime)

Creates a new Daemon; the Daemon will start once the guice object is fully constructed

Parameters:

daemonThread - true if the thread should be started as a daemon thread, otherwise false

sleepTime - the amount of time to sleep between calls to the execute() method

Method Detail

run

public void run()

executeException

protected void executeException(java.lang.Throwable t)

Called when the execute() method throws an exception. This method can be overridden by subclasses to record exception details or to take remedial action. By default it will log the exception at the ERROR level.

Note: Any exception thrown by this method will cause the thread to terminate

Parameters:

t - the exception that was caught

execute

protected abstract void execute()
                         throws java.lang.Exception

Run one iteration of the daemon

Throws:

java.lang.Exception - if an exception occurs (the exception will be passed to executeException(Throwable) but otherwise ignored)

postConstruct

public void postConstruct()

Description copied from interface: GuiceLifecycleListener

Called after Guice has fully and successfully constructed this object

Specified by:

postConstruct in interface GuiceLifecycleListener

Overrides:

postConstruct in class GuiceDaemon