com.inductiveautomation.ignition.alarming.notification

Class AlarmNotificationProfile.NoOpProfile

java.lang.Object

com.inductiveautomation.ignition.alarming.notification.AlarmNotificationProfile.NoOpProfile

All Implemented Interfaces:

AlarmNotificationProfile

Enclosing interface:

AlarmNotificationProfile

public static class AlarmNotificationProfile.NoOpProfile
extends java.lang.Object
implements AlarmNotificationProfile

No-op implementation of an AlarmNotificationProfile.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.alarming.notification.AlarmNotificationProfile

AlarmNotificationProfile.DisabledProfile, AlarmNotificationProfile.NoOpProfile

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.alarming.notification.AlarmNotificationProfile

NO_OP_PROFILE

Constructor Summary

Constructors

Constructor and Description
NoOpProfile(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the user-defined name of this profile.
java.util.Collection<NotificationProfileProperty<?>>	getProperties() A Collection of CategorizedPropertys 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpProfile

public NoOpProfile(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: AlarmNotificationProfile

Returns the user-defined name of this profile.

Specified by:

getName in interface AlarmNotificationProfile

Returns:

the user-defined name of this profile.

getStatus

public ProfileStatus getStatus()

Description copied from interface: AlarmNotificationProfile

Returns information about the running status of the profile.

Specified by:

getStatus in interface AlarmNotificationProfile

Returns:

a ProfileStatus that describes the status of this profile.

sendNotification

public void sendNotification(NotificationContext notificationContext)

Description copied from interface: AlarmNotificationProfile

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).

Specified by:

sendNotification in interface AlarmNotificationProfile

Parameters:

notificationContext - The NotificationContext.

getProperties

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

Description copied from interface: AlarmNotificationProfile

A Collection of CategorizedPropertys 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 AlarmNotificationProfile.sendNotification(NotificationContext) call to this profile.

Specified by:

getProperties in interface AlarmNotificationProfile

Returns:

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

getSupportedContactTypes

public java.util.Collection<ContactType> getSupportedContactTypes()

Specified by:

getSupportedContactTypes in interface AlarmNotificationProfile

Returns:

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

onStartup

public void onStartup()

Description copied from interface: AlarmNotificationProfile

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

Specified by:

onStartup in interface AlarmNotificationProfile

onShutdown

public void onShutdown()

Description copied from interface: AlarmNotificationProfile

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.

Specified by:

onShutdown in interface AlarmNotificationProfile