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

Enum Class RESTClientConnectorErrorCode

java.lang.Object
java.lang.Enum<RESTClientConnectorErrorCode>
org.odpi.openmetadata.adapters.connectors.restclients.ffdc.RESTClientConnectorErrorCode
All Implemented Interfaces:
Serializable, Comparable<RESTClientConnectorErrorCode>, Constable
public enum RESTClientConnectorErrorCode extends Enum<RESTClientConnectorErrorCode>
The RESTClientConnectorErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the REST Client. 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 Id - 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

  • Method Details

    • values

      public static RESTClientConnectorErrorCode[] 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 RESTClientConnectorErrorCode 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

    • getHTTPErrorCode

      public int getHTTPErrorCode()

    • getErrorMessageId

      public String getErrorMessageId()
      Returns the unique identifier for the error message.
      Returns:
      errorMessageId

    • getUnformattedErrorMessage

      public String getUnformattedErrorMessage()
      Returns the error message with placeholders for specific details.
      Returns:
      errorMessage (unformatted)

    • getFormattedErrorMessage

      public String getFormattedErrorMessage(String... params)
      Returns the error message with the placeholders filled out with the supplied parameters.
      Parameters:
      params - - strings that plug into the placeholders in the errorMessage
      Returns:
      errorMessage (formatted with supplied parameters)

    • getSystemAction

      public String getSystemAction()
      Returns a description of the action taken by the system when the condition that caused this exception was detected.
      Returns:
      systemAction

    • getUserAction

      public String getUserAction()
      Returns instructions of how to resolve the issue reported in this exception.
      Returns:
      userAction

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<RESTClientConnectorErrorCode>
      Returns:
      string of property names and values for this enum