Package org.odpi.openmetadata.accessservices.dataengine.ffdc

Enum Class DataEngineErrorCode

java.lang.Object
java.lang.Enum<DataEngineErrorCode>
org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode
All Implemented Interfaces:
Serializable, Comparable<DataEngineErrorCode>, Constable, ExceptionMessageSet
public enum DataEngineErrorCode extends Enum<DataEngineErrorCode> implements ExceptionMessageSet
The DataEngineErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Data Engine OMAS 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 consumer should correct the error

  • Enum Constant Details

    • OMRS_NOT_INITIALIZED

      public static final DataEngineErrorCode OMRS_NOT_INITIALIZED
      OMAS-DATA-ENGINE-404-001 The open metadata repository services are not initialized for server {0}

    • REFERENCEABLE_NOT_FOUND

      public static final DataEngineErrorCode REFERENCEABLE_NOT_FOUND
      OMAS-DATA-ENGINE-400-001 Referenceable with qualifiedName {0} was not found

    • NULL_TOPIC_CONNECTOR

      public static final DataEngineErrorCode NULL_TOPIC_CONNECTOR
      OMAS-DATA-ENGINE-400-002 Unable to send or receive events for source {0} because the connector to the OMRS Topic failed to initialize

    • PROCESS_NOT_FOUND

      public static final DataEngineErrorCode PROCESS_NOT_FOUND
      OMAS-DATA-ENGINE-400-003 Process with qualifiedName {0} was not found

    • DATABASE_SCHEMA_NOT_FOUND

      public static final DataEngineErrorCode DATABASE_SCHEMA_NOT_FOUND
      OMAS-DATA-ENGINE-400-004 Database Schema with qualifiedName {0} was not found

    • UNABLE_TO_SEND_EVENT

      public static final DataEngineErrorCode UNABLE_TO_SEND_EVENT
      OMAS-DATA-ENGINE-500-001 An unexpected exception occurred when sending an event through connector {0} to the Data Engine OMAS out topic

    • ENTITY_NOT_DELETED

      public static final DataEngineErrorCode ENTITY_NOT_DELETED
      OMAS-DATA-ENGINE-400-005 Entity with qualifiedName {0} was not deleted

    • METHOD_NOT_IMPLEMENTED

      public static final DataEngineErrorCode METHOD_NOT_IMPLEMENTED
      OMAS-DATA-ENGINE-500-002 Method {0} is not implemented

    • TOPIC_NOT_FOUND

      public static final DataEngineErrorCode TOPIC_NOT_FOUND
      OMAS-DATA-ENGINE-400-006 Topic with qualifiedName {0} was not found

    • ENGINE_NOT_FOUND

      public static final DataEngineErrorCode ENGINE_NOT_FOUND
      OMAS-DATA-ENGINE-400-007 Engine with qualifiedName {0} was not found

  • Method Details

    • values

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