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(pl.edu.icm.unity.types.basic.NotificationChannel toAdd)	Creates a new channel for a given facility.
java.util.Map<java.lang.String,pl.edu.icm.unity.types.basic.NotificationChannelInfo>	getNotificationChannels()
java.util.Map<java.lang.String,pl.edu.icm.unity.types.basic.NotificationChannelInfo>	getNotificationChannelsForTechnologies(java.util.EnumSet<pl.edu.icm.unity.base.notifications.CommunicationTechnology> facilites)
java.util.Set<java.lang.String>	getNotificationFacilities()
void	removeNotificationChannel(java.lang.String channelName)	Removes a specified channel.
void	updateNotificationChannel(java.lang.String channelName, java.lang.String newConfiguration)	Changes configuration of an existing notification channel.

Method Detail

getNotificationFacilities

java.util.Set<java.lang.String> getNotificationFacilities()
                                                   throws pl.edu.icm.unity.exceptions.EngineException

Returns:

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

Throws:

pl.edu.icm.unity.exceptions.EngineException

addNotificationChannel

void addNotificationChannel(pl.edu.icm.unity.types.basic.NotificationChannel toAdd)
                     throws pl.edu.icm.unity.exceptions.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:

pl.edu.icm.unity.exceptions.EngineException

removeNotificationChannel

void removeNotificationChannel(java.lang.String channelName)
                        throws pl.edu.icm.unity.exceptions.EngineException

Removes a specified channel.

Parameters:

channelName -

Throws:

pl.edu.icm.unity.exceptions.EngineException

updateNotificationChannel

void updateNotificationChannel(java.lang.String channelName,
                               java.lang.String newConfiguration)
                        throws pl.edu.icm.unity.exceptions.EngineException

Changes configuration of an existing notification channel.

Parameters:

channelName -

newConfiguration -

Throws:

pl.edu.icm.unity.exceptions.EngineException

getNotificationChannels

java.util.Map<java.lang.String,pl.edu.icm.unity.types.basic.NotificationChannelInfo> getNotificationChannels()
                                                                                                            throws pl.edu.icm.unity.exceptions.EngineException

Returns:

map of available notification channels.

Throws:

pl.edu.icm.unity.exceptions.EngineException

getNotificationChannelsForTechnologies

java.util.Map<java.lang.String,pl.edu.icm.unity.types.basic.NotificationChannelInfo> getNotificationChannelsForTechnologies(java.util.EnumSet<pl.edu.icm.unity.base.notifications.CommunicationTechnology> facilites)
                                                                                                                           throws pl.edu.icm.unity.exceptions.EngineException

Returns:

get available notification channels which are using given communication technologies.

Throws:

pl.edu.icm.unity.exceptions.EngineException