org.odpi.openmetadata.adminservices.ffdc

Enum OMAGErrorCode

java.lang.Object

java.lang.Enum<OMAGErrorCode>

org.odpi.openmetadata.adminservices.ffdc.OMAGErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMAGErrorCode>

public enum OMAGErrorCode
extends Enum<OMAGErrorCode>

The OMAGErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMAG Server It is used in conjunction with OMAG 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
  • 501 - not implemented
  • 503 - Service not available
  • 400 - invalid parameters
  • 401 - unauthorized
  • 404 - not found
  • 405 - method not allowed
  • 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
BAD_ACCESS_SERVICE_ADMIN_CLASS
BAD_CONFIG_FILE
BAD_LOCAL_SERVER_NAME
BAD_MAX_PAGE_SIZE
ENTERPRISE_TOPIC_START_FAILED
LOCAL_REPOSITORY_MODE_NOT_SET
NO_EVENT_BUS_SET
NULL_ACCESS_SERVICE_ADMIN_CLASS
NULL_COHORT_NAME
NULL_LOCAL_SERVER_NAME
NULL_REPOSITORY_CONFIG
NULL_SERVER_CONFIG
NULL_USER_NAME
TOO_LATE_TO_SET_EVENT_BUS

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

NULL_LOCAL_SERVER_NAME

public static final OMAGErrorCode NULL_LOCAL_SERVER_NAME

BAD_LOCAL_SERVER_NAME

public static final OMAGErrorCode BAD_LOCAL_SERVER_NAME

NULL_USER_NAME

public static final OMAGErrorCode NULL_USER_NAME

NULL_COHORT_NAME

public static final OMAGErrorCode NULL_COHORT_NAME

LOCAL_REPOSITORY_MODE_NOT_SET

public static final OMAGErrorCode LOCAL_REPOSITORY_MODE_NOT_SET

NULL_SERVER_CONFIG

public static final OMAGErrorCode NULL_SERVER_CONFIG

NULL_REPOSITORY_CONFIG

public static final OMAGErrorCode NULL_REPOSITORY_CONFIG

NULL_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGErrorCode NULL_ACCESS_SERVICE_ADMIN_CLASS

BAD_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGErrorCode BAD_ACCESS_SERVICE_ADMIN_CLASS

BAD_CONFIG_FILE

public static final OMAGErrorCode BAD_CONFIG_FILE

BAD_MAX_PAGE_SIZE

public static final OMAGErrorCode BAD_MAX_PAGE_SIZE

ENTERPRISE_TOPIC_START_FAILED

public static final OMAGErrorCode ENTERPRISE_TOPIC_START_FAILED

TOO_LATE_TO_SET_EVENT_BUS

public static final OMAGErrorCode TOO_LATE_TO_SET_EVENT_BUS

NO_EVENT_BUS_SET

public static final OMAGErrorCode NO_EVENT_BUS_SET

Method Detail

values

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

Returns:

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

valueOf

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