org.odpi.openmetadata.governanceservers.discoveryengineservices.ffdc

Enum DiscoveryEngineServicesErrorCode

java.lang.Object

java.lang.Enum<DiscoveryEngineServicesErrorCode>

org.odpi.openmetadata.governanceservers.discoveryengineservices.ffdc.DiscoveryEngineServicesErrorCode

All Implemented Interfaces:

Serializable, Comparable<DiscoveryEngineServicesErrorCode>

public enum DiscoveryEngineServicesErrorCode
extends Enum<DiscoveryEngineServicesErrorCode>

The ODF error code is used to define first failure data capture (FFDC) for errors that occur when working with ODF Discovery Services. It is used in conjunction with all ODF 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 and Description
CONFIGURATION_LISTENER_INSTANCE_FAILURE
DISCOVERY_ENGINE_INSTANCE_FAILURE
DISCOVERY_ENGINE_NOT_INITIALIZED
INVALID_DISCOVERY_SERVICE
NO_CONFIG_DOC
NO_DISCOVERY_ENGINE_CLIENT
NO_DISCOVERY_ENGINES
NO_DISCOVERY_ENGINES_STARTED
NO_OMAS_SERVER_NAME
NO_OMAS_SERVER_URL
NULL_DISCOVERY_SERVICE
SERVICE_INSTANCE_FAILURE
UNKNOWN_DISCOVERY_ENGINE
UNKNOWN_DISCOVERY_ENGINE_CONFIG
UNKNOWN_DISCOVERY_ENGINE_CONFIG_AT_STARTUP
UNKNOWN_DISCOVERY_REQUEST_TYPE

Method Summary

Modifier and Type	Method and Description
String	getErrorMessageId() Returns the unique identifier for the error message.
String	getFormattedErrorMessage(String... params) Returns the error message with the placeholders filled out with the supplied parameters.
int	getHTTPErrorCode()
String	getSystemAction() Returns a description of the action taken by the system when the condition that caused this exception was detected.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
static DiscoveryEngineServicesErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiscoveryEngineServicesErrorCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_CONFIG_DOC

public static final DiscoveryEngineServicesErrorCode NO_CONFIG_DOC

NO_OMAS_SERVER_URL

public static final DiscoveryEngineServicesErrorCode NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

public static final DiscoveryEngineServicesErrorCode NO_OMAS_SERVER_NAME

NO_DISCOVERY_ENGINES

public static final DiscoveryEngineServicesErrorCode NO_DISCOVERY_ENGINES

DISCOVERY_ENGINE_INSTANCE_FAILURE

public static final DiscoveryEngineServicesErrorCode DISCOVERY_ENGINE_INSTANCE_FAILURE

SERVICE_INSTANCE_FAILURE

public static final DiscoveryEngineServicesErrorCode SERVICE_INSTANCE_FAILURE

CONFIGURATION_LISTENER_INSTANCE_FAILURE

public static final DiscoveryEngineServicesErrorCode CONFIGURATION_LISTENER_INSTANCE_FAILURE

UNKNOWN_DISCOVERY_ENGINE_CONFIG_AT_STARTUP

public static final DiscoveryEngineServicesErrorCode UNKNOWN_DISCOVERY_ENGINE_CONFIG_AT_STARTUP

NO_DISCOVERY_ENGINES_STARTED

public static final DiscoveryEngineServicesErrorCode NO_DISCOVERY_ENGINES_STARTED

NO_DISCOVERY_ENGINE_CLIENT

public static final DiscoveryEngineServicesErrorCode NO_DISCOVERY_ENGINE_CLIENT

UNKNOWN_DISCOVERY_ENGINE_CONFIG

public static final DiscoveryEngineServicesErrorCode UNKNOWN_DISCOVERY_ENGINE_CONFIG

UNKNOWN_DISCOVERY_ENGINE

public static final DiscoveryEngineServicesErrorCode UNKNOWN_DISCOVERY_ENGINE

UNKNOWN_DISCOVERY_REQUEST_TYPE

public static final DiscoveryEngineServicesErrorCode UNKNOWN_DISCOVERY_REQUEST_TYPE

INVALID_DISCOVERY_SERVICE

public static final DiscoveryEngineServicesErrorCode INVALID_DISCOVERY_SERVICE

NULL_DISCOVERY_SERVICE

public static final DiscoveryEngineServicesErrorCode NULL_DISCOVERY_SERVICE

DISCOVERY_ENGINE_NOT_INITIALIZED

public static final DiscoveryEngineServicesErrorCode DISCOVERY_ENGINE_NOT_INITIALIZED

Method Detail

values

public static DiscoveryEngineServicesErrorCode[] 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 (DiscoveryEngineServicesErrorCode c : DiscoveryEngineServicesErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DiscoveryEngineServicesErrorCode valueOf(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:

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

NullPointerException - if the argument is null

getHTTPErrorCode

public int getHTTPErrorCode()

getErrorMessageId

public String getErrorMessageId()

Returns the unique identifier for the error message.

Returns:

errorMessageId

getFormattedErrorMessage

public String getFormattedErrorMessage(String... params)

Returns the error message with the placeholders filled out with the supplied parameters.

Parameters:

params - strings that plug into the placeholders in the errorMessage

Returns:

errorMessage (formatted with supplied parameters)

getSystemAction

public String getSystemAction()

Returns a description of the action taken by the system when the condition that caused this exception was detected.

Returns:

systemAction

getUserAction

public String getUserAction()

Returns instructions of how to resolve the issue reported in this exception.

Returns:

userAction