Package pl.edu.icm.unity.engine.api

Interface NotificationsManagement

public interface NotificationsManagement

Management and usage of notifications subsystem (email, sms, ...)

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
void	addNotificationChannel(NotificationChannel toAdd)	Creates a new channel for a given facility.
Map<String,NotificationChannelInfo>	getNotificationChannels()
Map<String,NotificationChannelInfo>	getNotificationChannelsForTechnologies(EnumSet<pl.edu.icm.unity.base.notifications.CommunicationTechnology> facilites)
Set<String>	getNotificationFacilities()
void	removeNotificationChannel(String channelName)	Removes a specified channel.
void	updateNotificationChannel(String channelName, String newConfiguration)	Changes configuration of an existing notification channel.

Method Details

getNotificationFacilities

Set<String> getNotificationFacilities()
                               throws EngineException

Returns:

set with names of all available notification facilities (implementations). E.g. email sender can be a facility.

Throws:

EngineException

addNotificationChannel

void addNotificationChannel(NotificationChannel toAdd)
                     throws EngineException

Creates a new channel for a given facility. E.g. a new email facility configured to use a concrete SMTP server.

Parameters:

toAdd -

Throws:

EngineException

removeNotificationChannel

void removeNotificationChannel(String channelName)
                        throws EngineException

Removes a specified channel.

Parameters:

channelName -

Throws:

EngineException

updateNotificationChannel

void updateNotificationChannel(String channelName,
 String newConfiguration)
                        throws EngineException

Changes configuration of an existing notification channel.

Parameters:

channelName -

newConfiguration -

Throws:

EngineException

getNotificationChannels

Map<String,NotificationChannelInfo> getNotificationChannels()
                                                     throws EngineException

Returns:

map of available notification channels.

Throws:

EngineException

getNotificationChannelsForTechnologies

Map<String,NotificationChannelInfo> getNotificationChannelsForTechnologies(EnumSet<pl.edu.icm.unity.base.notifications.CommunicationTechnology> facilites)
                                                                    throws EngineException

Returns:

get available notification channels which are using given communication technologies.

Throws:

EngineException