org.ametys.plugins.workspaces.project.notification

Class AddMemberMailNotifierObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.notification.AddMemberMailNotifierObserver

All Implemented Interfaces:

AsyncObserver, Observer, LogEnabled, PluginAware, Serviceable

public class AddMemberMailNotifierObserver
extends AbstractLogEnabled
implements AsyncObserver, PluginAware, Serviceable

Notifier to send mail to a newly added member of a workspace.

Field Summary

Fields

Modifier and Type	Field and Description
protected GroupManager	_groupManager The group manager
protected I18nUtils	_i18nUtils The i18n utils
protected String	_pluginName The name of current plugin
protected PopulationContextHelper	_populationContextHelper The population context helper
protected ProjectMemberManager	_projectMemberManager The project member manager
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 and Description
AddMemberMailNotifierObserver()

Method Summary

Modifier and Type	Method and Description
protected I18nizableText	_getBodyI18nizableText(Project project, JCRProjectMember member) Gets the I18nizableText for body of the mail
protected String	_getBodyI18nKey() Gets the i18n body key
protected List<String>	_getBodyParams(Project project, JCRProjectMember jcrMember) Gets the i18n parameters for body key
private JCRProjectMember	_getMember(String memberId)
protected I18nizableText	_getSubjectI18nizableText(Project project, JCRProjectMember member) Gets the I18nizableText for subject of the mail
protected String	_getSubjectI18nKey() Gets the i18n subject key
protected List<String>	_getSubjectParams(Project project, JCRProjectMember member) Gets the i18n parameters for subject key
protected String	_getUrl(Project project) Gets the URL of the project
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

Methods inherited from interface org.ametys.core.observation.AsyncObserver

parallelizable

Field Detail

_pluginName

protected String _pluginName

The name of current plugin

_resolver

protected AmetysObjectResolver _resolver

The Ametys Object resolver

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_userManager

protected UserManager _userManager

The user manager

_groupManager

protected GroupManager _groupManager

The group manager

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper

_projectMemberManager

protected ProjectMemberManager _projectMemberManager

The project member manager

Constructor Detail

AddMemberMailNotifierObserver

public AddMemberMailNotifierObserver()

Method Detail

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

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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.

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.

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.

_getMember

private JCRProjectMember _getMember(String memberId)

_getSubjectI18nizableText

protected I18nizableText _getSubjectI18nizableText(Project project,
                                                   JCRProjectMember member)

Gets the I18nizableText for subject of the mail

Parameters:

project - the project

member - the member

Returns:

the subject

_getSubjectI18nKey

protected String _getSubjectI18nKey()

Gets the i18n subject key

Returns:

the i18n subject key

_getSubjectParams

protected List<String> _getSubjectParams(Project project,
                                         JCRProjectMember member)

Gets the i18n parameters for subject key

Parameters:

project - the project

member - the member

Returns:

the i18n parameters

_getBodyI18nizableText

protected I18nizableText _getBodyI18nizableText(Project project,
                                                JCRProjectMember member)

Gets the I18nizableText for body of the mail

Parameters:

project - the project

member - the member

Returns:

the body

_getBodyI18nKey

protected String _getBodyI18nKey()

Gets the i18n body key

Returns:

the i18n body key

_getBodyParams

protected List<String> _getBodyParams(Project project,
                                      JCRProjectMember jcrMember)

Gets the i18n parameters for body key

Parameters:

project - the project

jcrMember - the member

Returns:

the i18n parameters

_getUrl

protected String _getUrl(Project project)

Gets the URL of the project

Parameters:

project - The project

Returns:

the URL of the project