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

Class DefaultRunnable

java.lang.Object

org.ametys.plugins.core.impl.schedule.DefaultRunnable

All Implemented Interfaces:

Runnable

public class DefaultRunnable
extends Object
implements Runnable

Implementation of Runnable which can be created by the UI.

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	_cron	The CRON expression
protected boolean	_deactivatable	true if it can be deactivated
protected I18nizableText	_description	The description
protected Runnable.FireProcess	_fireProcess	The fire process
protected String	_id	The id
protected I18nizableText	_label	The label
protected Runnable.MisfirePolicy	_misfirePolicy	The misfire policy
protected boolean	_modifiable	true if it can be edited
protected Map<String,Object>	_parameterValues	The parameter values
protected boolean	_removable	true if it can be removed
protected String	_schedulableId	The id of the linked Schedulable
protected UserIdentity	_userIdentity	UserIdentity should be used to launch the Runnable
protected boolean	_volatile	true if volatile

Constructor Summary

Constructors

Constructor	Description
DefaultRunnable(String id, I18nizableText label, I18nizableText description, Runnable.FireProcess fireProcess, String cron, String schedulableId, boolean removable, boolean modifiable, boolean deactivatable, Runnable.MisfirePolicy misfirePolicy, boolean isVolatile, UserIdentity userIdentity, Map<String,Object> parameters)	Constructor

Method Summary

Modifier and Type	Method	Description
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

Methods inherited from class java.lang.Object

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

Field Detail

_id

protected String _id

The id

_label

protected I18nizableText _label

The label

_description

protected I18nizableText _description

The description

_fireProcess

protected Runnable.FireProcess _fireProcess

The fire process

_cron

protected String _cron

The CRON expression

_schedulableId

protected String _schedulableId

The id of the linked Schedulable

_removable

protected boolean _removable

true if it can be removed

_modifiable

protected boolean _modifiable

true if it can be edited

_deactivatable

protected boolean _deactivatable

true if it can be deactivated

_parameterValues

protected Map<String,Object> _parameterValues

The parameter values

_misfirePolicy

protected Runnable.MisfirePolicy _misfirePolicy

The misfire policy

_volatile

protected boolean _volatile

true if volatile

_userIdentity

protected UserIdentity _userIdentity

UserIdentity should be used to launch the Runnable

Constructor Detail

DefaultRunnable

public DefaultRunnable(String id,
                       I18nizableText label,
                       I18nizableText description,
                       Runnable.FireProcess fireProcess,
                       String cron,
                       String schedulableId,
                       boolean removable,
                       boolean modifiable,
                       boolean deactivatable,
                       Runnable.MisfirePolicy misfirePolicy,
                       boolean isVolatile,
                       UserIdentity userIdentity,
                       Map<String,Object> parameters)

Constructor

Parameters:

id - the id

label - the label

description - the descritpion

fireProcess - the fire process

cron - the cron expression

schedulableId - the id of the linked Schedulable

removable - true if it can be removed

modifiable - true if it can be edited

deactivatable - true if it can be deactivated

misfirePolicy - The misfire policy. Can be null, the default value is Runnable.MisfirePolicy.DO_NOTHING

isVolatile - true if it is volatile, i.e. if it must not survive to a server restart

userIdentity - The user used to launch the runnable task

parameters - the parameter values

Method Detail

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

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