Package org.ametys.plugins.extraction.execution

Class ExecuteExtractionSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.plugins.extraction.execution.ExecuteExtractionSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Initializable, Component, Configurable, Contextualizable, Serviceable

public class ExecuteExtractionSchedulable
extends AbstractSendingMailSchedulable

A Schedulable job which execute an extraction

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFINITION_FILE_PATH_KEY	The key for the extraction definition file
static final String	PIPELINE_KEY	The key for the pipeline
static final String	RECIPIENT_KEY	The key for the recipient
static final String	VARIABLES_KEY	The key for the variables values

Fields inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_currentUserProvider, _i18nUtils, _mailSender, _sysadminMail, _userHelper

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

_acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _startTime, _userLanguagesManager, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
ExecuteExtractionSchedulable()

Method Summary

Modifier and Type	Method	Description
void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected String	_getErrorMailBody(JobExecutionContext context, String language, Throwable throwable)	Retrieves the body of the error mail
protected I18nizableText	_getErrorMailSubject(JobExecutionContext context)	Retrieves the subject of the error mail
protected Optional<String>	_getRecipient(JobExecutionContext context)	Retrieves the optional recipient of the mail
protected String	_getRecipientLanguage(JobExecutionContext context)	Retrieves the language to use in the mail
protected String	_getSuccessMailBody(JobExecutionContext context, String language)	Retrieves the body of the success mail
protected I18nizableText	_getSuccessMailSubject(JobExecutionContext context)	Retrieves the subject of the success mail
protected boolean	_isMailBodyInHTML(JobExecutionContext context)	Determines if the mail body is in HTML
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_sendMail, execute, initialize

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

acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, getProgressionTracker, isPrivate, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

DEFINITION_FILE_PATH_KEY

public static final String DEFINITION_FILE_PATH_KEY

The key for the extraction definition file

See Also:

• Constant Field Values

VARIABLES_KEY

public static final String VARIABLES_KEY

The key for the variables values

See Also:

• Constant Field Values

RECIPIENT_KEY

public static final String RECIPIENT_KEY

The key for the recipient

See Also:

• Constant Field Values

PIPELINE_KEY

public static final String PIPELINE_KEY

The key for the pipeline

See Also:

• Constant Field Values

Constructor Details

ExecuteExtractionSchedulable

public ExecuteExtractionSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

_doExecute

public void _doExecute(JobExecutionContext context,
 ContainerProgressionTracker progressionTracker)
                throws Exception

Description copied from class: AbstractSendingMailSchedulable

Executes the schedulable.

Specified by:

_doExecute in class AbstractSendingMailSchedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_getRecipientLanguage

protected String _getRecipientLanguage(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the language to use in the mail

Overrides:

_getRecipientLanguage in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the language of the recipient or null if none was found

_getRecipient

protected Optional<String> _getRecipient(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the optional recipient of the mail

Overrides:

_getRecipient in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the optional recipient of the mail

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Determines if the mail body is in HTML

Overrides:

_isMailBodyInHTML in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

true if the mail body is in HTML, false otherwise

_getSuccessMailSubject

protected I18nizableText _getSuccessMailSubject(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the success mail

Specified by:

_getSuccessMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the success mail

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context,
 String language)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the success mail

Specified by:

_getSuccessMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

language - The language to use. Should not be null.

Returns:

the body of the success mail

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the error mail

Specified by:

_getErrorMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the error mail

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 String language,
 Throwable throwable)

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the error mail

Specified by:

_getErrorMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

language - The language to use. Should not be null.

throwable - the error

Returns:

the body of the error mail