Package com.inductiveautomation.ignition.gateway.alert.storage

Class AlertStorageProfile

  • All Implemented Interfaces:
    AlertMessageHandler
    public abstract class AlertStorageProfile
extends java.lang.Object
implements AlertMessageHandler
    AlertStorageProfile is an interface all alert storage implementations must follow

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.util.List<AlertEvent> query​(AlertEventFilterParams filterParams, java.util.Date startTimestampFilter, java.util.Date endTimestampFilter, java.lang.String sortOrder)
      Queries the alert storage profile for any records that match the given filter elements.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AlertStorageProfile

        public AlertStorageProfile()

    • Method Detail

      • query

        public abstract java.util.List<AlertEvent> query​(AlertEventFilterParams filterParams,
                                                 java.util.Date startTimestampFilter,
                                                 java.util.Date endTimestampFilter,
                                                 java.lang.String sortOrder)
                                          throws java.lang.Exception
        Queries the alert storage profile 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
        startTimestampFilter - Matches any alerts who's active time is greater than or equal to the given filter, if specified
        endTimestampFilter - Matches any alerts who's active time is less than or equal to the given filter, if specified
        sortOrder - Either "asc" or "desc". If not understood, will default to "desc"
        Returns:
        A list of AlertEvent objects
        Throws:
        java.lang.Exception