org.ametys.plugins.extraction.execution

Class ExecuteExtractionRunnable

java.lang.Object

org.ametys.plugins.extraction.execution.ExecuteExtractionRunnable

All Implemented Interfaces:

Runnable

public class ExecuteExtractionRunnable
extends Object
implements Runnable

A Runnable which schedules a ExecuteExtractionSchedulable task for the given definition file.

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 and Description
private String	_definitionFilePath
private String	_pipeline
private String	_recipient
private String	_variables

Constructor Summary

Constructors

Constructor and Description
ExecuteExtractionRunnable(String definitionFilePath, String variables, String recipient, String pipeline) Constructor

Method Summary

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

_definitionFilePath

private String _definitionFilePath

_variables

private String _variables

_recipient

private String _recipient

_pipeline

private String _pipeline

Constructor Detail

ExecuteExtractionRunnable

public ExecuteExtractionRunnable(String definitionFilePath,
                                 String variables,
                                 String recipient,
                                 String pipeline)

Constructor

Parameters:

definitionFilePath - The extraction definition file path

variables - clauses variables and optional columns

recipient - An email will be sent at this address when the extraction is complete

pipeline - The pipeline id

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

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

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