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

Class ConfigBasedRunnable

java.lang.Object

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

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

All Implemented Interfaces:

Runnable, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

AbstractConfigBasedHourRunnable, ConfigBasedEveryNMinutesRunnable

public class ConfigBasedRunnable
extends StaticRunnable

This Runnable is launched if enabled in config (by the param defined by param-enabled) or always launched if there is no param 'param-enabled'.

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
ConfigBasedRunnable()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected void	configureFireProcess(Configuration configuration, DefaultConfiguration modifiedConfiguration)	Edit the runnable configuration based on the Config
protected boolean	isEnabled(Configuration configuration)	Check if the Runnable should be enabled

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

ConfigBasedRunnable

public ConfigBasedRunnable()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticRunnable

Throws:

ConfigurationException

isEnabled

protected boolean isEnabled(Configuration configuration)

Check if the Runnable should be enabled

Parameters:

configuration - the configuration

Returns:

true if the Runnable is enabled

configureFireProcess

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

Edit the runnable configuration based on the Config

Parameters:

configuration - the original configuration

modifiedConfiguration - the edited configuration

Throws:

ConfigurationException - if configuration is invalid