Package org.odpi.openmetadata.frameworkservices.oif.ffdc

Enum Class OpenIntegrationErrorCode

java.lang.Object
java.lang.Enum<OpenIntegrationErrorCode>
org.odpi.openmetadata.frameworkservices.oif.ffdc.OpenIntegrationErrorCode
All Implemented Interfaces:
Serializable, Comparable<OpenIntegrationErrorCode>, Constable, ExceptionMessageSet
public enum OpenIntegrationErrorCode extends Enum<OpenIntegrationErrorCode> implements ExceptionMessageSet
The OpenIntegrationErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Governance Action Framework (GAF) Services. 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 GovernanceEngineInterface should correct the error

  • Enum Constant Details

    • OMRS_NOT_INITIALIZED

      public static final OpenIntegrationErrorCode OMRS_NOT_INITIALIZED
      OPEN-INTEGRATION-SERVICE-404-002 - The open metadata repository services are not initialized for the {0} operation

    • UNEXPECTED_INITIALIZATION_EXCEPTION

      public static final OpenIntegrationErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION
      OPEN-INTEGRATION-SERVICE-503-005 - A {0} exception was caught during start up of service {1} for server {2}. The error message was: {3}

  • Method Details

    • values

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