Package org.ametys.cms.repository.mentions

Class AbstractNotifyMentionsObserver<T extends AmetysObject>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

Type Parameters:

T - type of the AmetysObject

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCommentNotifyMentionsObserver, NotifyThreadMentionsObserver

public abstract class AbstractNotifyMentionsObserver<T extends AmetysObject>
extends AbstractLogEnabled
implements Component, Serviceable, AsyncObserver

Abstract observer to send mails to mentioned users in AmetysObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractNotifyMentionsObserver.LinkToAmetysObject	Link to the ametys object
static final record	AbstractNotifyMentionsObserver.MentionableObject	A record to get all information of the mentionable object

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	The i18n utils.
protected MentionUtils	_mentionUtils	The mention utils
protected Map<UserIdentity,User>	_resolvedUsers	Cache for resolved users
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected UserManager	_userManager	The user manager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractNotifyMentionsObserver()

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	_createBody(User user, I18nizableText message, AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	create a mail body with arguments
protected abstract I18nizableText	_getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Retrieves the notification mail's subject
protected abstract I18nizableText	_getMailMessageType()	Get the type of message to display before the message
protected abstract I18nizableText	_getMailSubject(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Retrieves the notification mail's subject
protected abstract I18nizableText	_getMailTitle(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Get the title of the mail body
protected abstract AbstractNotifyMentionsObserver.MentionableObject	_getMentionableObjectFromArguments(Map<String,Object> arguments)	Get all information of the mentionable object from the arguments
protected void	_sendMail(User user, String subject, String body)	Send mail to the given user
protected void	_sendMailToMentionedUsers(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)	Send mail to all mentioned users in the mentionable object
protected abstract String	_transformSyntaxTextToReadableTextWithColors(String syntaxText, UserIdentity recipient)	Transform syntax text to readable text with colors according to whether the recipient is the one being tagged or not
int	getPriority()	Get the priority for the component.
protected StandardMailBodyHelper.MailBodyBuilder	getStandardMailBodyHelper()	Get a standard mail body helper
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)

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

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_userManager

protected UserManager _userManager

The user manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_resolvedUsers

protected Map<UserIdentity,User> _resolvedUsers

Cache for resolved users

_mentionUtils

protected MentionUtils _mentionUtils

The mention utils

Constructor Details

AbstractNotifyMentionsObserver

public AbstractNotifyMentionsObserver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

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

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.

_sendMailToMentionedUsers

protected void _sendMailToMentionedUsers(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Send mail to all mentioned users in the mentionable object

Parameters:

mentionableObject - the mentionable object

_createBody

protected String _createBody(User user,
 I18nizableText message,
 AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

create a mail body with arguments

Parameters:

user - the user

message - the message

mentionableObject - the object

Returns:

the mail body

getStandardMailBodyHelper

protected StandardMailBodyHelper.MailBodyBuilder getStandardMailBodyHelper()

Get a standard mail body helper

Returns:

the standard mail body helper

_getMailMessageType

protected abstract I18nizableText _getMailMessageType()

Get the type of message to display before the message

Returns:

the message type

_getMailTitle

protected abstract I18nizableText _getMailTitle(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Get the title of the mail body

Parameters:

mentionableObject - the mentionable object

Returns:

the mail title

_transformSyntaxTextToReadableTextWithColors

protected abstract String _transformSyntaxTextToReadableTextWithColors(String syntaxText,
 UserIdentity recipient)

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

Parameters:

syntaxText - the syntax text

recipient - the recipient

Returns:

the readable text

_canSendMailToMentionedUser

protected boolean _canSendMailToMentionedUser(T ametysObject,
 User authorIdentity,
 UserIdentity mentionedUserIdentity)

true if we can send a mail to the mentioned user

Parameters:

ametysObject - the ametys object

authorIdentity - the author

mentionedUserIdentity - the mentioned user

Returns:

true if we can send a mail to the mentioned user

_getMailSubject

protected abstract I18nizableText _getMailSubject(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Retrieves the notification mail's subject

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_getMailMessage

protected abstract I18nizableText _getMailMessage(AbstractNotifyMentionsObserver.MentionableObject mentionableObject)

Retrieves the notification mail's subject

Parameters:

mentionableObject - the mentionable object

Returns:

the notification mail's subject

_getMentionableObjectFromArguments

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

Get all information of the mentionable object from the arguments

Parameters:

arguments - the arguments map

Returns:

the mentionable object

Throws:

Exception - if an error occurs.

_sendMail

protected void _sendMail(User user,
 String subject,
 String body)

Send mail to the given user

Parameters:

user - the user

subject - the mail subject

body - the mail body