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

Enum Class BabbageAuditCode

java.lang.Object
java.lang.Enum<BabbageAuditCode>
org.odpi.openmetadata.adapters.connectors.babbage.ffdc.BabbageAuditCode
All Implemented Interfaces:
Serializable, Comparable<BabbageAuditCode>, Constable, AuditLogMessageSet
public enum BabbageAuditCode extends Enum<BabbageAuditCode> implements AuditLogMessageSet
The BabbageAuditCode 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

    • UNEXPECTED_EXCEPTION

      public static final BabbageAuditCode UNEXPECTED_EXCEPTION
      BABBAGE-ANALYTICAL-ENGINE-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • CONNECTOR_STOPPING

      public static final BabbageAuditCode CONNECTOR_STOPPING
      BABBAGE-ANALYTICAL-ENGINE-0009 - The {0} integration connector has stopped its monitoring of engine actions from server {1} on platform {2} and is shutting down

    • STARTING_CONNECTOR

      public static final BabbageAuditCode STARTING_CONNECTOR
      BABBAGE-ANALYTICAL-ENGINE-0011 - The {0} integration connector is starting its monitoring for analytical work from server {1} on platform {2}

    • NEW_ENGINE_ACTION

      public static final BabbageAuditCode NEW_ENGINE_ACTION
      BABBAGE-ANALYTICAL-ENGINE-0012 - The {0} integration connector has created a new engine action {1} for Governance Action Type {2} ({3})

  • Method Details

    • values

      public static BabbageAuditCode[] 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 BabbageAuditCode 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<BabbageAuditCode>
      Returns:
      string of property names and values for this enum