Package org.ametys.plugins.workspaces.project.notification

Class NotifyActivityObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.notification.NotifyActivityObserver

All Implemented Interfaces:

AsyncObserver, Observer, LogEnabled, PluginAware, Contextualizable, Serviceable

public class NotifyActivityObserver
extends AbstractLogEnabled
implements AsyncObserver, Serviceable, PluginAware, Contextualizable

Send mail notification to user when a new activity is created

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVITY_CONTEXT_PARAM	the name used to store the activity in the context parameter when generating the notification

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
void	contextualize(Context context)
int	getPriority(Event event)	Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
protected void	notify(Activity activity, AbstractWorkspacesActivityType activityType, List<String> recipients)	Notify email by mail
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 Details

ACTIVITY_CONTEXT_PARAM

public static final String ACTIVITY_CONTEXT_PARAM

the name used to store the activity in the context parameter when generating the notification

See Also:

• Constant Field Values

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

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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.

notify

protected void notify(Activity activity,
 AbstractWorkspacesActivityType activityType,
 List<String> recipients)

Notify email by mail

Parameters:

activity - the activity

activityType - the activityType of the activity

recipients - The users to notify