Package org.ametys.plugins.workspaces.comments

Class AbstractNotifyWorkspacesCommentMentionsObserver<T extends CommentableAmetysObject>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

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

Type Parameters:

T - type of the CommentableAmetysObject

All Implemented Interfaces:

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

Direct Known Subclasses:

NotifyFileCommentMentionsObserver, NotifyTaskCommentMentionsObserver, NotifyThreadCommentMentionsObserver

public abstract class AbstractNotifyWorkspacesCommentMentionsObserver<T extends CommentableAmetysObject>
extends AbstractCommentNotifyMentionsObserver<T>
implements Contextualizable

Observer to send mails to mentioned users in contributor comments of workspaces objects

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 context
protected DocumentWorkspaceModule	_documentModule	The document 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 TasksWorkspaceModule	_taskModule	The task module
protected WorkspacesHelper	_workspaceHelper	The Workspaces helper

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
AbstractNotifyWorkspacesCommentMentionsObserver()

Method Summary

Modifier and Type	Method	Description
protected boolean	_canSendMailToMentionedUser(T ametysObject, User authorIdentity, UserIdentity mentionedUserIdentity)	true if we can send a mail to the mentioned user
protected String	_getAbsoluteUrl(T ametysObject, Project project)	Get the absolute URL of the given Ametys object in the context of the given project
protected T	_getAmetysObjectFromArguments(Map<String,Object> arguments)	Get the Ametys object from the event arguments
protected String	_getLanguage(Project project)	Get the language of the project containing the given object
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 abstract String	_getModuleId()	Get the module id to check read access
void	contextualize(Context context)
protected StandardMailBodyHelper.MailBodyBuilder	getStandardMailBodyHelper()	Get a standard mail body helper
protected abstract String	getUrl(T ametysObject, Project project)	Get the URL of the given Ametys object in the context of the given project
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)

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

_getAmetysObjectTitle, _getComment, _getMailMessageType, _transformSyntaxTextToReadableTextWithColors

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

_createBody, _getMailMessage, _getMentionableObjectFromArguments, _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

Methods inherited from interface org.ametys.runtime.plugin.component.Supporter

supports

Field Details

_rightManager

protected RightManager _rightManager

The right manager

_projectManager

protected ProjectManager _projectManager

The project manager

_taskModule

protected TasksWorkspaceModule _taskModule

The task module

_documentModule

protected DocumentWorkspaceModule _documentModule

The document module

_workspaceHelper

protected WorkspacesHelper _workspaceHelper

The Workspaces helper

_context

protected Context _context

The context

_projectRightsHelper

protected ProjectRightHelper _projectRightsHelper

The project rights helper

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

Constructor Details

AbstractNotifyWorkspacesCommentMentionsObserver

public AbstractNotifyWorkspacesCommentMentionsObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractNotifyMentionsObserver<T extends CommentableAmetysObject>

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<T extends CommentableAmetysObject>

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.

_getLanguage

protected String _getLanguage(Project project)

Get the language of the project containing the given object

Parameters:

project - the project

Returns:

the language code

_getAmetysObjectFromArguments

protected T _getAmetysObjectFromArguments(Map<String,Object> arguments)

Get the Ametys object from the event arguments

Parameters:

arguments - the event arguments

Returns:

the Ametys object

getStandardMailBodyHelper

protected StandardMailBodyHelper.MailBodyBuilder getStandardMailBodyHelper()

Description copied from class: AbstractNotifyMentionsObserver

Get a standard mail body helper

Overrides:

getStandardMailBodyHelper in class AbstractNotifyMentionsObserver<T extends CommentableAmetysObject>

Returns:

the standard mail body helper

_getMailSubject

protected I18nizableText _getMailSubject(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Description copied from class: AbstractNotifyMentionsObserver

Retrieves the notification mail's subject

Overrides:

_getMailSubject in class AbstractCommentNotifyMentionsObserver<T extends CommentableAmetysObject>

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_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<T extends CommentableAmetysObject>

Parameters:

mentionableObject - the mentionable object

Returns:

the mail title

_canSendMailToMentionedUser

protected boolean _canSendMailToMentionedUser(T ametysObject,
 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<T extends CommentableAmetysObject>

Parameters:

ametysObject - the ametys object

authorIdentity - the author

mentionedUserIdentity - the mentioned user

Returns:

true if we can send a mail to the mentioned user

_getModuleId

protected abstract String _getModuleId()

Get the module id to check read access

Returns:

the module id

_getAbsoluteUrl

protected String _getAbsoluteUrl(T ametysObject,
 Project project)

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

Parameters:

ametysObject - the Ametys object

project - the project containing the Ametys object

Returns:

the absolute URL

getUrl

protected abstract String getUrl(T ametysObject,
 Project project)

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

Parameters:

ametysObject - the Ametys object

project - the project containing the Ametys object

Returns:

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