org.odpi.openmetadata.openconnectors.governancedaemonconnectors.dataengineproxy

Enum DataEngineConnectorErrorCode

java.lang.Object

java.lang.Enum<DataEngineConnectorErrorCode>

org.odpi.openmetadata.openconnectors.governancedaemonconnectors.dataengineproxy.DataEngineConnectorErrorCode

All Implemented Interfaces:

Serializable, Comparable<DataEngineConnectorErrorCode>

public enum DataEngineConnectorErrorCode
extends Enum<DataEngineConnectorErrorCode>

The DataEngineConnectorErrorCode is used to define the errors for Data Engine Connectors. The 5 fields in the enum are:

• HTTP Error Code - to provide guidance on the type of error
• Log Message Id - to uniquely identify the message
• Log Message Text - includes placeholder to allow additional values to be captured
• SystemAction - describes the result of the situation
• UserAction - describes how a user should correct the situation

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_CONFIG
OMAS_CONNECTION_ERROR
USER_NOT_AUTHORIZED

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() Returns the numeric error code that can be used in REST responses.
String	getSystemAction() Returns a description of the action taken by the system when the condition that caused this exception was detected.
String	getUnformattedErrorMessage() Returns the error message with placeholders for specific details.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
static DataEngineConnectorErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataEngineConnectorErrorCode[]	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

OMAS_CONNECTION_ERROR

public static final DataEngineConnectorErrorCode OMAS_CONNECTION_ERROR

USER_NOT_AUTHORIZED

public static final DataEngineConnectorErrorCode USER_NOT_AUTHORIZED

NO_CONFIG

public static final DataEngineConnectorErrorCode NO_CONFIG

Method Detail

values

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

Returns:

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

valueOf

public static DataEngineConnectorErrorCode 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()

Returns the numeric error code that can be used in REST responses.

Returns:

int

getErrorMessageId

public String getErrorMessageId()

Returns the unique identifier for the error message.

Returns:

errorMessageId

getUnformattedErrorMessage

public String getUnformattedErrorMessage()

Returns the error message with placeholders for specific details.

Returns:

errorMessage (unformatted)

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