org.ametys.plugins.workspaces.project.notification

Class ResourcesMailNotifierObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.workspaces.project.notification.ResourcesMailNotifierObserver

All Implemented Interfaces:

Observer, LogEnabled, PluginAware, Contextualizable, Serviceable

public class ResourcesMailNotifierObserver
extends AbstractSendNotificationObserver

This observer observes event of resources to notify concerned users

Field Summary

Fields

Modifier and Type	Field and Description
private static int	__MAX_RESOURCE_LINK
private DocumentWorkspaceModule	_documentModule
protected ResourceNotifierHelper	_webdavNotifyHelper Webdav Notify Helper

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 and Description
ResourcesMailNotifierObserver()

Method Summary

Modifier and Type	Method and 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
private String	_getDownloadURL(Project project, Map<String,Resource> resources)
protected String	_getDownloadURL(Project project, String id) Get the url to download file
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 void	notifyEvent(Project project, String eventId, Map<String,Object> eventParams, User issuer) Notify email by mail
void	service(ServiceManager smanager)
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, getUsersToNotify, observe, sendMail, 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 Detail

__MAX_RESOURCE_LINK

private static final int __MAX_RESOURCE_LINK

See Also:

Constant Field Values

_webdavNotifyHelper

protected ResourceNotifierHelper _webdavNotifyHelper

Webdav Notify Helper

_documentModule

private DocumentWorkspaceModule _documentModule

Constructor Detail

ResourcesMailNotifierObserver

public ResourcesMailNotifierObserver()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendNotificationObserver

Throws:

ServiceException

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

_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

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

_getDownloadURL

private String _getDownloadURL(Project project,
                               Map<String,Resource> resources)

_getDownloadURL

protected String _getDownloadURL(Project project,
                                 String id)

Get the url to download file

Parameters:

project - The project

id - The id of resource

Returns:

The download url