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

Enum Class WSO2MIErrorCode

java.lang.Object
java.lang.Enum<WSO2MIErrorCode>
org.odpi.openmetadata.adapters.connectors.wso2mi.ffdc.WSO2MIErrorCode
All Implemented Interfaces:
Serializable, Comparable<WSO2MIErrorCode>, Constable, ExceptionMessageSet
public enum WSO2MIErrorCode extends Enum<WSO2MIErrorCode> implements ExceptionMessageSet
The WSO2MIErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the WSO2 Micro Integrator 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. Typical values are 500 (internal error), 400 (invalid parameters), 404 (not found) and 409 (data conflict).
  • 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 WSO2MIErrorCode NULL_URL
      WSO2MI-CONNECTOR-400-001 - Connection {0} has been configured without a network address for the WSO2 Micro Integrator Management API

    • NO_ACCESS_TOKEN

      public static final WSO2MIErrorCode NO_ACCESS_TOKEN
      WSO2MI-CONNECTOR-401-001 - The {0} connector could not authenticate with the WSO2 Micro Integrator Management API at {1}; the login call returned no access token

    • UNEXPECTED_EXCEPTION

      public static final WSO2MIErrorCode UNEXPECTED_EXCEPTION
      WSO2MI-CONNECTOR-500-001 - The {0} WSO2 Micro Integrator connector received an unexpected exception {1} during method {2}; the error message was: {3}

  • Method Details

    • values

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