Package org.odpi.openmetadata.frameworks.opengovernance.ffdc

Enum Class OGFErrorCode

java.lang.Object
java.lang.Enum<OGFErrorCode>
org.odpi.openmetadata.frameworks.opengovernance.ffdc.OGFErrorCode
All Implemented Interfaces:
Serializable, Comparable<OGFErrorCode>, Constable, ExceptionMessageSet
public enum OGFErrorCode extends Enum<OGFErrorCode> implements ExceptionMessageSet
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 OGFErrorCode NULL_GOVERNANCE_CONTEXT
      OPEN-GOVERNANCE-ACTION-400-001 - No governance context supplied to the governance action service {0}

    • UNEXPECTED_EXCEPTION

      public static final OGFErrorCode UNEXPECTED_EXCEPTION
      OPEN-GOVERNANCE-ACTION-500-001 - Unexpected {0} exception in governance action service {1} of type {2} detected by method {3}. The error message was {4}

  • Method Details

    • values

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