sirius.kernel.timer

Interface EveryDay

All Superinterfaces:

TimedTask

All Known Implementing Classes:

CleanLogsTask

public interface EveryDay
extends TimedTask

Parts registered for this interface will be invoked one time per day.

An implementing class can be inserted into the GlobalContext using the Register annotation. Once the system is started, the method TimedTask.runTimer() is invoked once per day. The hour within the call will take place is determined by the config value named in getConfigKeyName(). (The full path in the config will be timer.daily.[getConfigKeyName]).

The call interval will not be exactly one day, as the time of invocation will vary from day to day. The system ensures, that the method is called within the given hour of day, and not executed more than once per day. However, if the system is restarted within the given hour, the method might be called twice, as the time of call is not persisted over restarts. If a more precise behaviour is required, the subclass must take care of handling such cases.

Method Summary

Modifier and Type	Method and Description
String	getConfigKeyName() Returns the name of the config key, which stores the hour of execution.

Methods inherited from interface sirius.kernel.timer.TimedTask

runTimer

Method Detail

getConfigKeyName

String getConfigKeyName()

Returns the name of the config key, which stores the hour of execution.

Returns:

the config key to determine the hour if execution