Package org.odpi.openmetadata.governanceservers.enginehostservices.ffdc

Enum Class EngineHostServicesErrorCode

java.lang.Object
java.lang.Enum<EngineHostServicesErrorCode>
org.odpi.openmetadata.governanceservers.enginehostservices.ffdc.EngineHostServicesErrorCode
All Implemented Interfaces:
Serializable, Comparable<EngineHostServicesErrorCode>, Constable, ExceptionMessageSet
public enum EngineHostServicesErrorCode extends Enum<EngineHostServicesErrorCode> implements ExceptionMessageSet
The EngineHostServicesErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Engine Host Services. It is used in conjunction with all 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
    • 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 user should correct the error

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BAD_ENGINE_SERVICE_ADMIN_CLASS
    The engine service {0} has been configured with an admin class of {1} which can not be used by the class loader.
    CONFIGURATION_LISTENER_INSTANCE_FAILURE
    ENGINE-HOST-SERVICES-400-021 - The engine host services are unable to retrieve the connection for the configuration listener for server {0} from metadata server {1}.
    ENGINE_SERVICE_NULL_HANDLERS
    ENGINE-HOST-SERVICES-400-015 - Engine service {0} in engine host {1} is unable to start any governance engines
    GOVERNANCE_ENGINE_NOT_INITIALIZED
    ENGINE-HOST-SERVICES-400-017 - Engine host server {0} is unable to pass a governance request to governance engine {1} because this governance engine has not retrieved its configuration from the metadata access server
    NO_CONFIG_DOC
    ENGINE-HOST-SERVICES-400-001 - Engine host {0} has been passed a null configuration document section for the engine host services
    NO_CONFIG_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-400-009 - Engine host {0} is not configured with the name for the server running the {1}
    NO_CONFIG_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-400-008 - Engine host {0} is not configured with the platform URL root for the {1}
    NO_ENGINE_SERVICES_CONFIGURED
    ENGINE-HOST-SERVICES-400-002 - Engine host {0} is not configured with any engine services
    NO_ENGINES
    ENGINE-HOST-SERVICES-400-104 - {0} in server {1} is not configured with any engines
    NO_ENGINES_FOR_SERVICE
    ENGINE-HOST-SERVICES-400-007 - No governance engines are running in the engine service {0} on engine host {1}
    NO_GOVERNANCE_ENGINES
    ENGINE-HOST-SERVICES-400-006 - No governance engines are running in the engine host {0}
    NO_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-400-103 - {0} in server {1} is not configured with the name for the server running the {2}
    NO_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-400-102 - {0} in server {1} is not configured with the platform URL root for the {2}
    NO_PARTNER_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-400-011 - Engine service {0} running in engine host {1} is not configured with the name for the server running the {2}
    NO_PARTNER_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-400-010 - Engine service {0} running in engine host {1} is not configured with the platform URL root for the {2}
    NULL_ENGINE_NAME
    ENGINE-HOST-SERVICES-400-012 - {0} in engine host {1} is configured with a null engine name
    NULL_ENGINE_SERVICE_ADMIN_CLASS
    ENGINE-HOST-SERVICES-400-013 - The engine service {0} has been configured with a null admin class in engine host {1}
    NULL_GOVERNANCE_SERVICE
    ENGINE-HOST-SERVICES-400-016 - Method {0} can not execute in the governance engine {1} hosted by engine host server {2} because the associated governance service properties are invalid: {3}
    NULL_SERVICE_CONFIG_VALUE
    ENGINE-HOST-SERVICES-400-019 - The configuration document for engine {0} configuration property for engine service {1} in engine host {2} is null
    SERVICE_INSTANCE_FAILURE
    ENGINE-HOST-SERVICES-400-003 - The engine host services are unable to initialize a new instance of engine host {0}; exception {1} with message {2}
    UNEXPECTED_INITIALIZATION_EXCEPTION
    ENGINE-HOST-SERVICES-400-020 - The engine host services in engine host server {0} are unable to initialize a new instance of engine service {1}; exception {2} with message {3}
    UNKNOWN_ENGINE_NAME
    ENGINE-HOST-SERVICES-400-005 - Governance engine named {0} is not running in the engine host {1}
    UNKNOWN_ENGINE_SERVICE
    ENGINE-HOST-SERVICES-400-004 - Engine service with URL marker {0} is not registered in the engine host {1}
    UNKNOWN_GOVERNANCE_ENGINE_CONFIG
    ENGINE-HOST-SERVICES-400-023 - Properties for governance engine called {0} have not been returned by open metadata server {1} to engine host services in server {2}
    UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP
    ENGINE-HOST-SERVICES-400-022 - Properties for governance engine called {0} have not been returned by open metadata server {1}.
    UNRECOGNIZED_SERVICE
    ENGINE-HOST-SERVICES-400-018 - The engine service URL marker {0} is not recognized.
    WRONG_TYPE_OF_GOVERNANCE_ENGINE
    ENGINE-HOST-SERVICES-400-024 - Governance engine {0} defined in open metadata server {1} is of type {2} rather than {3}; engine host server {4} is not able to run requests for this governance engine

  • Method Summary

    Modifier and Type
    Method
    Description
    ExceptionMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for an exception.
    ExceptionMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for an exception.
    String
    toString()
    JSON-style toString
    static EngineHostServicesErrorCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EngineHostServicesErrorCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NO_CONFIG_DOC

      public static final EngineHostServicesErrorCode NO_CONFIG_DOC
      ENGINE-HOST-SERVICES-400-001 - Engine host {0} has been passed a null configuration document section for the engine host services

    • NO_ENGINE_SERVICES_CONFIGURED

      public static final EngineHostServicesErrorCode NO_ENGINE_SERVICES_CONFIGURED
      ENGINE-HOST-SERVICES-400-002 - Engine host {0} is not configured with any engine services

    • SERVICE_INSTANCE_FAILURE

      public static final EngineHostServicesErrorCode SERVICE_INSTANCE_FAILURE
      ENGINE-HOST-SERVICES-400-003 - The engine host services are unable to initialize a new instance of engine host {0}; exception {1} with message {2}

    • UNKNOWN_ENGINE_SERVICE

      public static final EngineHostServicesErrorCode UNKNOWN_ENGINE_SERVICE
      ENGINE-HOST-SERVICES-400-004 - Engine service with URL marker {0} is not registered in the engine host {1}

    • UNKNOWN_ENGINE_NAME

      public static final EngineHostServicesErrorCode UNKNOWN_ENGINE_NAME
      ENGINE-HOST-SERVICES-400-005 - Governance engine named {0} is not running in the engine host {1}

    • NO_GOVERNANCE_ENGINES

      public static final EngineHostServicesErrorCode NO_GOVERNANCE_ENGINES
      ENGINE-HOST-SERVICES-400-006 - No governance engines are running in the engine host {0}

    • NO_ENGINES_FOR_SERVICE

      public static final EngineHostServicesErrorCode NO_ENGINES_FOR_SERVICE
      ENGINE-HOST-SERVICES-400-007 - No governance engines are running in the engine service {0} on engine host {1}

    • NO_CONFIG_OMAS_SERVER_URL

      public static final EngineHostServicesErrorCode NO_CONFIG_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-400-008 - Engine host {0} is not configured with the platform URL root for the {1}

    • NO_CONFIG_OMAS_SERVER_NAME

      public static final EngineHostServicesErrorCode NO_CONFIG_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-400-009 - Engine host {0} is not configured with the name for the server running the {1}

    • NO_PARTNER_OMAS_SERVER_URL

      public static final EngineHostServicesErrorCode NO_PARTNER_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-400-010 - Engine service {0} running in engine host {1} is not configured with the platform URL root for the {2}

    • NO_PARTNER_OMAS_SERVER_NAME

      public static final EngineHostServicesErrorCode NO_PARTNER_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-400-011 - Engine service {0} running in engine host {1} is not configured with the name for the server running the {2}

    • NULL_ENGINE_NAME

      public static final EngineHostServicesErrorCode NULL_ENGINE_NAME
      ENGINE-HOST-SERVICES-400-012 - {0} in engine host {1} is configured with a null engine name

    • NULL_ENGINE_SERVICE_ADMIN_CLASS

      public static final EngineHostServicesErrorCode NULL_ENGINE_SERVICE_ADMIN_CLASS
      ENGINE-HOST-SERVICES-400-013 - The engine service {0} has been configured with a null admin class in engine host {1}

    • BAD_ENGINE_SERVICE_ADMIN_CLASS

      public static final EngineHostServicesErrorCode BAD_ENGINE_SERVICE_ADMIN_CLASS
      The engine service {0} has been configured with an admin class of {1} which can not be used by the class loader. The {2} exception was returned with message {3}

    • ENGINE_SERVICE_NULL_HANDLERS

      public static final EngineHostServicesErrorCode ENGINE_SERVICE_NULL_HANDLERS
      ENGINE-HOST-SERVICES-400-015 - Engine service {0} in engine host {1} is unable to start any governance engines

    • NULL_GOVERNANCE_SERVICE

      public static final EngineHostServicesErrorCode NULL_GOVERNANCE_SERVICE
      ENGINE-HOST-SERVICES-400-016 - Method {0} can not execute in the governance engine {1} hosted by engine host server {2} because the associated governance service properties are invalid: {3}

    • GOVERNANCE_ENGINE_NOT_INITIALIZED

      public static final EngineHostServicesErrorCode GOVERNANCE_ENGINE_NOT_INITIALIZED
      ENGINE-HOST-SERVICES-400-017 - Engine host server {0} is unable to pass a governance request to governance engine {1} because this governance engine has not retrieved its configuration from the metadata access server

    • UNRECOGNIZED_SERVICE

      public static final EngineHostServicesErrorCode UNRECOGNIZED_SERVICE
      ENGINE-HOST-SERVICES-400-018 - The engine service URL marker {0} is not recognized. Valid service URL markers are: {1}

    • NULL_SERVICE_CONFIG_VALUE

      public static final EngineHostServicesErrorCode NULL_SERVICE_CONFIG_VALUE
      ENGINE-HOST-SERVICES-400-019 - The configuration document for engine {0} configuration property for engine service {1} in engine host {2} is null

    • UNEXPECTED_INITIALIZATION_EXCEPTION

      public static final EngineHostServicesErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION
      ENGINE-HOST-SERVICES-400-020 - The engine host services in engine host server {0} are unable to initialize a new instance of engine service {1}; exception {2} with message {3}

    • CONFIGURATION_LISTENER_INSTANCE_FAILURE

      public static final EngineHostServicesErrorCode CONFIGURATION_LISTENER_INSTANCE_FAILURE
      ENGINE-HOST-SERVICES-400-021 - The engine host services are unable to retrieve the connection for the configuration listener for server {0} from metadata server {1}. Exception returned was {2} with error message {3}

    • UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP

      public static final EngineHostServicesErrorCode UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP
      ENGINE-HOST-SERVICES-400-022 - Properties for governance engine called {0} have not been returned by open metadata server {1}. Exception {2} with message {3} returned to server {4}

    • UNKNOWN_GOVERNANCE_ENGINE_CONFIG

      public static final EngineHostServicesErrorCode UNKNOWN_GOVERNANCE_ENGINE_CONFIG
      ENGINE-HOST-SERVICES-400-023 - Properties for governance engine called {0} have not been returned by open metadata server {1} to engine host services in server {2}

    • WRONG_TYPE_OF_GOVERNANCE_ENGINE

      public static final EngineHostServicesErrorCode WRONG_TYPE_OF_GOVERNANCE_ENGINE
      ENGINE-HOST-SERVICES-400-024 - Governance engine {0} defined in open metadata server {1} is of type {2} rather than {3}; engine host server {4} is not able to run requests for this governance engine

    • NO_OMAS_SERVER_URL

      public static final EngineHostServicesErrorCode NO_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-400-102 - {0} in server {1} is not configured with the platform URL root for the {2}

    • NO_OMAS_SERVER_NAME

      public static final EngineHostServicesErrorCode NO_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-400-103 - {0} in server {1} is not configured with the name for the server running the {2}

    • NO_ENGINES

      public static final EngineHostServicesErrorCode NO_ENGINES
      ENGINE-HOST-SERVICES-400-104 - {0} in server {1} is not configured with any engines

  • Method Details

    • values

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