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

Enum Class JDBCIntegrationConnectorErrorCode

java.lang.Object
java.lang.Enum<JDBCIntegrationConnectorErrorCode>
org.odpi.openmetadata.adapters.connectors.integration.jdbc.ffdc.JDBCIntegrationConnectorErrorCode
All Implemented Interfaces:
Serializable, Comparable<JDBCIntegrationConnectorErrorCode>, Constable, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
public enum JDBCIntegrationConnectorErrorCode extends Enum<JDBCIntegrationConnectorErrorCode> implements org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
The JDBCErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Kafka monitor integration connector. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. The 5 fields in the enum are:
  • HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
    • 500 - internal error
    • 400 - invalid parameters
    • 404 - not found
    • 409 - data conflict errors - eg item already defined
  • Error Message Identifier - to uniquely identify the message
  • Error Message Text - includes placeholder to allow additional values to be captured
  • SystemAction - describes the result of the error
  • UserAction - describes how a consumer should correct the error

  • 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
    CATEGORY_ALREADY_EXISTS
    JDBC-INTEGRATION-CONNECTOR-400-004 - Glossary category {0} already exists in Apache Atlas
    CLIENT_SIDE_REST_API_ERROR
    JDBC-INTEGRATION-CONNECTOR-503-001 - A client-side exception {0} was received from API call {1} to URL {2}.
    MISSING_CORRELATION
    JDBC-INTEGRATION-CONNECTOR-0036 - The {0} integration connector can not retrieve the correlation information for (1} open metadata entity {2} linked in Apache Atlas {3} to {4} entity {5}
    NULL_ASSET_MANAGER
    JDBC-INTEGRATION-CONNECTOR-400-003 - Integration connector {0} has been configured without a metadataSourceQualifiedName value
    NULL_URL
    JDBC-INTEGRATION-CONNECTOR-400-001 - Integration connector {0} has been configured without the URL to Apache Atlas
    NULL_USER
    JDBC-INTEGRATION-CONNECTOR-400-002 - Integration connector {0} has been configured with either a null userId or password for connecting to Apache Atlas
    TERM_ALREADY_EXISTS
    JDBC-INTEGRATION-CONNECTOR-400-005 - Glossary term {0} already exists in Apache Atlas
    UNEXPECTED_EXCEPTION
    JDBC-INTEGRATION-CONNECTOR-500-001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for an exception.
    org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for an exception.
    String
    toString()
    JSON-style toString
    static JDBCIntegrationConnectorErrorCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static JDBCIntegrationConnectorErrorCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NULL_URL

      public static final JDBCIntegrationConnectorErrorCode NULL_URL
      JDBC-INTEGRATION-CONNECTOR-400-001 - Integration connector {0} has been configured without the URL to Apache Atlas

    • NULL_USER

      public static final JDBCIntegrationConnectorErrorCode NULL_USER
      JDBC-INTEGRATION-CONNECTOR-400-002 - Integration connector {0} has been configured with either a null userId or password for connecting to Apache Atlas

    • NULL_ASSET_MANAGER

      public static final JDBCIntegrationConnectorErrorCode NULL_ASSET_MANAGER
      JDBC-INTEGRATION-CONNECTOR-400-003 - Integration connector {0} has been configured without a metadataSourceQualifiedName value

    • CATEGORY_ALREADY_EXISTS

      public static final JDBCIntegrationConnectorErrorCode CATEGORY_ALREADY_EXISTS
      JDBC-INTEGRATION-CONNECTOR-400-004 - Glossary category {0} already exists in Apache Atlas

    • TERM_ALREADY_EXISTS

      public static final JDBCIntegrationConnectorErrorCode TERM_ALREADY_EXISTS
      JDBC-INTEGRATION-CONNECTOR-400-005 - Glossary term {0} already exists in Apache Atlas

    • MISSING_CORRELATION

      public static final JDBCIntegrationConnectorErrorCode MISSING_CORRELATION
      JDBC-INTEGRATION-CONNECTOR-0036 - The {0} integration connector can not retrieve the correlation information for (1} open metadata entity {2} linked in Apache Atlas {3} to {4} entity {5}

    • UNEXPECTED_EXCEPTION

      public static final JDBCIntegrationConnectorErrorCode UNEXPECTED_EXCEPTION
      JDBC-INTEGRATION-CONNECTOR-500-001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • CLIENT_SIDE_REST_API_ERROR

      public static final JDBCIntegrationConnectorErrorCode CLIENT_SIDE_REST_API_ERROR
      JDBC-INTEGRATION-CONNECTOR-503-001 - A client-side exception {0} was received from API call {1} to URL {2}. The error message was {3}

  • Method Details

    • values

      public static JDBCIntegrationConnectorErrorCode[] 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 JDBCIntegrationConnectorErrorCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition getMessageDefinition()
      Retrieve a message definition object for an exception. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
      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<JDBCIntegrationConnectorErrorCode>
      Returns:
      string of property names and values for this enum