Package org.odpi.openmetadata.adapters.connectors.integration.openlineage.ffdc

Enum Class OpenLineageIntegrationConnectorAuditCode

java.lang.Object
java.lang.Enum<OpenLineageIntegrationConnectorAuditCode>
org.odpi.openmetadata.adapters.connectors.integration.openlineage.ffdc.OpenLineageIntegrationConnectorAuditCode
All Implemented Interfaces:
Serializable, Comparable<OpenLineageIntegrationConnectorAuditCode>, Constable, AuditLogMessageSet
public enum OpenLineageIntegrationConnectorAuditCode extends Enum<OpenLineageIntegrationConnectorAuditCode> implements AuditLogMessageSet
The OpenLineageIntegrationConnectorAuditCode is used to define the message content for the OMRS 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 relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • KAFKA_RECEIVER_CONFIGURATION

      public static final OpenLineageIntegrationConnectorAuditCode KAFKA_RECEIVER_CONFIGURATION
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-0001 - The {0} integration connector has been initialized to monitor Apache Kafka topic {1} with connection: {2}

    • BAD_KAFKA_RECEIVER_CONFIGURATION

      public static final OpenLineageIntegrationConnectorAuditCode BAD_KAFKA_RECEIVER_CONFIGURATION
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-0002 - The {0} integration connector encountered an {1} exception when opening connector to topic {2} during the {3} method. The exception message included was {4} and the connection was {5}

    • NO_KAFKA_CONNECTION

      public static final OpenLineageIntegrationConnectorAuditCode NO_KAFKA_CONNECTION
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-0003 - The {0} integration connector was passed no embedded open metadata topic connection in its connection properties: {1}

    • NO_KAFKA_TOPIC_NAME

      public static final OpenLineageIntegrationConnectorAuditCode NO_KAFKA_TOPIC_NAME
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-0004 - The {0} integration connector was passed a blank topic name in its connection properties: {1}

    • LISTENING_ON_TOPIC

      public static final OpenLineageIntegrationConnectorAuditCode LISTENING_ON_TOPIC
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-0005 - The {0} integration connector is listening for open lineage events on topic {1}

    • UNEXPECTED_EXCEPTION

      public static final OpenLineageIntegrationConnectorAuditCode UNEXPECTED_EXCEPTION
      OPEN-LINEAGE-INTEGRATION-CONNECTOR-001 - The {0} integration connector received an unexpected {1} exception in method {2} when working with open lineage events; the error message was: {3}

  • Method Details

    • values

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