Package se.curity.identityserver.sdk.alarm

Interface AlarmDescription

All Superinterfaces:
SerializableAsMap
public interface AlarmDescription extends SerializableAsMap
An AlarmDescription is a hierarchical representation of a textual description of an Alarm. An AlarmHandler specialized in notifying external systems about an alarm should structure this content into a format that is supported and makes sense to the receiving system.
Since:
5.2.0

  • Method Details

    • getDashboardLink

      @Nullable @Nullable String getDashboardLink()
      Returns a dashboard link to a detailed information page about the Alarm in the administration web user interface. Will return null, if the administration web user interface is not enabled and an admin base-url is not defined.
      Returns:
      a dashboard link to the alarm, or null

    • getBriefDescription

      String getBriefDescription()
      Returns a brief description of the Alarm; useful as a headline or for when there are hard size limitations on the information that can be sent or handled.
      Returns:
      a brief description

    • getDetailedDescription

      List<String> getDetailedDescription()
      Returns a detailed description of the Alarm. The detailed description may contain multiple paragraphs, each represented by a String element in the returned list.
      Returns:
      a List of detailed description paragraphs

    • getImpactedResources

      Map<ResourceType,AlarmDescription.ImpactedResourceGroup> getImpactedResources()
      Returns a map of descriptions of the resources impacted by this alarm, organized by resource type.
      Returns:
      a Map of AlarmDescription.ImpactedResourceGroup objects, grouped by ResourceType

    • getSuggestedActions

      List<String> getSuggestedActions()
      Returns a list of suggested actions for troubleshooting and resolving the Alarm.
      Returns:
      a List of suggested actions

    • asMarkdown

      String asMarkdown()
      Returns a Markdown serialization of this AlarmDescription.
      Returns:
      a Markdown serialization of this AlarmDescription

    • asMap

      Map<String,Object> asMap()
      Returns a map of the entire description that can be used for json serializations and similar.
      Specified by:
      asMap in interface SerializableAsMap
      Returns:
      a map of the description