Package org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ffdc

Enum Class ReferenceDataErrorCode

java.lang.Object
java.lang.Enum<ReferenceDataErrorCode>
org.odpi.openmetadata.adapters.connectors.referencedata.tabulardatasets.ffdc.ReferenceDataErrorCode
All Implemented Interfaces:
Serializable, Comparable<ReferenceDataErrorCode>, Constable, ExceptionMessageSet
public enum ReferenceDataErrorCode extends Enum<ReferenceDataErrorCode> implements ExceptionMessageSet
The ReferenceDataErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Reference Data Connectors. 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

  • Enum Constant Details

    • NULL_URL

      public static final ReferenceDataErrorCode NULL_URL
      EGERIA-CONNECTOR-400-001 - Reference Data Connector {0} has been configured without the URL to the OMAG Server Platform

    • NULL_SERVER_NAME

      public static final ReferenceDataErrorCode NULL_SERVER_NAME
      EGERIA-CONNECTOR-400-002 - Reference Data Connector {0} has been configured without the name of the OMAG Server to call

    • NULL_CLIENT_USER_ID

      public static final ReferenceDataErrorCode NULL_CLIENT_USER_ID
      EGERIA-CONNECTOR-400-003 - Reference Data Connector {0} has been configured without a userId needed to call the OMAG Server Platform.

    • NULL_RECORD

      public static final ReferenceDataErrorCode NULL_RECORD
      EGERIA-CONNECTOR-400-004 - Reference Data Connector {0} has no data at record {1}. The data set size is {2}

    • WRONG_NUMBER_OF_COLUMNS

      public static final ReferenceDataErrorCode WRONG_NUMBER_OF_COLUMNS
      EGERIA-CONNECTOR-400-005 - Reference Data Connector {0} has been passed {1} columns on the {2} method for record number {3}. The data set width is {4}

    • UNEXPECTED_EXCEPTION

      public static final ReferenceDataErrorCode UNEXPECTED_EXCEPTION
      EGERIA-CONNECTOR-500-001 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • INVALID_ELEMENT

      public static final ReferenceDataErrorCode INVALID_ELEMENT
      EGERIA-CONNECTOR-500-002 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}

  • Method Details

    • values

      public static ReferenceDataErrorCode[] 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 ReferenceDataErrorCode 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 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 ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

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