Package org.ametys.plugins.pagesubscription.page.notifier

Class AbstractPageSubscriptionNotifier

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.pagesubscription.page.notifier.AbstractPageSubscriptionNotifier

All Implemented Interfaces:

LogEnabled, Supporter<ActivityType>, ActivityNotifier, Serviceable

Direct Known Subclasses:

PageSubscriptionPageDeletedNotifier, PageSubscriptionPageUpdatedNotifier, PageSubscriptionResourcesUpdatedNotifier

public abstract class AbstractPageSubscriptionNotifier
extends AbstractLogEnabled
implements ActivityNotifier, Serviceable

Abstract notifier for page activity

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nUtils	_i18nUtils	The i18n utils
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected PageSubscriptionDAO	_subscriptionDAO	The subscription dao
protected UserLanguagesManager	_userLanguagesManager	The user languages manager
protected UserManager	_userManager	The user manager

Constructor Summary

Constructors

Constructor	Description
AbstractPageSubscriptionNotifier()

Method Summary

Modifier and Type	Method	Description
protected String	_getAbsolutePageUrl(Page page)	Get the absolute URL of a page
protected abstract String	_getMailHtmlBody(Activity activity, String language, Page page, User author)	Get the mail body
protected abstract I18nizableText	_getMailSubject(Activity activity, Page page)	Get the mail subject
String	getMailHtmlBody(Activity activity, String language)	Get the mail body as html from the activity
String	getMailSubject(Activity activity, String language)	Get the mail subject from the activity
String	getMailTextBody(Activity activity, String language)	Get the mail body to text format from the activity
protected abstract String	getSiteParameterId()	Id of the site parameter to enable/disable the notification
Map<String,List<String>>	getUsersToNotifyByLanguage(Activity activity)	Get the list of user email to notify by their language for a given activity
protected boolean	isNotificationEnabled(Page page)	Determines if the notification is currently enabled
void	service(ServiceManager manager)

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

Methods inherited from interface org.ametys.web.activities.notify.ActivityNotifier

isAsync

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_userManager

protected UserManager _userManager

The user manager

_subscriptionDAO

protected PageSubscriptionDAO _subscriptionDAO

The subscription dao

_userLanguagesManager

protected UserLanguagesManager _userLanguagesManager

The user languages manager

Constructor Details

AbstractPageSubscriptionNotifier

public AbstractPageSubscriptionNotifier()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUsersToNotifyByLanguage

public Map<String,List<String>> getUsersToNotifyByLanguage(Activity activity)

Description copied from interface: ActivityNotifier

Get the list of user email to notify by their language for a given activity

Specified by:

getUsersToNotifyByLanguage in interface ActivityNotifier

Parameters:

activity - the activity

Returns:

the list of user email to notify

isNotificationEnabled

protected boolean isNotificationEnabled(Page page)

Determines if the notification is currently enabled

Parameters:

page - The page

Returns:

true if the notification is enabled

getSiteParameterId

protected abstract String getSiteParameterId()

Id of the site parameter to enable/disable the notification

Returns:

The id of site

getMailSubject

public String getMailSubject(Activity activity,
 String language)

Description copied from interface: ActivityNotifier

Get the mail subject from the activity

Specified by:

getMailSubject in interface ActivityNotifier

Parameters:

activity - the activity

language - The language to use, can be null

Returns:

the mail subject

_getMailSubject

protected abstract I18nizableText _getMailSubject(Activity activity,
 Page page)

Get the mail subject

Parameters:

activity - the activity

page - the page from activity

Returns:

the mail subject

getMailTextBody

public String getMailTextBody(Activity activity,
 String language)

Description copied from interface: ActivityNotifier

Get the mail body to text format from the activity

Specified by:

getMailTextBody in interface ActivityNotifier

Parameters:

activity - the activity

language - The language to use, can be null

Returns:

the mail body to text format. Can be null.

getMailHtmlBody

public String getMailHtmlBody(Activity activity,
 String language)

Description copied from interface: ActivityNotifier

Get the mail body as html from the activity

Specified by:

getMailHtmlBody in interface ActivityNotifier

Parameters:

activity - the activity

language - The language to use, can be null

Returns:

the mail body as html. Can be null.

_getMailHtmlBody

protected abstract String _getMailHtmlBody(Activity activity,
 String language,
 Page page,
 User author)
                                    throws IOException

Get the mail body

Parameters:

activity - the activity

language - The language

page - the page from activity

author - the author of the activity

Returns:

the mail body

Throws:

IOException - if an error occurred

_getAbsolutePageUrl

protected String _getAbsolutePageUrl(Page page)

Get the absolute URL of a page

Parameters:

page - The page to retrieve the url

Returns:

The absolute url of the page