org.odpi.openmetadata.governanceservers.openlineage.ffdc

Enum OpenLineageServerErrorCode

java.lang.Object

java.lang.Enum<OpenLineageServerErrorCode>

org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageServerErrorCode

All Implemented Interfaces:

Serializable, Comparable<OpenLineageServerErrorCode>

public enum OpenLineageServerErrorCode
extends Enum<OpenLineageServerErrorCode>

The ODF error code is used to define first failure data capture (FFDC) for errors that occur when working with Open Lineage 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
CANNOT_OPEN_GRAPH_DB
ERROR_DISCONNECTING_BUFFER_GRAPH_CONNECTOR
ERROR_DISCONNECTING_IN_TOPIC_CONNECTOR
ERROR_DISCONNECTING_MAIN_GRAPH_CONNECTOR
ERROR_INITIALIZING_BUFFER_GRAPH_CONNECTOR_DB
ERROR_INITIALIZING_MAIN_GRAPH_CONNECTOR_DB
ERROR_INITIALIZING_OLS
ERROR_OBTAINING_BUFFER_GRAPH_CONNECTOR
ERROR_OBTAINING_IN_TOPIC_CONNECTOR
ERROR_OBTAINING_MAIN_GRAPH_CONNECTOR
ERROR_STARTING_BUFFER_GRAPH_CONNECTOR
ERROR_STARTING_IN_TOPIC_CONNECTOR
ERROR_STARTING_MAIN_GRAPH_CONNECTOR
GRAPH_INITIALIZATION_ERROR
LINEAGE_CYCLE
NO_CONFIG_DOC
NODE_NOT_FOUND
OPEN_LINEAGE_HANDLER_NOT_INSTANTIATED
SERVICE_INSTANCE_FAILURE

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 OpenLineageServerErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpenLineageServerErrorCode[]	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 OpenLineageServerErrorCode NO_CONFIG_DOC

SERVICE_INSTANCE_FAILURE

public static final OpenLineageServerErrorCode SERVICE_INSTANCE_FAILURE

CANNOT_OPEN_GRAPH_DB

public static final OpenLineageServerErrorCode CANNOT_OPEN_GRAPH_DB

ERROR_INITIALIZING_BUFFER_GRAPH_CONNECTOR_DB

public static final OpenLineageServerErrorCode ERROR_INITIALIZING_BUFFER_GRAPH_CONNECTOR_DB

ERROR_INITIALIZING_MAIN_GRAPH_CONNECTOR_DB

public static final OpenLineageServerErrorCode ERROR_INITIALIZING_MAIN_GRAPH_CONNECTOR_DB

ERROR_STARTING_BUFFER_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_STARTING_BUFFER_GRAPH_CONNECTOR

ERROR_STARTING_MAIN_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_STARTING_MAIN_GRAPH_CONNECTOR

ERROR_OBTAINING_IN_TOPIC_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_OBTAINING_IN_TOPIC_CONNECTOR

ERROR_OBTAINING_BUFFER_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_OBTAINING_BUFFER_GRAPH_CONNECTOR

ERROR_OBTAINING_MAIN_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_OBTAINING_MAIN_GRAPH_CONNECTOR

ERROR_STARTING_IN_TOPIC_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_STARTING_IN_TOPIC_CONNECTOR

ERROR_DISCONNECTING_BUFFER_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_DISCONNECTING_BUFFER_GRAPH_CONNECTOR

ERROR_DISCONNECTING_MAIN_GRAPH_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_DISCONNECTING_MAIN_GRAPH_CONNECTOR

ERROR_DISCONNECTING_IN_TOPIC_CONNECTOR

public static final OpenLineageServerErrorCode ERROR_DISCONNECTING_IN_TOPIC_CONNECTOR

NODE_NOT_FOUND

public static final OpenLineageServerErrorCode NODE_NOT_FOUND

GRAPH_INITIALIZATION_ERROR

public static final OpenLineageServerErrorCode GRAPH_INITIALIZATION_ERROR

OPEN_LINEAGE_HANDLER_NOT_INSTANTIATED

public static final OpenLineageServerErrorCode OPEN_LINEAGE_HANDLER_NOT_INSTANTIATED

LINEAGE_CYCLE

public static final OpenLineageServerErrorCode LINEAGE_CYCLE

ERROR_INITIALIZING_OLS

public static final OpenLineageServerErrorCode ERROR_INITIALIZING_OLS

Method Detail

values

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

Returns:

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

valueOf

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