Package se.curity.identityserver.sdk.alarm

Interface Alarm

public interface Alarm
This class represents an alarm raised in the system.
Since:
5.2.0

  • Method Details

    • getAlarmIdentifier

      AlarmIdentifier getAlarmIdentifier()
      Returns the AlarmIdentifier identifying the alarm.
      Returns:
      the identifier for this alarm

    • getUpdated

      Instant getUpdated()
      Returns the last update of this alarm.
      Returns:
      the Instant this alarm was last updated

    • getSeverity

      AlarmSeverity getSeverity()
      Returns the perceived severity of the alarm.
      Returns:
      the AlarmSeverity of this alarm
      See Also:

    • isCleared

      boolean isCleared()
      Returns the cleared status of this alarm.
      Returns:
      true if this alarm is cleared, false otherwise

    • isSelfTest

      boolean isSelfTest()
      Returns true if this alarm has been triggered synthetically to test the alarm subsystem and all configured AlarmHandler.
      Returns:
      true if the alarm is a self-test alarm

    • getDescription

      AlarmDescription getDescription()
      Returns the alarm text - a human-readable description of the cause of the alarm.
      Returns:
      the description of this alarm