Package org.ametys.plugins.ugc.observation

Class AbstractUGCContentObserver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.ugc.observation.AbstractUGCContentObserver

All Implemented Interfaces:

Observer, Prioritizable, Supporter<Event>, Configurable, LogEnabled, Serviceable

Direct Known Subclasses:

UGCContentRefusedObserver, UGCContentValidatedObserver

public abstract class AbstractUGCContentObserver
extends AbstractLogEnabled
implements Observer, Serviceable, Configurable

Abstract observer to send mail to UGC author on UGC content event

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_bodyI18nKey	The i18n key for mail body
protected ContentTypesHelper	_cTypeHelper	The content type helper
protected I18nUtils	_i18nUtils	The i18n utils
protected String	_subjectI18nKey	The i18n key for mail subject
protected UserLanguagesManager	_userLanguagesManager	The user languages manager
protected UserManager	_userManager	The user manager

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractUGCContentObserver()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected Map<String,I18nizableTextParameter>	getBodyI18nParams(Content ugcContent, String comment)	Get the i18n parameters for mail body
protected String	getMailBody(Content ugcContent, String comment, String language)	Get the mail body
protected String	getMailLanguage(Content ugcContent)	Get the mail language
protected String	getMailSubject(Content ugcContent, String language)	Get the mail subject
int	getPriority()	Get the priority for the component.
protected Map<String,I18nizableTextParameter>	getSubjectI18nParams(Content ugcContent)	Get the i18n parameters for mail subject
protected void	sendMailToUGCAuthor(Content ugcContent, String comment)	Send mail to the UGC author
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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.Observer

getTraits, observe

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

supports

Field Details

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content type helper

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_userManager

protected UserManager _userManager

The user manager

_userLanguagesManager

protected UserLanguagesManager _userLanguagesManager

The user languages manager

_subjectI18nKey

protected String _subjectI18nKey

The i18n key for mail subject

_bodyI18nKey

protected String _bodyI18nKey

The i18n key for mail body

Constructor Details

AbstractUGCContentObserver

public AbstractUGCContentObserver()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

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

sendMailToUGCAuthor

protected void sendMailToUGCAuthor(Content ugcContent,
 String comment)

Send mail to the UGC author

Parameters:

ugcContent - The UGC content

comment - The comment. Can be null.

getMailLanguage

protected String getMailLanguage(Content ugcContent)

Get the mail language

Parameters:

ugcContent - The UGC content

Returns:

the language to use in the mail or null if none was found

getMailSubject

protected String getMailSubject(Content ugcContent,
 String language)

Get the mail subject

Parameters:

ugcContent - The UGC content

language - The language to use

Returns:

the mail text subject

getMailBody

protected String getMailBody(Content ugcContent,
 String comment,
 String language)

Get the mail body

Parameters:

ugcContent - The UGC content

comment - The comment. Can be null.

language - The language to use

Returns:

the mail text body

getSubjectI18nParams

protected Map<String,I18nizableTextParameter> getSubjectI18nParams(Content ugcContent)

Get the i18n parameters for mail subject

Parameters:

ugcContent - The UGC content

Returns:

the i18n parameters for mail subject

getBodyI18nParams

protected Map<String,I18nizableTextParameter> getBodyI18nParams(Content ugcContent,
 String comment)

Get the i18n parameters for mail body

Parameters:

ugcContent - The UGC content

comment - The comment. Can be null.

Returns:

the i18n parameters for mail body