Package com.inductiveautomation.ignition.gateway.alarming.journal

Interface AlarmJournal

public interface AlarmJournal
Basic interface for the AlarmJournal extension point. Includes some helper methods to aid with storage and filtering.
Since:
8.0.5

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final QualifiedPath
    SYS_ACK_USR_AUTO
    The "user" that will be logged for alarms acknowledged by the system.
    static final QualifiedPath
    SYS_ACK_USR_EVT_LIMIT
    The "user" that will be logged for alarms acknowledged by the live event limit overflowing; see GeneralAlarmSettings

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Name of the journal.
    boolean
    isEnabled()
    Indicates whether the user has chosen to enable the journaling system.
    boolean
    isInitialized()
    Indicates whether the system has properly initialized and can handle events.
    boolean
    isQueryOnly()
    Indicates whether this journal should only be used for querying; if false, storage will not be attempted.
    boolean
    matchesFilter(AlarmEvent alarmEvent)
    Checks if the event matches the filters set up for this alarm journal.
    default boolean
    matchesFilter(String source, String displayPath)
    Checks if the source and the display path for some alarm event match the data filters set up for this alarm journal.
    AlarmQueryResult
    query(AlarmFilter filter)
    Queries the journal and returns the result.
    void
    shutdown()
    Performs any shut down tasks.
    void
    startup()
    Performs any start up tasks.
    void
    storeAlarmEvent(AlarmEvent alarmEvent, AlarmStateTransition transition)
    Shorthand to store an event without extracting every field manually.
    void
    storeJournalEvent(AlarmJournalEvent journalEvent)
    Store an already constructed alarm journal event that originated through the Store and Forward system.
    void
    storeSystemEvent(QualifiedPath eventSource, EventData data)
    Shortcut to store a system event (likely, a constant from AlarmSystemEvent directly.

  • Field Details

    • SYS_ACK_USR_AUTO

      static final QualifiedPath SYS_ACK_USR_AUTO
      The "user" that will be logged for alarms acknowledged by the system.

    • SYS_ACK_USR_EVT_LIMIT

      static final QualifiedPath SYS_ACK_USR_EVT_LIMIT
      The "user" that will be logged for alarms acknowledged by the live event limit overflowing; see GeneralAlarmSettings

  • Method Details

    • startup

      void startup()
      Performs any start up tasks. Called by the AlarmJournalManager.

    • shutdown

      void shutdown()
      Performs any shut down tasks. Called by the AlarmJournalManager.

    • getName

      @Nullable String getName()
      Name of the journal.

    • isEnabled

      boolean isEnabled()
      Indicates whether the user has chosen to enable the journaling system.

    • isQueryOnly

      boolean isQueryOnly()
      Indicates whether this journal should only be used for querying; if false, storage will not be attempted.

    • isInitialized

      boolean isInitialized()
      Indicates whether the system has properly initialized and can handle events.

    • query

      AlarmQueryResult query(@Nonnull AlarmFilter filter) throws Exception
      Queries the journal and returns the result.
      Throws:
      Exception

    • matchesFilter

      boolean matchesFilter(AlarmEvent alarmEvent)
      Checks if the event matches the filters set up for this alarm journal. Returns false if match fails or event is null (or, this journal doesn't support filtering).

    • matchesFilter

      default boolean matchesFilter(String source, String displayPath)
      Checks if the source and the display path for some alarm event match the data filters set up for this alarm journal. Returns false if match fails or the journal doesn't support filtering.

    • storeAlarmEvent

      void storeAlarmEvent(AlarmEvent alarmEvent, AlarmStateTransition transition)
      Shorthand to store an event without extracting every field manually.

    • storeJournalEvent

      void storeJournalEvent(AlarmJournalEvent journalEvent)
      Store an already constructed alarm journal event that originated through the Store and Forward system.

    • storeSystemEvent

      void storeSystemEvent(QualifiedPath eventSource, EventData data)
      Shortcut to store a system event (likely, a constant from AlarmSystemEvent directly.