Package org.odpi.openmetadata.frameworks.surveyaction.ffdc

Enum Class SAFErrorCode

java.lang.Object
java.lang.Enum<SAFErrorCode>
org.odpi.openmetadata.frameworks.surveyaction.ffdc.SAFErrorCode
All Implemented Interfaces:
Serializable, Comparable<SAFErrorCode>, Constable, ExceptionMessageSet
public enum SAFErrorCode extends Enum<SAFErrorCode> implements ExceptionMessageSet
The SAF error code is used to define first failure data capture (FFDC) for errors that occur when working with SAF Discovery Services. It is used in conjunction with all SAF Exceptions, both Checked and Runtime (unchecked). 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 user should correct the error

  • Enum Constant Details

    • NULL_SURVEY_CONTEXT

      public static final SAFErrorCode NULL_SURVEY_CONTEXT
      SURVEY-ACTION-SERVICE-400-001 - No survey context supplied to the survey action service {0}

    • NO_EMBEDDED_SURVEY_ACTION_SERVICES

      public static final SAFErrorCode NO_EMBEDDED_SURVEY_ACTION_SERVICES
      SURVEY-ACTION-SERVICE-400-002 - No embedded survey action services supplied to the survey action pipeline {0}

    • INVALID_EMBEDDED_SURVEY_ACTION_SERVICE

      public static final SAFErrorCode INVALID_EMBEDDED_SURVEY_ACTION_SERVICE
      SURVEY-ACTION-SERVICE-400-003 - No embedded survey action services supplied to the survey action pipeline {0}

    • DISCONNECT_DETECTED

      public static final SAFErrorCode DISCONNECT_DETECTED
      SURVEY-ACTION-SERVICE-400-004 - The {0} survey action service has been disconnected - either due to its own actions or a cancel request

    • INVALID_ASSET_TYPE

      public static final SAFErrorCode INVALID_ASSET_TYPE
      SURVEY-ACTION-SERVICE-400-005 - Asset {0} is of type {1} but survey action service {2} only supports the following asset type(s): {3}

    • WRONG_TYPE_OF_CONNECTOR

      public static final SAFErrorCode WRONG_TYPE_OF_CONNECTOR

    • UNEXPECTED_EXCEPTION

      public static final SAFErrorCode UNEXPECTED_EXCEPTION
      SURVEY-ACTION-SERVICE-500-001 - Unexpected exception in survey action service {0} of type {1} detected by method {2}. The error message was {3}

  • Method Details

    • values

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