Package org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.ffdc

Enum Class AtlasSurveyErrorCode

java.lang.Object
java.lang.Enum<AtlasSurveyErrorCode>
org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.ffdc.AtlasSurveyErrorCode
All Implemented Interfaces:
Serializable, Comparable<AtlasSurveyErrorCode>, Constable, ExceptionMessageSet
public enum AtlasSurveyErrorCode extends Enum<AtlasSurveyErrorCode> implements ExceptionMessageSet
The AtlasDiscoveryErrorCode 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

    • WRONG_REST_CONNECTOR

      public static final AtlasSurveyErrorCode WRONG_REST_CONNECTOR
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-400-001 - The {0} Apache Atlas Discovery Connector has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

    • WRONG_ROOT_SCHEMA_TYPE

      public static final AtlasSurveyErrorCode WRONG_ROOT_SCHEMA_TYPE
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-400-002 - The root schema type for Apache Atlas Software Server {0} is of type {1} rather than {2}. Apache Atlas Survey Connector {3} is not able to continue with its schema analysis. The existing schema type properties are {4}

    • MISSING_ASSET_UNIVERSE

      public static final AtlasSurveyErrorCode MISSING_ASSET_UNIVERSE
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-400-003 - The asset universe for Apache Atlas Software Server is null. Apache Atlas Survey Connector {0} is not able to continue with its schema analysis

    • UNEXPECTED_EXCEPTION

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

  • Method Details

    • values

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