Package org.ametys.web.repository.comment

Class SendMailToVisitorCommentListener

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.repository.comment.SendMailToVisitorCommentListener

All Implemented Interfaces:

Observer, LogEnabled, PluginAware, Serviceable

public class SendMailToVisitorCommentListener
extends AbstractLogEnabled
implements Observer, Serviceable, PluginAware

Send emails to visitor, when comment is online or removed

Field Summary

Fields

Modifier and Type	Field	Description
protected CommentsDAO	_commentsDAO	The DAO for comments
protected ContentHelper	_contentHelper	The content helper
protected I18nUtils	_i18nUtils	The i18n utils of runtime
protected String	_pluginName	The plugin

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
SendMailToVisitorCommentListener()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_getCommonBodyI18nParams(Content content, Comment comment)	The comment i18n parameters for email notification
private void	_sendCommentDeletedNotificationMail(Content content, String commentId, boolean commentIsValidated, String commentAuthorName, String commentAuthorEmail, String commentContent)
protected void	_sendCommentModifiedNotificationMail(Content content, Comment comment, String commentAuthorName, String commentAuthorEmail, boolean commentIsEmailHidden, String commentAuthorUrl, String commentContent)	Send notification on comment's modification
protected void	_sendCommentUnvalidatedNotificationMail(Content content, Comment comment)	Send notification on comment's unvalidation
protected void	_sendCommentValidatedNotificationMail(Content content, Comment comment)	Send notification on comment's validation
protected void	_sendMail(Content content, Comment comment, String subjectI18nKey, String bodyI18nKey)	Send notification on comment
protected void	_sendMail(Content content, Comment comment, String subjectI18nKey, String bodyI18nKey, List<String> i18nParams)	Send notification on comment to comment's author
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
void	observe(Event event, Map<String,Object> transientVars)	Observes an event.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
boolean	supports(Event event)	Checks if the event is supported.

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

Field Detail

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils of runtime

_contentHelper

protected ContentHelper _contentHelper

The content helper

_pluginName

protected String _pluginName

The plugin

_commentsDAO

protected CommentsDAO _commentsDAO

The DAO for comments

Constructor Detail

SendMailToVisitorCommentListener

public SendMailToVisitorCommentListener()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Specified by:

supports in interface Observer

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

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.

_sendCommentDeletedNotificationMail

private void _sendCommentDeletedNotificationMail(Content content,
                                                 String commentId,
                                                 boolean commentIsValidated,
                                                 String commentAuthorName,
                                                 String commentAuthorEmail,
                                                 String commentContent)

_sendCommentValidatedNotificationMail

protected void _sendCommentValidatedNotificationMail(Content content,
                                                     Comment comment)

Send notification on comment's validation

Parameters:

content - the content

comment - the validated comment

_sendCommentUnvalidatedNotificationMail

protected void _sendCommentUnvalidatedNotificationMail(Content content,
                                                       Comment comment)

Send notification on comment's unvalidation

Parameters:

content - the content

comment - the unvalidated comment

_sendCommentModifiedNotificationMail

protected void _sendCommentModifiedNotificationMail(Content content,
                                                    Comment comment,
                                                    String commentAuthorName,
                                                    String commentAuthorEmail,
                                                    boolean commentIsEmailHidden,
                                                    String commentAuthorUrl,
                                                    String commentContent)

Send notification on comment's modification

Parameters:

content - the content

comment - the modified comment

commentAuthorName - the author's name before modification

commentAuthorEmail - the author's email before modification

commentIsEmailHidden - the email hidden status before modification

commentAuthorUrl - the comment's url before modification

commentContent - the comment's content before modification

_sendMail

protected void _sendMail(Content content,
                         Comment comment,
                         String subjectI18nKey,
                         String bodyI18nKey)

Send notification on comment

Parameters:

content - the content

comment - the modified comment

subjectI18nKey - the i18n for email subject

bodyI18nKey - the i18n for email body

_sendMail

protected void _sendMail(Content content,
                         Comment comment,
                         String subjectI18nKey,
                         String bodyI18nKey,
                         List<String> i18nParams)

Send notification on comment to comment's author

Parameters:

content - the content

comment - the modified comment

subjectI18nKey - the i18n for email subject

bodyI18nKey - the i18n for email body

i18nParams - the i18n parameters

_getCommonBodyI18nParams

protected List<String> _getCommonBodyI18nParams(Content content,
                                                Comment comment)

The comment i18n parameters for email notification

Parameters:

content - the content

comment - the comment

Returns:

the i18n parameters