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

Enum Class BaudotAuditCode

java.lang.Object
java.lang.Enum<BaudotAuditCode>
org.odpi.openmetadata.adapters.connectors.baudot.ffdc.BaudotAuditCode
All Implemented Interfaces:
Serializable, Comparable<BaudotAuditCode>, Constable, AuditLogMessageSet
public enum BaudotAuditCode extends Enum<BaudotAuditCode> implements AuditLogMessageSet
The BaudotAuditCode is used to define the message content for the Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - 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

    • MONITORED_RESOURCE_NOTIFICATION_TYPE

      public static final BaudotAuditCode MONITORED_RESOURCE_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0002 - The {0} governance service is refreshing its cache for configured notification type {1} ({2}) where notifications are triggered by changes to its monitored resources. {3} monitored resources are currently registered

    • ONE_TIME_NOTIFICATION_TYPE

      public static final BaudotAuditCode ONE_TIME_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0003 - The {0} governance service is refreshing its cache for configured notification type {1} ({2}) where only one notification is sent to each subscriber

    • PERIODIC_NOTIFICATION_TYPE

      public static final BaudotAuditCode PERIODIC_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0005 - The {0} governance service is refreshing its cache for configured notification type {1} ({2}) where a notification is sent to each subscriber on a regular schedule every {3} minutes. The next scheduled notification will be sent at {4}

    • UNREADABLE_NOTIFICATION_TYPE

      public static final BaudotAuditCode UNREADABLE_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0011 - The {0} governance service is not monitoring notification type {1} ({2}) because it could not be retrieved, or is not a notification type

    • NOTIFICATION_TYPE_NOT_STARTED

      public static final BaudotAuditCode NOTIFICATION_TYPE_NOT_STARTED
      BAUDOT-SUBSCRIPTION-MANAGER-0012 - The {0} governance service is not yet monitoring notification type {1} because it is planned to start at {2}

    • CACHE_REFRESHED

      public static final BaudotAuditCode CACHE_REFRESHED
      BAUDOT-SUBSCRIPTION-MANAGER-0013 - The {0} governance service refreshed its caches: {1} notification type(s) configured, {2} being monitored for the first time by this service

  • Method Details

    • values

      public static BaudotAuditCode[] 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 BaudotAuditCode 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 AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition 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 AuditLogMessageSet
      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<BaudotAuditCode>
      Returns:
      string of property names and values for this enum