org.odpi.openmetadata.commonservices.ffdc

Enum OMAGCommonErrorCode

java.lang.Object

java.lang.Enum<OMAGCommonErrorCode>

org.odpi.openmetadata.commonservices.ffdc.OMAGCommonErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMAGCommonErrorCode>

public enum OMAGCommonErrorCode
extends Enum<OMAGCommonErrorCode>

The OMAGCommonErrorCode is used to define first failure data capture (FFDC) for common errors. 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 consumer should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_SUB_TYPE_NAME
CANNOT_DELETE_ELEMENT_IN_USE
CLIENT_SIDE_REST_API_ERROR
INSTANCE_WRONG_TYPE_FOR_GUID
MAX_PAGE_SIZE
METHOD_NOT_IMPLEMENTED
NEGATIVE_PAGE_SIZE
NEGATIVE_START_FROM
NO_REQUEST_BODY
NOT_IN_THE_ZONE
NULL_ARRAY_PARAMETER
NULL_CONNECTION_PARAMETER
NULL_CONNECTOR_TYPE_PARAMETER
NULL_ENUM
NULL_GUID
NULL_LOCAL_SERVER_NAME
NULL_NAME
NULL_OBJECT
NULL_SEARCH_STRING
NULL_TEXT
NULL_USER_ID
SERVER_NAME_NOT_SPECIFIED
SERVER_URL_MALFORMED
SERVER_URL_NOT_SPECIFIED
UNEXPECTED_EXCEPTION
UNKNOWN_ELEMENT
UNRECOGNIZED_TYPE_NAME

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	getUnformattedErrorMessage() Returns the error message with placeholders for specific details.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
String	toString() JSON-style toString
static OMAGCommonErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OMAGCommonErrorCode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVER_URL_NOT_SPECIFIED

public static final OMAGCommonErrorCode SERVER_URL_NOT_SPECIFIED

SERVER_URL_MALFORMED

public static final OMAGCommonErrorCode SERVER_URL_MALFORMED

SERVER_NAME_NOT_SPECIFIED

public static final OMAGCommonErrorCode SERVER_NAME_NOT_SPECIFIED

NULL_USER_ID

public static final OMAGCommonErrorCode NULL_USER_ID

NULL_GUID

public static final OMAGCommonErrorCode NULL_GUID

NULL_NAME

public static final OMAGCommonErrorCode NULL_NAME

NULL_ARRAY_PARAMETER

public static final OMAGCommonErrorCode NULL_ARRAY_PARAMETER

NEGATIVE_START_FROM

public static final OMAGCommonErrorCode NEGATIVE_START_FROM

NEGATIVE_PAGE_SIZE

public static final OMAGCommonErrorCode NEGATIVE_PAGE_SIZE

MAX_PAGE_SIZE

public static final OMAGCommonErrorCode MAX_PAGE_SIZE

NULL_CONNECTION_PARAMETER

public static final OMAGCommonErrorCode NULL_CONNECTION_PARAMETER

NULL_ENUM

public static final OMAGCommonErrorCode NULL_ENUM

NULL_TEXT

public static final OMAGCommonErrorCode NULL_TEXT

NULL_LOCAL_SERVER_NAME

public static final OMAGCommonErrorCode NULL_LOCAL_SERVER_NAME

NULL_OBJECT

public static final OMAGCommonErrorCode NULL_OBJECT

UNEXPECTED_EXCEPTION

public static final OMAGCommonErrorCode UNEXPECTED_EXCEPTION

NO_REQUEST_BODY

public static final OMAGCommonErrorCode NO_REQUEST_BODY

UNRECOGNIZED_TYPE_NAME

public static final OMAGCommonErrorCode UNRECOGNIZED_TYPE_NAME

BAD_SUB_TYPE_NAME

public static final OMAGCommonErrorCode BAD_SUB_TYPE_NAME

NOT_IN_THE_ZONE

public static final OMAGCommonErrorCode NOT_IN_THE_ZONE

UNKNOWN_ELEMENT

public static final OMAGCommonErrorCode UNKNOWN_ELEMENT

NULL_SEARCH_STRING

public static final OMAGCommonErrorCode NULL_SEARCH_STRING

CANNOT_DELETE_ELEMENT_IN_USE

public static final OMAGCommonErrorCode CANNOT_DELETE_ELEMENT_IN_USE

NULL_CONNECTOR_TYPE_PARAMETER

public static final OMAGCommonErrorCode NULL_CONNECTOR_TYPE_PARAMETER

INSTANCE_WRONG_TYPE_FOR_GUID

public static final OMAGCommonErrorCode INSTANCE_WRONG_TYPE_FOR_GUID

METHOD_NOT_IMPLEMENTED

public static final OMAGCommonErrorCode METHOD_NOT_IMPLEMENTED

CLIENT_SIDE_REST_API_ERROR

public static final OMAGCommonErrorCode CLIENT_SIDE_REST_API_ERROR

Method Detail

values

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

Returns:

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

valueOf

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

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<OMAGCommonErrorCode>

Returns:

string of property names and values for this enum