Package com.inductiveautomation.ignition.alarming.notification

Interface AlarmNotificationProfile

All Known Implementing Classes:

AlarmNotificationProfile.DisabledProfile, AlarmNotificationProfile.NoOpProfile

public interface AlarmNotificationProfile

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AlarmNotificationProfile.DisabledProfile
static class	AlarmNotificationProfile.NoOpProfile	No-op implementation of an AlarmNotificationProfile.

Field Summary

Fields

Modifier and Type	Field	Description
static AlarmNotificationProfile	NO_OP_PROFILE	A shared instance of a AlarmNotificationProfile.NoOpProfile.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Returns the user-defined name of this profile.
java.util.Collection<NotificationProfileProperty<?>>	getProperties()	A Collection of ConfigurationPropertys that will be presented to the user during configuration of a notification block in the alarm pipeline UI.
ProfileStatus	getStatus()	Returns information about the running status of the profile.
java.util.Collection<ContactType>	getSupportedContactTypes()
void	onShutdown()	Called when the profile has been removed from AlarmNotificationManager.
void	onStartup()	Called after instantiation and the profile has been added to AlarmNotificationManager.
void	sendNotification(NotificationContext notificationContext)	Notify a list of Users about an alarm using the notification mechanism provided by this profile.
default void	setContextMap(java.util.Map<java.lang.String,java.lang.String> contextMap)	Allows us to pass along a MDC context map for logging.

Field Detail

NO_OP_PROFILE

static final AlarmNotificationProfile NO_OP_PROFILE

A shared instance of a AlarmNotificationProfile.NoOpProfile.

Method Detail

getName

java.lang.String getName()

Returns the user-defined name of this profile.

Returns:

the user-defined name of this profile.

getStatus

ProfileStatus getStatus()

Returns information about the running status of the profile.

Returns:

a ProfileStatus that describes the status of this profile.

sendNotification

void sendNotification(NotificationContext notificationContext)

Notify a list of Users about an alarm using the notification mechanism provided by this profile.

Implementations must be non-blocking and return quickly, using the notificationContext to call back when the notification work has finished.

If some underlying failure in the notification mechanism means no notifications can be sent, use NotificationContext.notificationFailed(com.inductiveautomation.ignition.common.i18n.LocalizedString).

Parameters:

notificationContext - The NotificationContext.

getProperties

java.util.Collection<NotificationProfileProperty<?>> getProperties()

A Collection of ConfigurationPropertys that will be presented to the user during configuration of a notification block in the alarm pipeline UI.

The configured values for these properties will be available in the NotificationContext for each sendNotification(NotificationContext) call to this profile.

Returns:

A Collection of Propertys that sendNotification(NotificationContext) will expect its NotificationContext to have configured.

getSupportedContactTypes

java.util.Collection<ContactType> getSupportedContactTypes()

Returns:

a Collection of ContactTypes that this profile is capable of sending notification to.

onStartup

void onStartup()

Called after instantiation and the profile has been added to AlarmNotificationManager.

onShutdown

void onShutdown()

Called when the profile has been removed from AlarmNotificationManager. This could be an update to the profile (remove+add), a removal, or shutdown of the system.

setContextMap

default void setContextMap(java.util.Map<java.lang.String,java.lang.String> contextMap)

Allows us to pass along a MDC context map for logging. Default behavior is no-op for backwards compatibility

Parameters:

contextMap - Map of MDC key-value pairs. Can be null.