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
`private static String`	`__JOBDATAMAP_DEFINITION_FILE_PATH_KEY`
`private static String`	`__JOBDATAMAP_PIPELINE_KEY`
`private static String`	`__JOBDATAMAP_RECIPIENT_KEY`
`private static String`	`__JOBDATAMAP_VARIABLES_KEY`
`private static String`	`__RESULT_FILE_PATHS`
`private ExtractionExecutor`	`_extractionExecutor`
`private JSONUtils`	`_jsonUtils`
`private PipelineManager`	`_pipelineManager`
`static String`	`DEFINITION_FILE_PATH_KEY`	The key for the extraction definition file
`static String`	`PIPELINE_KEY`	The key for the pipeline
`static String`	`RECIPIENT_KEY`	The key for the recipient
`private static DateTimeFormatter`	`RESULT_FILE_NAME_DATE_TIME_FORMATTER`
`static 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, _userManager

Constructor Summary

Constructors
Constructor Description

ExecuteExtractionSchedulable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`_doExecute(JobExecutionContext context)`	Executes the schedulable.
`private String`	`_getDefaultResultFileName(String definitionFilePath, PipelineDescriptor pipeline)`
`private String`	`_getDefinitionFilePath(JobExecutionContext context)`
`protected I18nizableText`	`_getErrorMailBody(JobExecutionContext context, Throwable throwable)`	Retrieves the body of the error mail
`protected I18nizableText`	`_getErrorMailSubject(JobExecutionContext context)`	Retrieves the subject of the error mail
`private Map<String,Object>`	`_getExtractionParameters(JobDataMap jobDataMap)`
`protected Optional<String>`	`_getRecipient(JobExecutionContext context)`	Retrieves the optional recipient of the mail
`private String`	`_getResultFileDownloadLink(Path resultFilePath)`
`protected I18nizableText`	`_getSuccessMailBody(JobExecutionContext context)`	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, 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 Detail
  - 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
  - __JOBDATAMAP_DEFINITION_FILE_PATH_KEY
```
private static final String __JOBDATAMAP_DEFINITION_FILE_PATH_KEY
```
    See Also:
    
    Constant Field Values
  - __JOBDATAMAP_VARIABLES_KEY
```
private static final String __JOBDATAMAP_VARIABLES_KEY
```
    See Also:
    
    Constant Field Values
  - __JOBDATAMAP_RECIPIENT_KEY
```
private static final String __JOBDATAMAP_RECIPIENT_KEY
```
    See Also:
    
    Constant Field Values
  - __JOBDATAMAP_PIPELINE_KEY
```
private static final String __JOBDATAMAP_PIPELINE_KEY
```
    See Also:
    
    Constant Field Values
  - __RESULT_FILE_PATHS
```
private static final String __RESULT_FILE_PATHS
```
    See Also:
    
    Constant Field Values
  - RESULT_FILE_NAME_DATE_TIME_FORMATTER
```
private static final DateTimeFormatter RESULT_FILE_NAME_DATE_TIME_FORMATTER
```
  - _jsonUtils
```
private JSONUtils _jsonUtils
```
  - _pipelineManager
```
private PipelineManager _pipelineManager
```
  - _extractionExecutor
```
private ExtractionExecutor _extractionExecutor
```
- Constructor Detail
  - ExecuteExtractionSchedulable
```
public ExecuteExtractionSchedulable()
```
- Method Detail
  - 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)
                throws Exception
```
    Description copied from class: AbstractSendingMailSchedulable
    
    Executes the schedulable.
    
    Specified by:
    
    _doExecute in class AbstractSendingMailSchedulable
    
    Parameters:
    
    context - the context
    
    Throws:
    
    Exception - if an error occurred
  - _getDefaultResultFileName
```
private String _getDefaultResultFileName(String definitionFilePath,
                                         PipelineDescriptor pipeline)
```
  - _getExtractionParameters
```
private Map<String,Object> _getExtractionParameters(JobDataMap jobDataMap)
```
  - _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 I18nizableText _getSuccessMailBody(JobExecutionContext context)
```
    Description copied from class: AbstractSendingMailSchedulable
    
    Retrieves the body of the success mail
    
    Specified by:
    
    _getSuccessMailBody in class AbstractSendingMailSchedulable
    
    Parameters:
    
    context - the context
    
    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 I18nizableText _getErrorMailBody(JobExecutionContext context,
                                           Throwable throwable)
```
    Description copied from class: AbstractSendingMailSchedulable
    
    Retrieves the body of the error mail
    
    Specified by:
    
    _getErrorMailBody in class AbstractSendingMailSchedulable
    
    Parameters:
    
    context - the context
    
    throwable - the error
    
    Returns:
    
    the body of the error mail
  - _getDefinitionFilePath
```
private String _getDefinitionFilePath(JobExecutionContext context)
```
  - _getResultFileDownloadLink
```
private String _getResultFileDownloadLink(Path resultFilePath)
```

Class ExecuteExtractionSchedulable

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

DEFINITION_FILE_PATH_KEY

VARIABLES_KEY

RECIPIENT_KEY

PIPELINE_KEY

__JOBDATAMAP_DEFINITION_FILE_PATH_KEY

__JOBDATAMAP_VARIABLES_KEY

__JOBDATAMAP_RECIPIENT_KEY

__JOBDATAMAP_PIPELINE_KEY

__RESULT_FILE_PATHS

RESULT_FILE_NAME_DATE_TIME_FORMATTER

_jsonUtils

_pipelineManager

_extractionExecutor

Constructor Detail

ExecuteExtractionSchedulable

Method Detail

service

_doExecute

_getDefaultResultFileName

_getExtractionParameters

_getRecipient

_isMailBodyInHTML

_getSuccessMailSubject

_getSuccessMailBody

_getErrorMailSubject

_getErrorMailBody

_getDefinitionFilePath

_getResultFileDownloadLink