org.odpi.openmetadata.adminservices.ffdc

Enum OMAGAdminErrorCode

java.lang.Object

java.lang.Enum<OMAGAdminErrorCode>

org.odpi.openmetadata.adminservices.ffdc.OMAGAdminErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMAGAdminErrorCode>

public enum OMAGAdminErrorCode
extends Enum<OMAGAdminErrorCode>

The OMAGAdminErrorCode 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
ACCESS_SERVICE_NOT_ENABLED
ACCESS_SERVICE_NOT_RECOGNIZED
BAD_ACCESS_SERVICE_ADMIN_CLASS
BAD_CONFIG_FILE
BAD_CONFIG_PROPERTIES
BAD_MAX_PAGE_SIZE
BAD_TOPIC_CONNECTOR
BAD_TOPIC_CONNECTOR_PROVIDER
BAD_VIEW_SERVICE_ADMIN_CLASS
CLIENT_SIDE_REST_API_ERROR
COHORT_NOT_KNOWN
COHORT_TOPIC_STRANGE
EMPTY_CONFIGURATION
ENTERPRISE_TOPIC_START_FAILED
INCOMPATIBLE_CONFIG_FILE
INCOMPATIBLE_SERVER_NAMES
INCOMPATIBLE_SUBSYSTEMS
LOCAL_REPOSITORY_MODE_NOT_SET
MISSING_CONFIGURATION_PROPERTY
NO_ENTERPRISE_TOPIC
NO_EVENT_BUS_SET
NULL_ACCESS_SERVICE_ADMIN_CLASS
NULL_ACCESS_SERVICE_ROOT_URL
NULL_ACCESS_SERVICE_SERVER_NAME
NULL_CLIENT_CONFIG
NULL_COHORT_NAME
NULL_CONNECTION
NULL_FILE_NAME
NULL_LOCAL_SERVER_NAME
NULL_LOCAL_SERVER_USERID
NULL_METADATA_COLLECTION_NAME
NULL_OMAG_SERVER_NAME
NULL_OMAG_SERVER_ROOT_URL
NULL_PLATFORM_CONNECTION
NULL_REPOSITORY_CONFIG
NULL_SERVER_CONFIG
NULL_USER_NAME
NULL_VIEW_SERVICE_ADMIN_CLASS
TOO_LATE_TO_SET_EVENT_BUS
UNCLASSIFIABLE_SERVER
UNEXPECTED_EXCEPTION
UNEXPECTED_INITIALIZATION_EXCEPTION
UNEXPECTED_PLATFORM_EXCEPTION
VIEW_SERVICE_NOT_ENABLED
VIEW_SERVICE_NOT_RECOGNIZED

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

INCOMPATIBLE_SERVER_NAMES

public static final OMAGAdminErrorCode INCOMPATIBLE_SERVER_NAMES

NULL_LOCAL_SERVER_USERID

public static final OMAGAdminErrorCode NULL_LOCAL_SERVER_USERID

NULL_USER_NAME

public static final OMAGAdminErrorCode NULL_USER_NAME

ACCESS_SERVICE_NOT_RECOGNIZED

public static final OMAGAdminErrorCode ACCESS_SERVICE_NOT_RECOGNIZED

ACCESS_SERVICE_NOT_ENABLED

public static final OMAGAdminErrorCode ACCESS_SERVICE_NOT_ENABLED

NULL_COHORT_NAME

public static final OMAGAdminErrorCode NULL_COHORT_NAME

LOCAL_REPOSITORY_MODE_NOT_SET

public static final OMAGAdminErrorCode LOCAL_REPOSITORY_MODE_NOT_SET

NULL_SERVER_CONFIG

public static final OMAGAdminErrorCode NULL_SERVER_CONFIG

NULL_REPOSITORY_CONFIG

public static final OMAGAdminErrorCode NULL_REPOSITORY_CONFIG

NULL_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_ADMIN_CLASS

BAD_ACCESS_SERVICE_ADMIN_CLASS

public static final OMAGAdminErrorCode BAD_ACCESS_SERVICE_ADMIN_CLASS

BAD_CONFIG_FILE

public static final OMAGAdminErrorCode BAD_CONFIG_FILE

BAD_MAX_PAGE_SIZE

public static final OMAGAdminErrorCode BAD_MAX_PAGE_SIZE

ENTERPRISE_TOPIC_START_FAILED

public static final OMAGAdminErrorCode ENTERPRISE_TOPIC_START_FAILED

TOO_LATE_TO_SET_EVENT_BUS

public static final OMAGAdminErrorCode TOO_LATE_TO_SET_EVENT_BUS

NO_EVENT_BUS_SET

public static final OMAGAdminErrorCode NO_EVENT_BUS_SET

NULL_METADATA_COLLECTION_NAME

public static final OMAGAdminErrorCode NULL_METADATA_COLLECTION_NAME

EMPTY_CONFIGURATION

public static final OMAGAdminErrorCode EMPTY_CONFIGURATION

NULL_ACCESS_SERVICE_ROOT_URL

public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_ROOT_URL

NULL_ACCESS_SERVICE_SERVER_NAME

public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_SERVER_NAME

NULL_FILE_NAME

public static final OMAGAdminErrorCode NULL_FILE_NAME

INCOMPATIBLE_CONFIG_FILE

public static final OMAGAdminErrorCode INCOMPATIBLE_CONFIG_FILE

BAD_CONFIG_PROPERTIES

public static final OMAGAdminErrorCode BAD_CONFIG_PROPERTIES

NO_ENTERPRISE_TOPIC

public static final OMAGAdminErrorCode NO_ENTERPRISE_TOPIC

BAD_TOPIC_CONNECTOR

public static final OMAGAdminErrorCode BAD_TOPIC_CONNECTOR

NULL_CONNECTION

public static final OMAGAdminErrorCode NULL_CONNECTION

NULL_PLATFORM_CONNECTION

public static final OMAGAdminErrorCode NULL_PLATFORM_CONNECTION

NULL_VIEW_SERVICE_ADMIN_CLASS

public static final OMAGAdminErrorCode NULL_VIEW_SERVICE_ADMIN_CLASS

BAD_VIEW_SERVICE_ADMIN_CLASS

public static final OMAGAdminErrorCode BAD_VIEW_SERVICE_ADMIN_CLASS

INCOMPATIBLE_SUBSYSTEMS

public static final OMAGAdminErrorCode INCOMPATIBLE_SUBSYSTEMS

MISSING_CONFIGURATION_PROPERTY

public static final OMAGAdminErrorCode MISSING_CONFIGURATION_PROPERTY

COHORT_NOT_KNOWN

public static final OMAGAdminErrorCode COHORT_NOT_KNOWN

COHORT_TOPIC_STRANGE

public static final OMAGAdminErrorCode COHORT_TOPIC_STRANGE

UNCLASSIFIABLE_SERVER

public static final OMAGAdminErrorCode UNCLASSIFIABLE_SERVER

VIEW_SERVICE_NOT_RECOGNIZED

public static final OMAGAdminErrorCode VIEW_SERVICE_NOT_RECOGNIZED

VIEW_SERVICE_NOT_ENABLED

public static final OMAGAdminErrorCode VIEW_SERVICE_NOT_ENABLED

NULL_CLIENT_CONFIG

public static final OMAGAdminErrorCode NULL_CLIENT_CONFIG

NULL_OMAG_SERVER_ROOT_URL

public static final OMAGAdminErrorCode NULL_OMAG_SERVER_ROOT_URL

NULL_OMAG_SERVER_NAME

public static final OMAGAdminErrorCode NULL_OMAG_SERVER_NAME

UNEXPECTED_EXCEPTION

public static final OMAGAdminErrorCode UNEXPECTED_EXCEPTION

UNEXPECTED_PLATFORM_EXCEPTION

public static final OMAGAdminErrorCode UNEXPECTED_PLATFORM_EXCEPTION

BAD_TOPIC_CONNECTOR_PROVIDER

public static final OMAGAdminErrorCode BAD_TOPIC_CONNECTOR_PROVIDER

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final OMAGAdminErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION

CLIENT_SIDE_REST_API_ERROR

public static final OMAGAdminErrorCode CLIENT_SIDE_REST_API_ERROR

Method Detail

values

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

Returns:

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

valueOf

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