sirius.kernel.timer

Class Timers

java.lang.Object

sirius.kernel.timer.Timers

All Implemented Interfaces:

Priorized, Startable, Stoppable

public class Timers
extends Object
implements Startable, Stoppable

Internal service which is responsible for executing timers.

Other than for statistical reasons, this class does not need to be called directly. It automatically discovers all parts registered for one of the timer interfaces (EveryMinute, EveryTenMinutes, EveryHour, EveryDay) and invokes them appropriately.

To access this class, a Part annotation can be used on a field of type TimerService.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LIFECYCLE_PRIORITY Determines the start and stop order of the timers lifecycle.
protected static Log	LOG
static String	TIMER_DAILY_PREFIX Contains the config prefix to load settings for daily tasks from.

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Timers()

Method Summary

Modifier and Type	Method and Description
void	addWatchedResource(URL url, Runnable callback) Adds the given file to the list of watched resources in DEVELOP mode (Sirius.isDev().
Collection<EveryDay>	getDailyTasks() Returns all known daily tasks.
String	getLastHourExecution() Returns the timestamp of the last execution of the one hour timer.
String	getLastOneMinuteExecution() Returns the timestamp of the last execution of the one minute timer.
String	getLastTenMinutesExecution() Returns the timestamp of the last execution of the ten minutes timer.
String	getLastTenSecondsExecution() Returns the timestamp of the last execution of the 10 second timer.
int	getPriority() Returns the priority of this element.
void	rundailyTimer(int currentHour, EveryDay task) Executes the given task if it is scheduled for the given hour.
void	runEveryDayTimers(int currentHour) Executes all daily timers (implementing EveryDay) if applicable, or if outOfASchedule is true.
void	runOneHourTimers() Executes all one hour timers (implementing EveryHour) now (out of schedule).
void	runOneMinuteTimers() Executes all one minute timers (implementing EveryMinute) now (out of schedule).
void	runTenMinuteTimers() Executes all ten minutes timers (implementing EveryTenMinutes) now (out of schedule).
void	runTenSecondTimers() Executes all one minute timers (implementing EveryTenSeconds) now (out of schedule).
void	started() Invoked when the framework starts up.
void	stopped() Invoked when the framework shuts down.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

TIMER_DAILY_PREFIX

public static final String TIMER_DAILY_PREFIX

Contains the config prefix to load settings for daily tasks from.

See Also:

Constant Field Values

LIFECYCLE_PRIORITY

public static final int LIFECYCLE_PRIORITY

Determines the start and stop order of the timers lifecycle. Exposed as public so that dependent lifecycles can determine their own priority based on this.

See Also:

Constant Field Values

Constructor Detail

Timers

public Timers()

Method Detail

getPriority

public int getPriority()

Description copied from interface: Priorized

Returns the priority of this element.

Specified by:

getPriority in interface Priorized

Specified by:

getPriority in interface Startable

Specified by:

getPriority in interface Stoppable

Returns:

the priority - lower is better (comes first)

getLastTenSecondsExecution

public String getLastTenSecondsExecution()

Returns the timestamp of the last execution of the 10 second timer.

Returns:

a textual representation of the last execution of the ten seconds timer. Returns "-" if the timer didn't run yet.

getLastOneMinuteExecution

public String getLastOneMinuteExecution()

Returns the timestamp of the last execution of the one minute timer.

Returns:

a textual representation of the last execution of the one minute timer. Returns "-" if the timer didn't run yet.

getLastTenMinutesExecution

public String getLastTenMinutesExecution()

Returns the timestamp of the last execution of the ten minutes timer.

Returns:

a textual representation of the last execution of the ten minutes timer. Returns "-" if the timer didn't run yet.

getLastHourExecution

public String getLastHourExecution()

Returns the timestamp of the last execution of the one hour timer.

Returns:

a textual representation of the last execution of the one hour timer. Returns "-" if the timer didn't run yet.

started

public void started()

Description copied from interface: Startable

Invoked when the framework starts up.

Specified by:

started in interface Startable

stopped

public void stopped()

Description copied from interface: Stoppable

Invoked when the framework shuts down.

This method must not block (and wait for internals to stop). This can be done in Killable.awaitTermination().

Specified by:

stopped in interface Stoppable

addWatchedResource

public void addWatchedResource(@Nonnull
                               URL url,
                               @Nonnull
                               Runnable callback)

Adds the given file to the list of watched resources in DEVELOP mode (Sirius.isDev().

This is used to reload files like properties in development environments. In production systems, no reloading will be performed.

Parameters:

url - the file to watch

callback - the callback to invoke once the file has changed

runTenSecondTimers

public void runTenSecondTimers()

Executes all one minute timers (implementing EveryTenSeconds) now (out of schedule).

runOneMinuteTimers

public void runOneMinuteTimers()

Executes all one minute timers (implementing EveryMinute) now (out of schedule).

runTenMinuteTimers

public void runTenMinuteTimers()

Executes all ten minutes timers (implementing EveryTenMinutes) now (out of schedule).

runOneHourTimers

public void runOneHourTimers()

Executes all one hour timers (implementing EveryHour) now (out of schedule).

runEveryDayTimers

public void runEveryDayTimers(int currentHour)

Executes all daily timers (implementing EveryDay) if applicable, or if outOfASchedule is true.

Parameters:

currentHour - determines the current hour. Most probably this will be wall-clock time. However, for out-of-schedule eecution, this can be set to any value.

getDailyTasks

public Collection<EveryDay> getDailyTasks()

Returns all known daily tasks.

Returns:

a collection of all known daily tasks

rundailyTimer

public void rundailyTimer(int currentHour,
                          EveryDay task)

Executes the given task if it is scheduled for the given hour.

Parameters:

currentHour - the hour to pretend

task - the task to execute