Package org.ametys.plugins.pagesubscription.schedulable.page

Class SendPageNotificationSummarySchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.pagesubscription.schedulable.page.SendPageNotificationSummarySchedulable

All Implemented Interfaces:

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

public class SendPageNotificationSummarySchedulable
extends AbstractStaticSchedulable

Schedulable to send not forced page notification summary by mail The frequency is configurable. (DAILY, WEEKLY, MONTHLY)

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
protected FrequencyHelper.Frequency	_frequency	The frequency
protected I18nUtils	_i18nUtils	The i18n utils
protected I18nizableText	_mailMessage	The mail message
protected I18nizableText	_mailSubject	The mail subject
protected I18nizableText	_mailTitle	The mail title
protected PageDAO	_pageDAO	The page DAO
protected PageNotificationsHelper	_pageNotificationHelper	The page notification helper
protected PageSubscriptionType	_pageSubscriptionType	The page subscription type
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SiteManager	_siteManager	The site manager
protected SubscriptionTypeExtensionPoint	_subscriptionTypeEP	The subscription type EP
static final String	FOLLOWED_PAGES_CONFIG_PAGE_TAG	Tag for page that contains followed page configuration service

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

Method Summary

Modifier and Type	Method	Description
protected I18nizableText	_getI18nSubject(Site site)	Get the subject of the mail
protected String	_getMailBody(Site site, Set<Activity> pages, String lang)	Get the mail body of the mail
void	configure(Configuration configuration)
void	execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	The action to perform when a trigger is fired.
void	service(ServiceManager manager)

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

FOLLOWED_PAGES_CONFIG_PAGE_TAG

public static final String FOLLOWED_PAGES_CONFIG_PAGE_TAG

Tag for page that contains followed page configuration service

See Also:

• Constant Field Values

_frequency

protected FrequencyHelper.Frequency _frequency

The frequency

_mailSubject

protected I18nizableText _mailSubject

The mail subject

_mailTitle

protected I18nizableText _mailTitle

The mail title

_mailMessage

protected I18nizableText _mailMessage

The mail message

_subscriptionTypeEP

protected SubscriptionTypeExtensionPoint _subscriptionTypeEP

The subscription type EP

_pageSubscriptionType

protected PageSubscriptionType _pageSubscriptionType

The page subscription type

_siteManager

protected SiteManager _siteManager

The site manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_pageNotificationHelper

protected PageNotificationsHelper _pageNotificationHelper

The page notification helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_pageDAO

protected PageDAO _pageDAO

The page DAO

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

Constructor Details

SendPageNotificationSummarySchedulable

public SendPageNotificationSummarySchedulable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSchedulable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSchedulable

Throws:

ConfigurationException

execute

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

Description copied from interface: Schedulable

The action to perform when a trigger is fired. Do not manually call this method.

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_getI18nSubject

protected I18nizableText _getI18nSubject(Site site)

Get the subject of the mail

Parameters:

site -

Returns:

the subject of the mail

_getMailBody

protected String _getMailBody(Site site,
 Set<Activity> pages,
 String lang)
                       throws IOException

Get the mail body of the mail

Parameters:

site - the site

pages - the set of pages with it last activity

lang - the language

Returns:

the mail body of the mail

Throws:

IOException - if an error occurred