Package org.odpi.openmetadata.adapters.connectors.integration.openapis.ffdc

Enum Class OpenAPIIntegrationConnectorErrorCode

java.lang.Object

java.lang.Enum<OpenAPIIntegrationConnectorErrorCode>

org.odpi.openmetadata.adapters.connectors.integration.openapis.ffdc.OpenAPIIntegrationConnectorErrorCode

All Implemented Interfaces:

Serializable, Comparable<OpenAPIIntegrationConnectorErrorCode>, Constable, ExceptionMessageSet

public enum OpenAPIIntegrationConnectorErrorCode
extends Enum<OpenAPIIntegrationConnectorErrorCode>
implements ExceptionMessageSet

The OpenAPIIntegrationConnectorErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Basic File Connector. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. 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 Identifier - 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 consumer should correct the error

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT_SIDE_REST_API_ERROR
NULL_URL
UNEXPECTED_EXCEPTION

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNEXPECTED_EXCEPTION

public static final OpenAPIIntegrationConnectorErrorCode UNEXPECTED_EXCEPTION

NULL_URL

public static final OpenAPIIntegrationConnectorErrorCode NULL_URL

CLIENT_SIDE_REST_API_ERROR

public static final OpenAPIIntegrationConnectorErrorCode CLIENT_SIDE_REST_API_ERROR

Method Details

values

public static OpenAPIIntegrationConnectorErrorCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OpenAPIIntegrationConnectorErrorCode valueOf(String name)

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<OpenAPIIntegrationConnectorErrorCode>

Returns:

string of property names and values for this enum