Package org.odpi.openmetadata.adapters.connectors.baudot

Enum Class BaudotNotificationMessageSet

java.lang.Object
java.lang.Enum<BaudotNotificationMessageSet>
org.odpi.openmetadata.adapters.connectors.baudot.BaudotNotificationMessageSet
All Implemented Interfaces:
Serializable, Comparable<BaudotNotificationMessageSet>, Constable, MessageSet
public enum BaudotNotificationMessageSet extends Enum<BaudotNotificationMessageSet> implements MessageSet
The BaudotNotificationMessageSet is used to define the message content for the notifications from Baudot. The 5 fields in the enum are:
  • Log Message Id - to uniquely identify the message
  • Severity - is this an event, decision, action, error, or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data for the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • NEW_SUBSCRIBER

      public static final BaudotNotificationMessageSet NEW_SUBSCRIBER
      BAUDOT-SUBSCRIPTION-MANAGEMENT-0001 - Welcome to your subscription for subscription type: {0} ({1})

    • CANCELLED_SUBSCRIBER

      public static final BaudotNotificationMessageSet CANCELLED_SUBSCRIBER
      BAUDOT-SUBSCRIPTION-MANAGEMENT-0002 - The subscription for the following subscription type has been terminated: {0} ({1})

    • MONITORED_RESOURCE_CHANGED

      public static final BaudotNotificationMessageSet MONITORED_RESOURCE_CHANGED
      BAUDOT-SUBSCRIPTION-MANAGEMENT-0003 - The monitored {0} resource {1} ({2}) has changed for subscription type: {3} ({4})

    • ONE_TIME_NOTIFICATION

      public static final BaudotNotificationMessageSet ONE_TIME_NOTIFICATION
      BAUDOT-SUBSCRIPTION-MANAGEMENT-0004 - Your subscription to subscription type {0} ({1}) has been triggered

    • PERIODIC_NOTIFICATION

      public static final BaudotNotificationMessageSet PERIODIC_NOTIFICATION
      BAUDOT-SUBSCRIPTION-MANAGEMENT-0005 - A regular notification for subscription type {0} ({1}) has been triggered. It will trigger again in {2} milliseconds

  • Method Details

    • values

      public static BaudotNotificationMessageSet[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BaudotNotificationMessageSet valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public MessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface MessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public MessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface MessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<BaudotNotificationMessageSet>
      Returns:
      string of property names and values for this enum