Package org.ametys.plugins.core.impl.schedule

Class AbstractConfigBasedHourRunnable

java.lang.Object

org.ametys.plugins.core.impl.schedule.StaticRunnable

org.ametys.plugins.core.impl.schedule.ConfigBasedRunnable

org.ametys.plugins.core.impl.schedule.AbstractConfigBasedHourRunnable

All Implemented Interfaces:

Runnable, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

ConfigBasedDailyRunnable, ConfigBasedWeeklyRunnable

public abstract class AbstractConfigBasedHourRunnable
extends ConfigBasedRunnable

Abstract Runnable for runnable that will run at the specified hour defined in config throught param 'param-hour'

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.schedule.Runnable

Runnable.FireProcess, Runnable.MisfirePolicy

Field Summary

Fields inherited from class org.ametys.plugins.core.impl.schedule.StaticRunnable

_cronExpression, _deactivatable, _description, _featureName, _fireProcess, _id, _label, _misfirePolicy, _modifiable, _parameterValues, _pluginName, _removable, _schedulableEP, _schedulableId

Constructor Summary

Constructors

Constructor	Description
AbstractConfigBasedHourRunnable()

Method Summary

Modifier and Type	Method	Description
protected void	configureFireProcess(Configuration configuration, DefaultConfiguration modifiedConfiguration)	Edit the runnable configuration based on the Config
protected abstract String	getCronExpression(Configuration configuration, LocalTime time)	Get the CRON expression for this runnable.

Methods inherited from class org.ametys.plugins.core.impl.schedule.ConfigBasedRunnable

configure, isEnabled

Methods inherited from class org.ametys.plugins.core.impl.schedule.StaticRunnable

_configureParameterValues, getCronExpression, getDescription, getFireProcess, getId, getLabel, getMisfirePolicy, getParameterValues, getSchedulableId, getUserIdentity, isDeactivatable, isModifiable, isRemovable, isVolatile, service, setPluginInfo

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractConfigBasedHourRunnable

public AbstractConfigBasedHourRunnable()

Method Details

configureFireProcess

protected void configureFireProcess(Configuration configuration,
 DefaultConfiguration modifiedConfiguration)
                             throws ConfigurationException

Description copied from class: ConfigBasedRunnable

Edit the runnable configuration based on the Config

Overrides:

configureFireProcess in class ConfigBasedRunnable

Parameters:

configuration - the original configuration

modifiedConfiguration - the edited configuration

Throws:

ConfigurationException - if configuration is invalid

getCronExpression

protected abstract String getCronExpression(Configuration configuration,
 LocalTime time)
                                     throws ConfigurationException

Get the CRON expression for this runnable. Use when "param-hour" is used.

Parameters:

configuration - the original configuration

time - The computed time, expressed in the server timezone

Returns:

the cron expression

Throws:

ConfigurationException - if configuration is invalid