public interface AlarmNotificationProfile
Modifier and Type | Interface and Description |
---|---|
static class |
AlarmNotificationProfile.DisabledProfile |
static class |
AlarmNotificationProfile.NoOpProfile
No-op implementation of an AlarmNotificationProfile.
|
Modifier and Type | Field and Description |
---|---|
static AlarmNotificationProfile |
NO_OP_PROFILE
A shared instance of a
AlarmNotificationProfile.NoOpProfile . |
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 CategorizedProperty s 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.
|
static final AlarmNotificationProfile NO_OP_PROFILE
AlarmNotificationProfile.NoOpProfile
.java.lang.String getName()
ProfileStatus getStatus()
ProfileStatus
that describes the status of this profile.void sendNotification(NotificationContext notificationContext)
NotificationContext.notificationFailed(com.inductiveautomation.ignition.common.i18n.LocalizedString)
.notificationContext
- The NotificationContext
.java.util.Collection<NotificationProfileProperty<?>> getProperties()
Collection
of CategorizedProperty
s 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.Collection
of Property
s that sendNotification(NotificationContext)
will
expect its NotificationContext
to have configured.java.util.Collection<ContactType> getSupportedContactTypes()
Collection
of ContactType
s that this profile is capable of sending notification to.void onStartup()
AlarmNotificationManager
.void onShutdown()
AlarmNotificationManager
. This could be an update to the
profile (remove+add), a removal, or shutdown of the system.default void setContextMap(java.util.Map<java.lang.String,java.lang.String> contextMap)
contextMap
- Map of MDC key-value pairs. Can be null.