Package org.odpi.openmetadata.conformance.ffdc

Enum Class ConformanceSuiteErrorCode

java.lang.Object
java.lang.Enum<ConformanceSuiteErrorCode>
org.odpi.openmetadata.conformance.ffdc.ConformanceSuiteErrorCode
All Implemented Interfaces:
Serializable, Comparable<ConformanceSuiteErrorCode>, Constable, ExceptionMessageSet
public enum ConformanceSuiteErrorCode extends Enum<ConformanceSuiteErrorCode> implements ExceptionMessageSet
The ConformanceSuiteErrorCode is used to define first failure data capture (FFDC) for errors that occur within the Open Metadata Conformance Suite It is used in conjunction with conformance suite exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
  • HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
    • 500 - internal error
    • 501 - not implemented
    • 503 - Service not available
    • 400 - invalid parameters
    • 401 - unauthorized
    • 404 - not found
    • 405 - method not allowed
    • 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_LOCAL_SERVER_NAME

      public static final ConformanceSuiteErrorCode NULL_LOCAL_SERVER_NAME
      CONFORMANCE-SUITE-400-001 - OMAG server has been called with a null local server name

    • NULL_USER_ID

      public static final ConformanceSuiteErrorCode NULL_USER_ID
      CONFORMANCE-SUITE-400-002 - OMAG server {0} has been called with a null username (userId)

    • UNKNOWN_TEST_CASE_ID

      public static final ConformanceSuiteErrorCode UNKNOWN_TEST_CASE_ID
      CONFORMANCE-SUITE-400-003 - Unable to create a report for a test case with unknown identifier {0}

    • UNKNOWN_WORKBENCH_ID

      public static final ConformanceSuiteErrorCode UNKNOWN_WORKBENCH_ID
      CONFORMANCE-SUITE-400-004 - Unable to create a report for a workbench with unknown identifier {0}

    • NO_ENTERPRISE_ACCESS

      public static final ConformanceSuiteErrorCode NO_ENTERPRISE_ACCESS
      CONFORMANCE-SUITE-400-022 - The Egeria Conformance Suite located in OMAG server {0} has been configured with no access to the enterprise repository services

    • UNKNOWN_PROFILE_NAME

      public static final ConformanceSuiteErrorCode UNKNOWN_PROFILE_NAME
      CONFORMANCE-SUITE-400-023 - Unable to create a report for a profile with unknown name {0}

    • NO_ENTERPRISE_TOPIC

      public static final ConformanceSuiteErrorCode NO_ENTERPRISE_TOPIC
      CONFORMANCE-SUITE-500-001 - The Egeria Conformance Suite located in OMAG server {0} has not been passed an enterprise topic connector

    • NO_ENTERPRISE_CONNECTOR_MANAGER

      public static final ConformanceSuiteErrorCode NO_ENTERPRISE_CONNECTOR_MANAGER
      CONFORMANCE-SUITE-500-002 - The Egeria Conformance Suite located in OMAG server {0} has not been passed an enterprise connector manager

    • DUPLICATE_TEST_CASE

      public static final ConformanceSuiteErrorCode DUPLICATE_TEST_CASE
      CONFORMANCE-SUITE-500-003 - The Egeria Conformance Suite testing technology {0} of type {1} has created two test cases with the same id of {2}

    • SERVICE_NOT_INITIALIZED

      public static final ConformanceSuiteErrorCode SERVICE_NOT_INITIALIZED
      CONFORMANCE-SUITE-503-003 - The conformance suite service has not been initialized for server {0} and can not support REST API call {1}

  • Method Details

    • values

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