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

Enum EngineHostServicesErrorCode

java.lang.Object

java.lang.Enum<EngineHostServicesErrorCode>

org.odpi.openmetadata.governanceservers.enginehostservices.ffdc.EngineHostServicesErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EngineHostServicesErrorCode>, ExceptionMessageSet

public enum EngineHostServicesErrorCode
extends java.lang.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 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 Summary

Enum Constants

Enum Constant	Description
BAD_ENGINE_SERVICE_ADMIN_CLASS
CONFIGURATION_LISTENER_INSTANCE_FAILURE
ENGINE_SERVICE_NULL_HANDLERS
GOVERNANCE_ENGINE_NOT_INITIALIZED
NO_CONFIG_DOC
NO_CONFIG_OMAS_SERVER_NAME
NO_CONFIG_OMAS_SERVER_URL
NO_ENGINE_SERVICES_CONFIGURED
NO_ENGINES
NO_ENGINES_FOR_SERVICE
NO_GOVERNANCE_ENGINES
NO_OMAS_SERVER_NAME
NO_OMAS_SERVER_URL
NO_PARTNER_OMAS_SERVER_NAME
NO_PARTNER_OMAS_SERVER_URL
NULL_ENGINE_NAME
NULL_ENGINE_SERVICE_ADMIN_CLASS
NULL_GOVERNANCE_SERVICE
NULL_SERVICE_CONFIG_VALUE
SERVICE_INSTANCE_FAILURE
UNEXPECTED_INITIALIZATION_EXCEPTION
UNKNOWN_ENGINE_NAME
UNKNOWN_ENGINE_SERVICE
UNKNOWN_GOVERNANCE_ENGINE_CONFIG
UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP
UNRECOGNIZED_SERVICE
WRONG_TYPE_OF_GOVERNANCE_ENGINE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_CONFIG_DOC

public static final EngineHostServicesErrorCode NO_CONFIG_DOC

NO_ENGINE_SERVICES_CONFIGURED

public static final EngineHostServicesErrorCode NO_ENGINE_SERVICES_CONFIGURED

SERVICE_INSTANCE_FAILURE

public static final EngineHostServicesErrorCode SERVICE_INSTANCE_FAILURE

UNKNOWN_ENGINE_SERVICE

public static final EngineHostServicesErrorCode UNKNOWN_ENGINE_SERVICE

UNKNOWN_ENGINE_NAME

public static final EngineHostServicesErrorCode UNKNOWN_ENGINE_NAME

NO_GOVERNANCE_ENGINES

public static final EngineHostServicesErrorCode NO_GOVERNANCE_ENGINES

NO_ENGINES_FOR_SERVICE

public static final EngineHostServicesErrorCode NO_ENGINES_FOR_SERVICE

NO_CONFIG_OMAS_SERVER_URL

public static final EngineHostServicesErrorCode NO_CONFIG_OMAS_SERVER_URL

NO_CONFIG_OMAS_SERVER_NAME

public static final EngineHostServicesErrorCode NO_CONFIG_OMAS_SERVER_NAME

NO_PARTNER_OMAS_SERVER_URL

public static final EngineHostServicesErrorCode NO_PARTNER_OMAS_SERVER_URL

NO_PARTNER_OMAS_SERVER_NAME

public static final EngineHostServicesErrorCode NO_PARTNER_OMAS_SERVER_NAME

NULL_ENGINE_NAME

public static final EngineHostServicesErrorCode NULL_ENGINE_NAME

NULL_ENGINE_SERVICE_ADMIN_CLASS

public static final EngineHostServicesErrorCode NULL_ENGINE_SERVICE_ADMIN_CLASS

BAD_ENGINE_SERVICE_ADMIN_CLASS

public static final EngineHostServicesErrorCode BAD_ENGINE_SERVICE_ADMIN_CLASS

ENGINE_SERVICE_NULL_HANDLERS

public static final EngineHostServicesErrorCode ENGINE_SERVICE_NULL_HANDLERS

NULL_GOVERNANCE_SERVICE

public static final EngineHostServicesErrorCode NULL_GOVERNANCE_SERVICE

GOVERNANCE_ENGINE_NOT_INITIALIZED

public static final EngineHostServicesErrorCode GOVERNANCE_ENGINE_NOT_INITIALIZED

UNRECOGNIZED_SERVICE

public static final EngineHostServicesErrorCode UNRECOGNIZED_SERVICE

NULL_SERVICE_CONFIG_VALUE

public static final EngineHostServicesErrorCode NULL_SERVICE_CONFIG_VALUE

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final EngineHostServicesErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION

CONFIGURATION_LISTENER_INSTANCE_FAILURE

public static final EngineHostServicesErrorCode CONFIGURATION_LISTENER_INSTANCE_FAILURE

UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP

public static final EngineHostServicesErrorCode UNKNOWN_GOVERNANCE_ENGINE_CONFIG_AT_STARTUP

UNKNOWN_GOVERNANCE_ENGINE_CONFIG

public static final EngineHostServicesErrorCode UNKNOWN_GOVERNANCE_ENGINE_CONFIG

WRONG_TYPE_OF_GOVERNANCE_ENGINE

public static final EngineHostServicesErrorCode WRONG_TYPE_OF_GOVERNANCE_ENGINE

NO_OMAS_SERVER_URL

public static final EngineHostServicesErrorCode NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

public static final EngineHostServicesErrorCode NO_OMAS_SERVER_NAME

NO_ENGINES

public static final EngineHostServicesErrorCode NO_ENGINES

Method Detail

values

public static EngineHostServicesErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EngineHostServicesErrorCode c : EngineHostServicesErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EngineHostServicesErrorCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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(java.lang.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 java.lang.String toString()

JSON-style toString

Overrides:

toString in class java.lang.Enum<EngineHostServicesErrorCode>

Returns:

string of property names and values for this enum