Package org.ametys.odf.schedulable

Class OdfRefTableDataSynchronizationSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.odf.schedulable.OdfRefTableDataSynchronizationSchedulable

All Implemented Interfaces:

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

public class OdfRefTableDataSynchronizationSchedulable
extends AbstractSendingMailSchedulable

Import reference table data described by OdfRefTableDataExtensionPoint.

Nested Class Summary

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

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

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, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
OdfRefTableDataSynchronizationSchedulable()

Method Summary

Modifier and Type	Method	Description
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected String	_getErrorMailBody(JobExecutionContext context, Throwable throwable)	Retrieves the body of the error mail
protected I18nizableText	_getErrorMailSubject(JobExecutionContext context)	Retrieves the subject of the error mail
protected String	_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

_getRecipient, _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

Constructor Details

OdfRefTableDataSynchronizationSchedulable

public OdfRefTableDataSynchronizationSchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

_doExecute

protected 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

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)
                             throws Exception

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

Throws:

Exception - If an error occurs while retrieving if mail body should be HTML

_getSuccessMailSubject

protected I18nizableText _getSuccessMailSubject(JobExecutionContext context)
                                         throws Exception

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

Throws:

Exception - If an error occurs while building the mail subject

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context)
                              throws Exception

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

Throws:

Exception - If an error occurs while building the mail body

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)
                                       throws Exception

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

Throws:

Exception - If an error occurs while building the mail subject

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 Throwable throwable)
                            throws Exception

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

Throws:

Exception - If an error occurs while building the mail body