All Implemented Interfaces:
Serializable, Comparable<ApacheAtlasErrorCode>, Constable, ExceptionMessageSet

public enum ApacheAtlasErrorCode extends Enum<ApacheAtlasErrorCode> implements ExceptionMessageSet
The ApacheAtlasErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Apache Atlas REST 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
  • Enum Constant Details

    • NULL_URL

      public static final ApacheAtlasErrorCode NULL_URL
      APACHE-ATLAS-REST-CONNECTOR-400-001 - Apache Atlas REST connector {0} has been configured without the URL to Apache Atlas

      public static final ApacheAtlasErrorCode NULL_USER
      APACHE-ATLAS-REST-CONNECTOR-400-002 - Apache Atlas REST connector {0} has been configured with either a null userId or password for connecting to Apache Atlas

      public static final ApacheAtlasErrorCode CATEGORY_ALREADY_EXISTS
      APACHE-ATLAS-REST-CONNECTOR-400-004 - Glossary category {0} already exists in Apache Atlas

      public static final ApacheAtlasErrorCode TERM_ALREADY_EXISTS
      APACHE-ATLAS-REST-CONNECTOR-400-005 - Glossary term {0} already exists in Apache Atlas

      public static final ApacheAtlasErrorCode UNEXPECTED_EXCEPTION
      APACHE-ATLAS-REST-CONNECTOR-500-001 - The {0} Apache Atlas REST connector received an unexpected exception {1} during method {2}; the error message was: {3}

      public static final ApacheAtlasErrorCode CLIENT_SIDE_REST_API_ERROR
      APACHE-ATLAS-REST-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 ApacheAtlasErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ApacheAtlasErrorCode 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      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
      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
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      message definition object.
    • toString

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