org.odpi.openmetadata.engineservices.assetanalysis.ffdc

Enum AssetAnalysisErrorCode

java.lang.Object

java.lang.Enum<AssetAnalysisErrorCode>

org.odpi.openmetadata.engineservices.assetanalysis.ffdc.AssetAnalysisErrorCode

All Implemented Interfaces:

Serializable, Comparable<AssetAnalysisErrorCode>, ExceptionMessageSet

public enum AssetAnalysisErrorCode
extends Enum<AssetAnalysisErrorCode>
implements ExceptionMessageSet

The AssetAnalysisErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Discovery Engine 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 and Description
CONFIGURATION_LISTENER_INSTANCE_FAILURE
DISCOVERY_ENGINE_INSTANCE_FAILURE
DISCOVERY_ENGINE_NOT_INITIALIZED
INVALID_DISCOVERY_SERVICE
NO_DISCOVERY_ENGINE_CLIENT
NO_DISCOVERY_ENGINES_STARTED
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
ExceptionMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
ExceptionMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for an exception.
static AssetAnalysisErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AssetAnalysisErrorCode[]	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

DISCOVERY_ENGINE_INSTANCE_FAILURE

public static final AssetAnalysisErrorCode DISCOVERY_ENGINE_INSTANCE_FAILURE

SERVICE_INSTANCE_FAILURE

public static final AssetAnalysisErrorCode SERVICE_INSTANCE_FAILURE

CONFIGURATION_LISTENER_INSTANCE_FAILURE

public static final AssetAnalysisErrorCode CONFIGURATION_LISTENER_INSTANCE_FAILURE

UNKNOWN_DISCOVERY_ENGINE_CONFIG_AT_STARTUP

public static final AssetAnalysisErrorCode UNKNOWN_DISCOVERY_ENGINE_CONFIG_AT_STARTUP

NO_DISCOVERY_ENGINES_STARTED

public static final AssetAnalysisErrorCode NO_DISCOVERY_ENGINES_STARTED

NO_DISCOVERY_ENGINE_CLIENT

public static final AssetAnalysisErrorCode NO_DISCOVERY_ENGINE_CLIENT

UNKNOWN_DISCOVERY_ENGINE_CONFIG

public static final AssetAnalysisErrorCode UNKNOWN_DISCOVERY_ENGINE_CONFIG

UNKNOWN_DISCOVERY_ENGINE

public static final AssetAnalysisErrorCode UNKNOWN_DISCOVERY_ENGINE

UNKNOWN_DISCOVERY_REQUEST_TYPE

public static final AssetAnalysisErrorCode UNKNOWN_DISCOVERY_REQUEST_TYPE

INVALID_DISCOVERY_SERVICE

public static final AssetAnalysisErrorCode INVALID_DISCOVERY_SERVICE

NULL_DISCOVERY_SERVICE

public static final AssetAnalysisErrorCode NULL_DISCOVERY_SERVICE

DISCOVERY_ENGINE_NOT_INITIALIZED

public static final AssetAnalysisErrorCode DISCOVERY_ENGINE_NOT_INITIALIZED

Method Detail

values

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

Returns:

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

valueOf

public static AssetAnalysisErrorCode 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

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.