Class AlertStatusManager
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.alert.AlertStatusManager
-
public abstract class AlertStatusManager extends java.lang.Object
An AlertStatusManager is part of the AlertBus system and receives/stores all alert messages posted to the bus. The manager can be queried to retrieve the current state of all alerts.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
LOG_BASE_NAME
The base logger name for the alert status system.
-
Constructor Summary
Constructors Constructor Description AlertStatusManager()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.util.List<AlertEvent>
query(AlertEventFilterParams filterParams, boolean flatten)
Queries the alert status manager for any records that match the given filter elements.
-
-
-
Field Detail
-
LOG_BASE_NAME
public static final java.lang.String LOG_BASE_NAME
The base logger name for the alert status system. Subsystems and sub elements should build off this name.- See Also:
- Constant Field Values
-
-
Method Detail
-
query
public abstract java.util.List<AlertEvent> query(AlertEventFilterParams filterParams, boolean flatten) throws java.lang.Exception
Queries the alert status manager for any records that match the given filter elements. All filter arguments can be null, which means to not filter by that field. String based filters can include a wildcard character of '%' which means any characters (zero or more)- Parameters:
filterParams
- The AlertEventFilterParams object containing:- system filter
- path filter
- state name filter
- min severity filter
- max severity filter
- active filter
- ackowledged filter
flatten
- Return highest state or all states for a given alert- Returns:
- A list of AlertEvent objects
- Throws:
java.lang.Exception
-
-