Package org.ametys.cms.repository.comment.contributor

Class AbstractNotifyMentionsObserver<T extends AmetysObject>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

Type Parameters:

T - type of the AmetysObject

All Implemented Interfaces:

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

Direct Known Subclasses:

NotifyContentMentionsObserver

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

Abstract observer to send mails to mentioned users in contributor comments of AmetysObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractNotifyMentionsObserver.LinkToAmetysObject	Link to the ametys object

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	The i18n 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 String	_getAmetysObjectTitle(T ametysObject)	Retrieves the string to use to display the ametys object in the email
protected String	_getCommentContentWithReplacedMentions(String commentContent, UserIdentity recipient, Collection<UserIdentity> allMentionedUsers)	Retrieves the given comment content with mentioned replaced by the version to display in notification
protected abstract String	_getLanguage(T ametysObject)	Retrieves the language to use in sent mails
protected abstract AbstractNotifyMentionsObserver.LinkToAmetysObject	_getLinkToAmetysObject(T ametysObject)	Retrieves the notification mail's body link to ametys object
protected I18nizableText	_getMailSubject(T ametysObject)	Retrieves the notification mail's subject
protected Optional<User>	_getUserFromIdentity(UserIdentity userIdentity)	Retrieves the User object from the given UserIdentity
int	getPriority()	Get the priority for the component.
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

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.

_getMailSubject

protected I18nizableText _getMailSubject(T ametysObject)

Retrieves the notification mail's subject

Parameters:

ametysObject - the ametys object

Returns:

the notification mail's subject

_getAmetysObjectTitle

protected String _getAmetysObjectTitle(T ametysObject)

Retrieves the string to use to display the ametys object in the email

Parameters:

ametysObject - the ametysObject

Returns:

the ametys object's title

_getLinkToAmetysObject

protected abstract AbstractNotifyMentionsObserver.LinkToAmetysObject _getLinkToAmetysObject(T ametysObject)

Retrieves the notification mail's body link to ametys object

Parameters:

ametysObject - the ametys object

Returns:

the notification mail's body link

_getCommentContentWithReplacedMentions

protected String _getCommentContentWithReplacedMentions(String commentContent,
 UserIdentity recipient,
 Collection<UserIdentity> allMentionedUsers)

Retrieves the given comment content with mentioned replaced by the version to display in notification

Parameters:

commentContent - the original comment content

recipient - the recipient user identity

allMentionedUsers - all the users mentioned in the comment

Returns:

the content with replaced mentioned

_getUserFromIdentity

protected Optional<User> _getUserFromIdentity(UserIdentity userIdentity)

Retrieves the User object from the given UserIdentity

Parameters:

userIdentity - the user identity

Returns:

the corresponding User object, or an empty optional if the user does not exists

_getLanguage

protected abstract String _getLanguage(T ametysObject)

Retrieves the language to use in sent mails

Parameters:

ametysObject - the ametys object

Returns:

the language to use in sent mails