Package org.ametys.plugins.workspaces.comments

Class NotifyThreadMentionsObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.workspaces.comments.NotifyThreadMentionsObserver

All Implemented Interfaces:

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

public class NotifyThreadMentionsObserver
extends AbstractNotifyMentionsObserver<Thread>
implements Contextualizable

Observer to send mails to mentioned users in content of Thread

Nested Class Summary

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

AbstractNotifyMentionsObserver.LinkToAmetysObject, AbstractNotifyMentionsObserver.MentionableObject

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The Avalon context
protected ForumWorkspaceModule	_forumModule	The forum module
protected ProjectManager	_projectManager	The project manager
protected ProjectRightHelper	_projectRightsHelper	The project rights helper
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected RightManager	_rightManager	The right manager
protected ThreadJSONHelper	_threadJSONHelper	The project tags DAO
protected WorkspacesHelper	_workspaceHelper	The Workspaces helper

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

_currentUserProvider, _i18nUtils, _mentionUtils, _resolvedUsers, _resolver, _userManager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
NotifyThreadMentionsObserver()

Method Summary

Modifier and Type	Method	Description
protected boolean	_canSendMailToMentionedUser(Thread thread, User authorIdentity, UserIdentity mentionedUserIdentity)	true if we can send a mail to the mentioned user
protected I18nizableText	_getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Retrieves the notification mail's subject
protected I18nizableText	_getMailMessageType()	Get the type of message to display before the message
protected I18nizableText	_getMailSubject(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Retrieves the notification mail's subject
protected I18nizableText	_getMailTitle(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Get the title of the mail body
protected AbstractNotifyMentionsObserver.MentionableObject	_getMentionableObjectFromArguments(Map<String,Object> arguments)	Get all information of the mentionable object from the arguments
protected String	_transformSyntaxTextToReadableTextWithColors(String content, UserIdentity recipient)	Transform syntax text to readable text with colors according to whether the recipient is the one being tagged or not
void	contextualize(Context context)
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)
boolean	supports(Event event)	Check if an element is supported

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

_createBody, _sendMail, _sendMailToMentionedUsers, getPriority, getStandardMailBodyHelper

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

Field Details

_rightManager

protected RightManager _rightManager

The right manager

_forumModule

protected ForumWorkspaceModule _forumModule

The forum module

_projectManager

protected ProjectManager _projectManager

The project manager

_threadJSONHelper

protected ThreadJSONHelper _threadJSONHelper

The project tags DAO

_context

protected Context _context

The Avalon context

_workspaceHelper

protected WorkspacesHelper _workspaceHelper

The Workspaces helper

_projectRightsHelper

protected ProjectRightHelper _projectRightsHelper

The project rights helper

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

Constructor Details

NotifyThreadMentionsObserver

public NotifyThreadMentionsObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractNotifyMentionsObserver<Thread>

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

observe

public void observe(Event event,
 Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Overrides:

observe in class AbstractNotifyMentionsObserver<Thread>

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.

supports

public boolean supports(Event event)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Event>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

_getMailTitle

protected I18nizableText _getMailTitle(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Description copied from class: AbstractNotifyMentionsObserver

Get the title of the mail body

Specified by:

_getMailTitle in class AbstractNotifyMentionsObserver<Thread>

Parameters:

mentionableObject - the mentionable object

Returns:

the mail title

_getMailSubject

protected I18nizableText _getMailSubject(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Description copied from class: AbstractNotifyMentionsObserver

Retrieves the notification mail's subject

Specified by:

_getMailSubject in class AbstractNotifyMentionsObserver<Thread>

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_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<Thread>

Parameters:

arguments - the arguments map

Returns:

the mentionable object

Throws:

Exception - if an error occurs.

_transformSyntaxTextToReadableTextWithColors

protected String _transformSyntaxTextToReadableTextWithColors(String content,
 UserIdentity recipient)

Description copied from class: AbstractNotifyMentionsObserver

Transform syntax text to readable text with colors according to whether the recipient is the one being tagged or not

Specified by:

_transformSyntaxTextToReadableTextWithColors in class AbstractNotifyMentionsObserver<Thread>

Parameters:

content - the syntax text

recipient - the recipient

Returns:

the readable text

_getMailMessageType

protected I18nizableText _getMailMessageType()

Description copied from class: AbstractNotifyMentionsObserver

Get the type of message to display before the message

Specified by:

_getMailMessageType in class AbstractNotifyMentionsObserver<Thread>

Returns:

the message type

_getMailMessage

protected I18nizableText _getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Description copied from class: AbstractNotifyMentionsObserver

Retrieves the notification mail's subject

Specified by:

_getMailMessage in class AbstractNotifyMentionsObserver<Thread>

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_canSendMailToMentionedUser

protected boolean _canSendMailToMentionedUser(Thread thread,
 User authorIdentity,
 UserIdentity mentionedUserIdentity)

Description copied from class: AbstractNotifyMentionsObserver

true if we can send a mail to the mentioned user

Overrides:

_canSendMailToMentionedUser in class AbstractNotifyMentionsObserver<Thread>

Parameters:

thread - the ametys object

authorIdentity - the author

mentionedUserIdentity - the mentioned user

Returns:

true if we can send a mail to the mentioned user