Package com.inductiveautomation.ignition.gateway.alert.notification

Class AlertNotificationManager

java.lang.Object

com.inductiveautomation.ignition.gateway.alert.notification.AlertNotificationManager

All Implemented Interfaces:

ExtensionPointManager

public abstract class AlertNotificationManager
extends Object
implements ExtensionPointManager

The AlertNotificationManager keeps track of all AlertNotificationProfiles

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_BASE_NAME	The base logger name for the alert notification system.

Constructor Summary

Constructors

Constructor	Description
AlertNotificationManager()

Method Summary

Modifier and Type	Method	Description
abstract void	addAlertNotificationProfileType(AlertNotificationProfileType type)	Adds a new type of alert notification profile to the system.
abstract AlertNotificationProfile	getProfile(long id)
abstract AlertNotificationProfile	getProfileForProject(String projectName)	Returns the alert notification profile (or null if none is defined) for a specific project.
abstract Collection<AlertNotificationProfile>	getProfiles()
abstract void	publishAlarm(AlarmEvent event, AlarmStateTransition transition)	This function is used to bridge between the newer alarm events and this legacy notification manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager

getExtensionPoint, getExtensionPoints

Field Details

LOG_BASE_NAME

public static final String LOG_BASE_NAME

The base logger name for the alert notification system. Subsystems and sub elements should build off this name.

See Also:

• Constant Field Values

Constructor Details

AlertNotificationManager

public AlertNotificationManager()

Method Details

getProfileForProject

public abstract AlertNotificationProfile getProfileForProject(String projectName)

Returns the alert notification profile (or null if none is defined) for a specific project.

getProfile

public abstract AlertNotificationProfile getProfile(long id)
                                             throws Exception

Throws:

Exception

getProfiles

public abstract Collection<AlertNotificationProfile> getProfiles()

addAlertNotificationProfileType

public abstract void addAlertNotificationProfileType(AlertNotificationProfileType type)
                                              throws Exception

Adds a new type of alert notification profile to the system. Also makes sure that the persistent settings record indicated in the type is known by the internal schema manager

Parameters:

type - The new type of alert notification profile to add.

Throws:

Exception - If automatic schema updating fails.

publishAlarm

public abstract void publishAlarm(AlarmEvent event,
 AlarmStateTransition transition)

This function is used to bridge between the newer alarm events and this legacy notification manager.