Package org.odpi.openmetadata.frameworkservices.gaf.ffdc

Enum Class OpenGovernanceErrorCode

java.lang.Object
java.lang.Enum<OpenGovernanceErrorCode>
org.odpi.openmetadata.frameworkservices.gaf.ffdc.OpenGovernanceErrorCode
All Implemented Interfaces:
Serializable, Comparable<OpenGovernanceErrorCode>, Constable, ExceptionMessageSet
public enum OpenGovernanceErrorCode extends Enum<OpenGovernanceErrorCode> implements ExceptionMessageSet
The OpenGovernanceErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Open Governance Framework (OGF) 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 OpenGovernanceErrorCode OMRS_NOT_INITIALIZED
      OPEN-GOVERNANCE-404-001 - The open metadata repository services are not initialized for the {0} operation

    • NULL_LISTENER

      public static final OpenGovernanceErrorCode NULL_LISTENER
      OPEN-GOVERNANCE-500-001 A null topic listener has been passed by user {0} on method {1}

    • UNABLE_TO_SEND_EVENT

      public static final OpenGovernanceErrorCode UNABLE_TO_SEND_EVENT
      OPEN-GOVERNANCE-500-004 An unexpected exception occurred when sending an event through connector {0} to the OMF Services out topic. The failing event was {1}, the exception was {2} with message {2}

    • NULL_CONNECTOR_RETURNED

      public static final OpenGovernanceErrorCode NULL_CONNECTOR_RETURNED
      OPEN-GOVERNANCE-500-006 The requested connector for connection named {0} has not been created. The connection was provided by the {1} service running in OMAG Server {2} at {3}

    • WRONG_TYPE_OF_CONNECTOR

      public static final OpenGovernanceErrorCode WRONG_TYPE_OF_CONNECTOR
      OPEN-GOVERNANCE-500-007 The connector generated from the connection named {0} return by the {1} service running in OMAG Server {2} at {3} is not of the required type. It should be an instance of {4}

    • UNEXPECTED_EXCEPTION

      public static final OpenGovernanceErrorCode UNEXPECTED_EXCEPTION
      OPEN-GOVERNANCE-500-008 - The Design Model OMAS has received an unexpected {0} exception during method {1}. The message was: {2}

  • Method Details

    • values

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