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, _jsonUtils, _notificationPrefHelper, _pluginName, _renderingContextHandler, _resolver, _rightManager, _srcResolver, _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	_getSubjectI18nKey(String eventType, Map<String,Object> eventParams)	Get the i18n subject key
protected List<String>	_getSubjectParams(Project project, Map<String,Object> eventParams)	Get the i18n parameters for subject key
protected AmetysObject	getEventAmetysObject(Event event)	Get the AmetysObject that triggered the event to compute the rights
protected I18nizableText	getI18nSubject(Event event, Project project)	Get the I18nizableText for mail subject
protected String	getMailBodyURI(Event event, Project project)	Returns the URI for HTML mail body
protected String	getRightIdForNotify()	Get the right to check allowed users to notify by mail
protected List<UserIdentity>	getUsersToNotify(String eventId, AmetysObject object, Project project)	Get the users allowed to be notified
boolean	supports(Event event)	Checks if the event is supported.

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

_getRelativePath, contextualize, getPriority, getProject, notifyEvent, 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.

getEventAmetysObject

protected AmetysObject getEventAmetysObject(Event event)

Description copied from class: AbstractSendNotificationObserver

Get the AmetysObject that triggered the event to compute the rights

Specified by:

getEventAmetysObject in class AbstractSendNotificationObserver

Parameters:

event - the event

Returns:

the AmetysObject

getMailBodyURI

protected String getMailBodyURI(Event event,
                                Project project)

Description copied from class: AbstractSendNotificationObserver

Returns the URI for HTML mail body

Specified by:

getMailBodyURI in class AbstractSendNotificationObserver

Parameters:

event - the event

project - the project

Returns:

The URI for HTML mail body

getI18nSubject

protected I18nizableText getI18nSubject(Event event,
                                        Project project)

Description copied from class: AbstractSendNotificationObserver

Get the I18nizableText for mail subject

Specified by:

getI18nSubject in class AbstractSendNotificationObserver

Parameters:

event - the event

project - the project

Returns:

the I18nizableText for subject

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,
                                              Project project)

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

project - The project of the event to test user pref

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(Project project,
                                         Map<String,Object> eventParams)

Get the i18n parameters for subject key

Parameters:

project - The parent project

eventParams - The optional event parameters

Returns:

the i18n parameters