Package org.ametys.plugins.workspaces.comments

Class NotifyFileCommentMentionsObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.repository.mentions.AbstractNotifyMentionsObserver<File>

org.ametys.cms.repository.comment.contributor.AbstractCommentNotifyMentionsObserver<File>

org.ametys.plugins.workspaces.comments.AbstractNotifyWorkspacesCommentMentionsObserver<File>

org.ametys.plugins.workspaces.comments.NotifyFileCommentMentionsObserver

All Implemented Interfaces:

AsyncObserver, Observer, LogEnabled, Prioritizable, Supporter<Event>, Component, Contextualizable, Serviceable

public class NotifyFileCommentMentionsObserver
extends AbstractNotifyWorkspacesCommentMentionsObserver<File>

Observer to send mails to mentioned users in contributor comments of File

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.cms.repository.mentions.AbstractNotifyMentionsObserver

AbstractNotifyMentionsObserver.LinkToAmetysObject, AbstractNotifyMentionsObserver.MentionableObject

Field Summary

Fields inherited from class org.ametys.plugins.workspaces.comments.AbstractNotifyWorkspacesCommentMentionsObserver

_context, _documentModule, _projectManager, _projectRightsHelper, _renderingContextHandler, _rightManager, _taskModule, _workspaceHelper

Fields inherited from class org.ametys.cms.repository.mentions.AbstractNotifyMentionsObserver

_currentUserProvider, _i18nUtils, _mentionUtils, _resolvedUsers, _resolver, _userLanguagesManager, _userManager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
NotifyFileCommentMentionsObserver()

Method Summary

Modifier and Type	Method	Description
protected String	_getAmetysObjectTitle(File file)	Get the title to display in the mail
protected I18nizableText	_getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Retrieves the notification mail's subject
protected AbstractNotifyMentionsObserver.MentionableObject	_getMentionableObjectFromArguments(Map<String,Object> arguments)	Get all information of the mentionable object from the arguments
protected String	_getModuleId()	Get the module id to check read access
protected String	getUrl(File ametysObject, Project project)	Get the URL of the given Ametys object in the context of the given project
boolean	supports(Event event)	Check if an element is supported

Methods inherited from class org.ametys.plugins.workspaces.comments.AbstractNotifyWorkspacesCommentMentionsObserver

_canSendMailToMentionedUser, _getAbsoluteUrl, _getAmetysObjectFromArguments, _getLanguage, _getMailSubject, _getMailTitle, contextualize, getStandardMailBodyHelper, observe, service

Methods inherited from class org.ametys.cms.repository.comment.contributor.AbstractCommentNotifyMentionsObserver

_getComment, _getMailMessageType, _transformSyntaxTextToReadableTextWithColors

Methods inherited from class org.ametys.cms.repository.mentions.AbstractNotifyMentionsObserver

_createBody, _sendMail, _sendMailToMentionedUsers, getPriority

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.core.observation.AsyncObserver

parallelizable

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

getTraits

Constructor Details

NotifyFileCommentMentionsObserver

public NotifyFileCommentMentionsObserver()

Method Details

supports

public boolean supports(Event event)

Description copied from interface: Supporter

Check if an element is supported

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

_getMentionableObjectFromArguments

protected AbstractNotifyMentionsObserver.MentionableObject _getMentionableObjectFromArguments(Map<String,Object> arguments)
                                                                                       throws Exception

Description copied from class: AbstractNotifyMentionsObserver

Get all information of the mentionable object from the arguments

Specified by:

_getMentionableObjectFromArguments in class AbstractNotifyMentionsObserver<File>

Parameters:

arguments - the arguments map

Returns:

the mentionable object

Throws:

Exception - if an error occurs.

_getAmetysObjectTitle

protected String _getAmetysObjectTitle(File file)

Description copied from class: AbstractCommentNotifyMentionsObserver

Get the title to display in the mail

Specified by:

_getAmetysObjectTitle in class AbstractCommentNotifyMentionsObserver<File>

Parameters:

file - the ametys object

Returns:

the ametys object title

_getMailMessage

protected I18nizableText _getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Description copied from class: AbstractNotifyMentionsObserver

Retrieves the notification mail's subject

Specified by:

_getMailMessage in class AbstractNotifyMentionsObserver<File>

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_getModuleId

protected String _getModuleId()

Description copied from class: AbstractNotifyWorkspacesCommentMentionsObserver

Get the module id to check read access

Specified by:

_getModuleId in class AbstractNotifyWorkspacesCommentMentionsObserver<File>

Returns:

the module id

getUrl

protected String getUrl(File ametysObject,
 Project project)

Description copied from class: AbstractNotifyWorkspacesCommentMentionsObserver

Get the URL of the given Ametys object in the context of the given project

Specified by:

getUrl in class AbstractNotifyWorkspacesCommentMentionsObserver<File>

Parameters:

ametysObject - the Ametys object

project - the project containing the Ametys object

Returns:

the URL (may be relative or absolute depending on the implementation)