Package org.ametys.web.activities.observation

Class NotifyActivityObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.activities.observation.NotifyActivityObserver

All Implemented Interfaces:

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

Direct Known Subclasses:

NotifyActivityAsyncObserver

public class NotifyActivityObserver
extends AbstractLogEnabled
implements Observer, Serviceable, PluginAware

Send mail notification to user when a new activity is created

Field Summary

Fields

Modifier and Type	Field	Description
protected ActivityNotifierExtensionPoint	_activityNotifierEP	The activity notifier extension point
protected I18nUtils	_i18nUtils	The i18n utils
protected String	_pluginName	The plugin name
protected AmetysObjectResolver	_resolver	The ametys object resolver

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

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
NotifyActivityObserver()

Method Summary

Modifier and Type	Method	Description
protected boolean	_isSupported(ActivityNotifier notifier, Activity activity)	true if the notifier and the activity are supported
protected void	_notify(ActivityNotifier notifier, Activity activity)	Notify email by mail
int	getPriority()	Get the priority for the component.
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)	Check if an element 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.Observer

getTraits

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_activityNotifierEP

protected ActivityNotifierExtensionPoint _activityNotifierEP

The activity notifier extension point

_pluginName

protected String _pluginName

The plugin name

Constructor Details

NotifyActivityObserver

public NotifyActivityObserver()

Method Details

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

supports

public boolean supports(Event event)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Event>

Parameters:

event - The element

Returns:

true if the element is supported, false otherwise

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.

_isSupported

protected boolean _isSupported(ActivityNotifier notifier,
 Activity activity)

true if the notifier and the activity are supported

Parameters:

notifier - the notifier

activity - the activity

Returns:

true if the notifier and the activity are supported

_notify

protected void _notify(ActivityNotifier notifier,
 Activity activity)

Notify email by mail

Parameters:

notifier - the activity notifier

activity - the activity