Package org.ametys.plugins.workspaces.project.notification

Class TaskMailNotifierObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.notification.AbstractSendNotificationObserver

org.ametys.plugins.workspaces.project.notification.TaskMailNotifierObserver

All Implemented Interfaces:

Observer, LogEnabled, PluginAware, Contextualizable, Serviceable

public class TaskMailNotifierObserver
extends AbstractSendNotificationObserver

This Observer observes events on task to notify concerned users

Field Summary

Fields inherited from class org.ametys.plugins.workspaces.project.notification.AbstractSendNotificationObserver

_context, _i18nUtils, _moduleManagerEP, _pluginName, _projectManager, _renderingContextHandler, _resolver, _rightManager, _userManager

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
TaskMailNotifierObserver()

Method Summary

Modifier and Type	Method	Description
protected String	_getBodyI18nKey(String eventType, Map<String,Object> eventParams)	Get the i18n subject key
protected List<String>	_getBodyParams(String eventType, Project project, User issuer, Map<String,Object> eventParams)	Get the i18n parameters for body key
protected String	_getSubjectI18nKey(String eventType, Map<String,Object> eventParams)	Get the i18n subject key
protected List<String>	_getSubjectParams(String eventType, Project project, User issuer, Map<String,Object> eventParams)	Get the i18n parameters for subject key
protected String	getRightIdForNotify()	Get the right to check allowed users to notify by mail
protected String	getUrl(Project project, String objectId)	Get the URL of project to insert in email body
protected List<UserIdentity>	getUsersToNotify(String eventId, AmetysObject object)	Get the users allowed to be notified
protected void	notifyEvent(Project project, String eventId, Map<String,Object> eventParams, User issuer)	Notify email by mail
boolean	supports(Event event)	Checks if the event is supported.

Methods inherited from class org.ametys.plugins.workspaces.project.notification.AbstractSendNotificationObserver

_getPath, contextualize, getDefaultLanguage, getMailCommonParams, getModulePage, getModuleUrl, getPriority, getProject, getProjectUrl, observe, sendMail, service, 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 Detail

TaskMailNotifierObserver

public TaskMailNotifierObserver()

Method Detail

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

notifyEvent

protected void notifyEvent(Project project,
                           String eventId,
                           Map<String,Object> eventParams,
                           User issuer)

Description copied from class: AbstractSendNotificationObserver

Notify email by mail

Specified by:

notifyEvent in class AbstractSendNotificationObserver

Parameters:

project - The project

eventId - The id of event

eventParams - The event's arguments

issuer - The issuer

getUrl

protected String getUrl(Project project,
                        String objectId)

Description copied from class: AbstractSendNotificationObserver

Get the URL of project to insert in email body

Specified by:

getUrl in class AbstractSendNotificationObserver

Parameters:

project - The project

objectId - The id of concerned object

Returns:

The full URL

getRightIdForNotify

protected String getRightIdForNotify()

Description copied from class: AbstractSendNotificationObserver

Get the right to check allowed users to notify by mail

Specified by:

getRightIdForNotify in class AbstractSendNotificationObserver

Returns:

the right id to check

getUsersToNotify

protected List<UserIdentity> getUsersToNotify(String eventId,
                                              AmetysObject object)

Description copied from class: AbstractSendNotificationObserver

Get the users allowed to be notified

Overrides:

getUsersToNotify in class AbstractSendNotificationObserver

Parameters:

eventId - The id of event

object - The object on which to test rights

Returns:

The allowed users

_getSubjectI18nKey

protected String _getSubjectI18nKey(String eventType,
                                    Map<String,Object> eventParams)

Get the i18n subject key

Parameters:

eventType - The type of event

eventParams - The optional event parameters

Returns:

the i18 key

_getSubjectParams

protected List<String> _getSubjectParams(String eventType,
                                         Project project,
                                         User issuer,
                                         Map<String,Object> eventParams)

Get the i18n parameters for subject key

Parameters:

eventType - The event type

project - The parent project

issuer - The user responsible of the action

eventParams - The optional event parameters

Returns:

the i18n parameters

_getBodyI18nKey

protected String _getBodyI18nKey(String eventType,
                                 Map<String,Object> eventParams)

Get the i18n subject key

Parameters:

eventType - The type of event

eventParams - The optional event parameters

Returns:

the i18n key

_getBodyParams

protected List<String> _getBodyParams(String eventType,
                                      Project project,
                                      User issuer,
                                      Map<String,Object> eventParams)

Get the i18n parameters for body key

Parameters:

eventType - The event type

project - The parent project

issuer - The user responsible of the action

eventParams - The optional event parameters

Returns:

he i18n parameters