Package com.unboundid.directory.sdk.common.types

Enum AlarmSeverity

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AlarmSeverity>
    public enum AlarmSeverity
extends java.lang.Enum<AlarmSeverity>
    Enumerates severity types for alarm conditions from least severe to most severe.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CRITICAL
      Indicates that a service affecting condition has occurred and an immediate corrective action is required.
      MAJOR
      Indicates that a service affecting condition has developed and an urgent corrective action is required.
      MINOR
      Indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault.
      NORMAL
      Indicates that an alarm has been cleared and the alarming condition has returned to normal.
      WARNING
      Indicates the existence of a potential or impending service affecting fault, before any significant effects have been felt.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AlarmSeverity forDisplayName​(java.lang.String displayName)
      Get the alarm severity for the given display name.
      java.lang.String getDisplayName()
      Returns the human-friendly name of this severity.
      static AlarmSeverity valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AlarmSeverity[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NORMAL

        public static final AlarmSeverity NORMAL
        Indicates that an alarm has been cleared and the alarming condition has returned to normal.

        It should be noted that the x733 specification does not define a normal severity but rather lack of an alarm indicates normality. We use this severity for normalized alarms that are retained in the alarm backend as well as for indicating to the SNMP alert handler that an alarm has been cleared, either because its condition has abated or if the server is configured to send interim clear traps between severity changes. The latter use case does not imply that an alarm has returned to normal.

      • WARNING

        public static final AlarmSeverity WARNING
        Indicates the existence of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.

      • MINOR

        public static final AlarmSeverity MINOR
        Indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.

      • MAJOR

        public static final AlarmSeverity MAJOR
        Indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.

      • CRITICAL

        public static final AlarmSeverity CRITICAL
        Indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.

    • Method Detail

      • values

        public static AlarmSeverity[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AlarmSeverity c : AlarmSeverity.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AlarmSeverity valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the human-friendly name of this severity.
        Returns:
        name of this severity.

      • forDisplayName

        public static AlarmSeverity forDisplayName​(java.lang.String displayName)
        Get the alarm severity for the given display name.
        Parameters:
        displayName - Display name for which alarm severity is requested.
        Returns:
        The alarm severity.