Package org.odpi.openmetadata.frameworks.governanceaction.ffdc

Enum Class GAFErrorCode

java.lang.Object
java.lang.Enum<GAFErrorCode>
org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode
All Implemented Interfaces:
Serializable, Comparable<GAFErrorCode>, Constable
public enum GAFErrorCode extends Enum<GAFErrorCode>
The GAF error code is used to define first failure data capture (FFDC) for errors that occur when working with GAF Components. It is used in conjunction with the GAFCheckedException and GAFRuntimeException. 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 user should correct the error

  • Enum Constant Details

    • NULL_GOVERNANCE_CONTEXT

      public static final GAFErrorCode NULL_GOVERNANCE_CONTEXT

    • INVALID_GOVERNANCE_SERVICE_CONNECTION

      public static final GAFErrorCode INVALID_GOVERNANCE_SERVICE_CONNECTION

    • INVALID_GOVERNANCE_SERVICE_CONNECTOR

      public static final GAFErrorCode INVALID_GOVERNANCE_SERVICE_CONNECTOR

    • NULL_NAME

      public static final GAFErrorCode NULL_NAME

    • NULL_GUID

      public static final GAFErrorCode NULL_GUID

    • UNKNOWN_ELEMENT

      public static final GAFErrorCode UNKNOWN_ELEMENT

    • DUPLICATE_ELEMENT

      public static final GAFErrorCode DUPLICATE_ELEMENT

    • NULL_PROPERTY_NAME

      public static final GAFErrorCode NULL_PROPERTY_NAME

    • ARRAY_OUT_OF_BOUNDS

      public static final GAFErrorCode ARRAY_OUT_OF_BOUNDS

    • UNEXPECTED_EXCEPTION

      public static final GAFErrorCode UNEXPECTED_EXCEPTION

    • INVALID_PRIMITIVE_CLASS_NAME

      public static final GAFErrorCode INVALID_PRIMITIVE_CLASS_NAME

    • INVALID_PRIMITIVE_VALUE

      public static final GAFErrorCode INVALID_PRIMITIVE_VALUE

    • INVALID_PRIMITIVE_CATEGORY

      public static final GAFErrorCode INVALID_PRIMITIVE_CATEGORY

    • INVALID_PRIMITIVE_TYPE

      public static final GAFErrorCode INVALID_PRIMITIVE_TYPE

    • HELPER_LOGIC_ERROR

      public static final GAFErrorCode HELPER_LOGIC_ERROR

    • HELPER_LOGIC_EXCEPTION

      public static final GAFErrorCode HELPER_LOGIC_EXCEPTION

  • Method Details

    • values

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