Package org.ametys.web.alerts

Class AlertSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.alerts.AlertSchedulable

org.ametys.web.alerts.AlertSchedulable

All Implemented Interfaces:

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

Direct Known Subclasses:

AlertSchedulable

public class AlertSchedulable
extends AlertSchedulable

Alerts engine: sends alerts mail. This is the web version of the engine: it sets the currently processed content's site name in the request object, and sends additional site and page information in the alerts e-mails.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.cms.alerts.AlertSchedulable

AlertSchedulable.BinaryExpression

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

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_baseUrl	The server base URL.
protected boolean	_pagePublicationEnabled	True if the alert of page publication ending is enabled
protected String	_pagePublicationEndBody	The "page nearing end of publication" e-mail body i18n key.
protected Set<String>	_pagePublicationEndRights	The "page nearing end of publication" e-mail will be sent to users that have this right.
protected String	_pagePublicationEndSubject	The "page nearing end of publication" e-mail subject i18n key.

Fields inherited from class org.ametys.cms.alerts.AlertSchedulable

__VALIDATION_ALERT_EXPR_CONTEXT, _awaitingValidationBody, _awaitingValidationRights, _awaitingValidationSubject, _contentHelper, _environmentContext, _i18nUtils, _initialized, _instantAlertBody, _instantAlertRights, _instantAlertSubject, _mailFrom, _manager, _reminderBody, _reminderRights, _reminderSubject, _resolver, _rightManager, _scheduledArchivingReminderBody, _scheduledArchivingReminderRights, _scheduledArchivingReminderSubject, _unmodifiedContentBody, _unmodifiedContentRights, _unmodifiedContentStepIds, _unmodifiedContentSubject, JOBDATAMAP_CONTENT_IDS_KEY, JOBDATAMAP_INSTANT_MODE_KEY, JOBDATAMAP_MESSAGE_KEY, SCHEDULABLE_ID

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
AlertSchedulable()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_getAdditionalParams(Content content)	Get the additional i18n parameters for content
protected String	_getContentUrl(Content content)	Get the URL to the given content tool.
protected Page	_getPage(Content content, Site site)	Get the page referenced by this content
protected List<String>	_getPagePublicationEndParams(Page page)	Get the "page nearing end of publication" mail parameters.
protected String	_getPageUrl(Page page)	Get the URL of the back-office, opening on the page tool.
protected Site	_getSite(Content content)	Get the site name
protected void	_sendPagePublicationEndAlerts()	Send the "page nearing end of publication" alerts.
protected void	_sendPagePublicationEndEmail(Page page)	Send the "page publication end" alert e-mail.
protected void	_setRequestAttributes(Content content)	Set the necessary request attributes
protected void	_setRequestAttributes(Page page)	Set the necessary request attributes
void	configure(Configuration configuration)	Configure the engine (called by the scheduler).
void	execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Send all the alerts.
protected String	getI18nKeyBody(String bodyI18nKey, Content content)	Get the transform i18n body key for specific content
void	initialize()

Methods inherited from class org.ametys.cms.alerts.AlertSchedulable

_getAwaitingValidationParams, _getInstantAlertParams, _getReminderParams, _getRightsFromConf, _getScheduledArchivingReminderParams, _getUnmodifiedContentParams, _removeTimeParts, _sendAwaitingValidationAlerts, _sendAwaitingValidationEmail, _sendInstantAlertEmail, _sendInstantAlerts, _sendMails, _sendReminderEmail, _sendReminders, _sendScheduledArchivingReminderEmail, _sendScheduledArchivingReminders, _sendUnmodifiedAlerts, _sendUnmodifiedContentEmail, isInstantMode, service

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

acceptConcurrentExecution, 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

_pagePublicationEnabled

protected boolean _pagePublicationEnabled

True if the alert of page publication ending is enabled

_pagePublicationEndRights

protected Set<String> _pagePublicationEndRights

The "page nearing end of publication" e-mail will be sent to users that have this right.

_pagePublicationEndSubject

protected String _pagePublicationEndSubject

The "page nearing end of publication" e-mail subject i18n key.

_pagePublicationEndBody

protected String _pagePublicationEndBody

The "page nearing end of publication" e-mail body i18n key.

_baseUrl

protected String _baseUrl

The server base URL.

Constructor Details

AlertSchedulable

public AlertSchedulable()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AlertSchedulable

Throws:

Exception

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Description copied from class: AlertSchedulable

Configure the engine (called by the scheduler).

Specified by:

configure in interface Configurable

Overrides:

configure in class AlertSchedulable

Parameters:

configuration - the component configuration.

Throws:

ConfigurationException - if the configuration is not valid

execute

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

Description copied from class: AlertSchedulable

Send all the alerts. Can be overridden to add alerts.

Specified by:

execute in interface Schedulable

Overrides:

execute in class AlertSchedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_setRequestAttributes

protected void _setRequestAttributes(Content content)

Description copied from class: AlertSchedulable

Set the necessary request attributes

Overrides:

_setRequestAttributes in class AlertSchedulable

Parameters:

content - The content

_setRequestAttributes

protected void _setRequestAttributes(Page page)

Set the necessary request attributes

Parameters:

page - The concerned page

_sendPagePublicationEndAlerts

protected void _sendPagePublicationEndAlerts()
                                      throws AmetysRepositoryException

Send the "page nearing end of publication" alerts.

Throws:

AmetysRepositoryException - if an error occurs.

_sendPagePublicationEndEmail

protected void _sendPagePublicationEndEmail(Page page)
                                     throws AmetysRepositoryException

Send the "page publication end" alert e-mail.

Parameters:

page - the page nearing publication end.

Throws:

AmetysRepositoryException - if an error occurs.

getI18nKeyBody

protected String getI18nKeyBody(String bodyI18nKey,
 Content content)

Description copied from class: AlertSchedulable

Get the transform i18n body key for specific content

Overrides:

getI18nKeyBody in class AlertSchedulable

Parameters:

bodyI18nKey - the original body key

content - the content

Returns:

the transform i18n body key

_getAdditionalParams

protected List<String> _getAdditionalParams(Content content)

Description copied from class: AlertSchedulable

Get the additional i18n parameters for content

Overrides:

_getAdditionalParams in class AlertSchedulable

Parameters:

content - The content

Returns:

The additional i18n parameters

_getPagePublicationEndParams

protected List<String> _getPagePublicationEndParams(Page page)

Get the "page nearing end of publication" mail parameters.

Parameters:

page - the page.

Returns:

the mail parameters.

_getContentUrl

protected String _getContentUrl(Content content)

Description copied from class: AlertSchedulable

Get the URL to the given content tool.

Overrides:

_getContentUrl in class AlertSchedulable

Parameters:

content - the content.

Returns:

the content URL.

_getPageUrl

protected String _getPageUrl(Page page)

Get the URL of the back-office, opening on the page tool.

Parameters:

page - the page to link to.

Returns:

the page URL.

_getSite

protected Site _getSite(Content content)

Get the site name

Parameters:

content - The content

Returns:

the site name

_getPage

protected Page _getPage(Content content,
 Site site)

Get the page referenced by this content

Parameters:

content - The content

site - the site

Returns:

the page or null.