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

Class StaticRunnable

java.lang.Object

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

All Implemented Interfaces:

Runnable, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

ConfigBasedDailyRunnable, ConfigBasedEveryNMinutesRunnable, InvalidateFOCacheRunnable, ReloadSolrAclCachesForCoresRunnable, SendNotificationSummaryRunnable

public class StaticRunnable
extends Object
implements Runnable, Component, Configurable, PluginAware, Serviceable

Static implementation of Runnable which is configurable

Nested Class Summary

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

Runnable.FireProcess, Runnable.MisfirePolicy

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_cronExpression	The CRON expression for scheduling the job
protected boolean	_deactivatable	Can the runnable be deactivated
protected I18nizableText	_description	The description
protected String	_featureName	The name of the feature that declared this component
protected Runnable.FireProcess	_fireProcess	The fire process
protected String	_id	The id of this extension
protected I18nizableText	_label	The label
protected Runnable.MisfirePolicy	_misfirePolicy	The misfire policy.
protected boolean	_modifiable	Can the runnable be edited
protected Map<String,Object>	_parameterValues	The parameter values
protected String	_pluginName	The name of the plugin that declared this component
protected boolean	_removable	Can the runnable be removed
protected SchedulableExtensionPoint	_schedulableEP	The extension point for Schedulables
protected String	_schedulableId	The id of the Schedulable to execute

Constructor Summary

Constructors

Constructor	Description
StaticRunnable()

Method Summary

Modifier and Type	Method	Description
protected void	_configureParameterValues(Configuration paramConfigs)	Configure the values of the parameters
void	configure(Configuration configuration)
String	getCronExpression()	Returns the cron expression to base the schedule on.
I18nizableText	getDescription()	Returns the description
Runnable.FireProcess	getFireProcess()	Gets the process of firing, i.e.
String	getId()	Returns the id
I18nizableText	getLabel()	Returns the label
Runnable.MisfirePolicy	getMisfirePolicy()	Gets the misfire policy, i.e.
Map<String,Object>	getParameterValues()	Gets the values of the parameters (from the linked Schedulable)
String	getSchedulableId()	Gets the identifier of Schedulable to execute
UserIdentity	getUserIdentity()	Gets the user which should be used to launch the runnable task.
boolean	isDeactivatable()	Determines if this runnable can be activate or deactivate
boolean	isModifiable()	Determines if this runnable can be modified
boolean	isRemovable()	Determines if this runnable can be removed
boolean	isVolatile()	Determines if the runnable must not survive to a server restart
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Field Details

_schedulableEP

protected SchedulableExtensionPoint _schedulableEP

The extension point for Schedulables

_pluginName

protected String _pluginName

The name of the plugin that declared this component

_featureName

protected String _featureName

The name of the feature that declared this component

_id

protected String _id

The id of this extension

_label

protected I18nizableText _label

The label

_description

protected I18nizableText _description

The description

_fireProcess

protected Runnable.FireProcess _fireProcess

The fire process

_cronExpression

protected String _cronExpression

The CRON expression for scheduling the job

_schedulableId

protected String _schedulableId

The id of the Schedulable to execute

_removable

protected boolean _removable

Can the runnable be removed

_modifiable

protected boolean _modifiable

Can the runnable be edited

_deactivatable

protected boolean _deactivatable

Can the runnable be deactivated

_misfirePolicy

protected Runnable.MisfirePolicy _misfirePolicy

The misfire policy. Default to MisfirePolicy#DO_NOTHING

_parameterValues

protected Map<String,Object> _parameterValues

The parameter values

Constructor Details

StaticRunnable

public StaticRunnable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: Runnable

Returns the id

Specified by:

getId in interface Runnable

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: Runnable

Returns the label

Specified by:

getLabel in interface Runnable

Returns:

the i18n label

getDescription

public I18nizableText getDescription()

Description copied from interface: Runnable

Returns the description

Specified by:

getDescription in interface Runnable

Returns:

the i18n description

getFireProcess

public Runnable.FireProcess getFireProcess()

Description copied from interface: Runnable

Gets the process of firing, i.e. the way the task will be scheduled (fire now, fire at next stratup, schedule it based on a cron expression...).

Specified by:

getFireProcess in interface Runnable

Returns:

the fire process

getCronExpression

public String getCronExpression()

Description copied from interface: Runnable

Returns the cron expression to base the schedule on. Ignored if Runnable.getFireProcess() is different from Runnable.FireProcess.CRON.

Specified by:

getCronExpression in interface Runnable

Returns:

the cron expression

getSchedulableId

public String getSchedulableId()

Description copied from interface: Runnable

Gets the identifier of Schedulable to execute

Specified by:

getSchedulableId in interface Runnable

Returns:

the identifier of Schedulable

isRemovable

public boolean isRemovable()

Description copied from interface: Runnable

Determines if this runnable can be removed

Specified by:

isRemovable in interface Runnable

Returns:

true if this runnable is removable

isModifiable

public boolean isModifiable()

Description copied from interface: Runnable

Determines if this runnable can be modified

Specified by:

isModifiable in interface Runnable

Returns:

true if this runnable is modifiable

isDeactivatable

public boolean isDeactivatable()

Description copied from interface: Runnable

Determines if this runnable can be activate or deactivate

Specified by:

isDeactivatable in interface Runnable

Returns:

true if this runnable is deactivatable

getMisfirePolicy

public Runnable.MisfirePolicy getMisfirePolicy()

Description copied from interface: Runnable

Gets the misfire policy, i.e. what the runnable must do if it missed a trigger. Ignored if Runnable.getFireProcess() is different from Runnable.FireProcess.CRON.

Specified by:

getMisfirePolicy in interface Runnable

Returns:

The misfire policy

isVolatile

public boolean isVolatile()

Description copied from interface: Runnable

Determines if the runnable must not survive to a server restart

Specified by:

isVolatile in interface Runnable

Returns:

true if the runnable must not survive to a server restart

getParameterValues

public Map<String,Object> getParameterValues()

Description copied from interface: Runnable

Gets the values of the parameters (from the linked Schedulable)

Specified by:

getParameterValues in interface Runnable

Returns:

the parameter values

_configureParameterValues

protected void _configureParameterValues(Configuration paramConfigs)
                                  throws ConfigurationException

Configure the values of the parameters

Parameters:

paramConfigs - the configurations of the parameter values

Throws:

ConfigurationException - if an error occurs

getUserIdentity

public UserIdentity getUserIdentity()

Description copied from interface: Runnable

Gets the user which should be used to launch the runnable task.

Specified by:

getUserIdentity in interface Runnable

Returns:

the UserIdentity of the user