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

Enum Class KafkaIntegrationConnectorAuditCode

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BAD_CONFIGURATION
    KAFKA-INTEGRATION-CONNECTOR-0002 - The {0} integration connector encountered an {1} exception when opening event broker {2} during the {3} method.
    CONNECTOR_CONFIGURATION
    KAFKA-INTEGRATION-CONNECTOR-0001 - The {0} integration connector has been initialized to monitor event broker at URL {1} with templateQualifiedName={2}
    CONNECTOR_STOPPING
    KAFKA-INTEGRATION-CONNECTOR-0009 - The {0} integration connector has stopped its topic monitoring and is shutting down
    MISSING_TEMPLATE
    KAFKA-INTEGRATION-CONNECTOR-0015 - The {0} integration connector is unable to retrieve the Topic template with qualified name: {1}
    RETRIEVED_TOPICS
    KAFKA-INTEGRATION-CONNECTOR-0005 - The {0} integration connector has retrieved {2} topics from {1}
    TOPIC_ARCHIVED
    KAFKA-INTEGRATION-CONNECTOR-0020 - The {0} integration connector has archived the Topic {1} ({2}) because the real-world topic is no longer stored in the event broker
    TOPIC_CREATED
    KAFKA-INTEGRATION-CONNECTOR-0016 - The {0} integration connector created the Topic {1} ({2}) for a new real-world topic
    TOPIC_CREATED_FROM_TEMPLATE
    KAFKA-INTEGRATION-CONNECTOR-0017 - The {0} integration connector created the Topic {1} ({2}) for a new real-world topic using template {3} ({4})
    TOPIC_DELETED
    KAFKA-INTEGRATION-CONNECTOR-0019 - The {0} integration connector has deleted the Topic {1} ({2}) because the real-world topic is no longer defined in the event broker
    TOPIC_UPDATED
    KAFKA-INTEGRATION-CONNECTOR-0018 - The {0} integration connector has updated the Topic {1} ({2}) because the real-world topic changed
    UNABLE_TO_RETRIEVE_TOPICS
    KAFKA-INTEGRATION-CONNECTOR-0004 - The {0} integration connector received an unexpected {2} exception when retrieving topics from event broker at {1}.
    UNEXPECTED_EXC_TOPIC_UPDATE
    KAFKA-INTEGRATION-CONNECTOR-0014 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the Topic in the metadata repositories for topic {2}.

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static KafkaIntegrationConnectorAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static KafkaIntegrationConnectorAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CONNECTOR_CONFIGURATION

      public static final KafkaIntegrationConnectorAuditCode CONNECTOR_CONFIGURATION
      KAFKA-INTEGRATION-CONNECTOR-0001 - The {0} integration connector has been initialized to monitor event broker at URL {1} with templateQualifiedName={2}

    • BAD_CONFIGURATION

      public static final KafkaIntegrationConnectorAuditCode BAD_CONFIGURATION
      KAFKA-INTEGRATION-CONNECTOR-0002 - The {0} integration connector encountered an {1} exception when opening event broker {2} during the {3} method. The exception message included was {4}

    • UNABLE_TO_RETRIEVE_TOPICS

      public static final KafkaIntegrationConnectorAuditCode UNABLE_TO_RETRIEVE_TOPICS
      KAFKA-INTEGRATION-CONNECTOR-0004 - The {0} integration connector received an unexpected {2} exception when retrieving topics from event broker at {1}. The error message was {3}

    • RETRIEVED_TOPICS

      public static final KafkaIntegrationConnectorAuditCode RETRIEVED_TOPICS
      KAFKA-INTEGRATION-CONNECTOR-0005 - The {0} integration connector has retrieved {2} topics from {1}

    • CONNECTOR_STOPPING

      public static final KafkaIntegrationConnectorAuditCode CONNECTOR_STOPPING
      KAFKA-INTEGRATION-CONNECTOR-0009 - The {0} integration connector has stopped its topic monitoring and is shutting down

    • UNEXPECTED_EXC_TOPIC_UPDATE

      public static final KafkaIntegrationConnectorAuditCode UNEXPECTED_EXC_TOPIC_UPDATE
      KAFKA-INTEGRATION-CONNECTOR-0014 - An unexpected {0} exception was returned to the {1} integration connector when it tried to update the Topic in the metadata repositories for topic {2}. The error message was {3}

    • MISSING_TEMPLATE

      public static final KafkaIntegrationConnectorAuditCode MISSING_TEMPLATE
      KAFKA-INTEGRATION-CONNECTOR-0015 - The {0} integration connector is unable to retrieve the Topic template with qualified name: {1}

    • TOPIC_CREATED

      public static final KafkaIntegrationConnectorAuditCode TOPIC_CREATED
      KAFKA-INTEGRATION-CONNECTOR-0016 - The {0} integration connector created the Topic {1} ({2}) for a new real-world topic

    • TOPIC_CREATED_FROM_TEMPLATE

      public static final KafkaIntegrationConnectorAuditCode TOPIC_CREATED_FROM_TEMPLATE
      KAFKA-INTEGRATION-CONNECTOR-0017 - The {0} integration connector created the Topic {1} ({2}) for a new real-world topic using template {3} ({4})

    • TOPIC_UPDATED

      public static final KafkaIntegrationConnectorAuditCode TOPIC_UPDATED
      KAFKA-INTEGRATION-CONNECTOR-0018 - The {0} integration connector has updated the Topic {1} ({2}) because the real-world topic changed

    • TOPIC_DELETED

      public static final KafkaIntegrationConnectorAuditCode TOPIC_DELETED
      KAFKA-INTEGRATION-CONNECTOR-0019 - The {0} integration connector has deleted the Topic {1} ({2}) because the real-world topic is no longer defined in the event broker

    • TOPIC_ARCHIVED

      public static final KafkaIntegrationConnectorAuditCode TOPIC_ARCHIVED
      KAFKA-INTEGRATION-CONNECTOR-0020 - The {0} integration connector has archived the Topic {1} ({2}) because the real-world topic is no longer stored in the event broker

  • Method Details

    • values

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