Package org.odpi.openmetadata.conformance.ffdc

Enum Class ConformanceSuiteErrorCode

java.lang.Object

java.lang.Enum<ConformanceSuiteErrorCode>

org.odpi.openmetadata.conformance.ffdc.ConformanceSuiteErrorCode

All Implemented Interfaces:

Serializable, Comparable<ConformanceSuiteErrorCode>, Constable, ExceptionMessageSet

public enum ConformanceSuiteErrorCode
extends Enum<ConformanceSuiteErrorCode>
implements ExceptionMessageSet

The ConformanceSuiteErrorCode is used to define first failure data capture (FFDC) for errors that occur within the Open Metadata Conformance Suite It is used in conjunction with conformance suite 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

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
BAD_ACCESS_SERVICE_ADMIN_CLASS
BAD_CLIENT_CONFIG
BAD_CONFIG_FILE
BAD_MAX_PAGE_SIZE
DUPLICATE_TEST_CASE
EMPTY_CONFIGURATION
ENTERPRISE_TOPIC_START_FAILED
EXCEPTION_RESPONSE_FROM_API
LOCAL_REPOSITORY_MODE_NOT_SET
NO_ENTERPRISE_ACCESS
NO_ENTERPRISE_CONNECTOR_MANAGER
NO_ENTERPRISE_TOPIC
NO_EVENT_BUS_SET
NULL_ACCESS_SERVICE_ADMIN_CLASS
NULL_ACCESS_SERVICE_ROOT_URL
NULL_ACCESS_SERVICE_SERVER_NAME
NULL_FILE_NAME
NULL_LOCAL_SERVER_NAME
NULL_METADATA_COLLECTION_NAME
NULL_REPOSITORY_CONFIG
NULL_SERVER_CONFIG
NULL_USER_ID
SERVICE_NOT_INITIALIZED
TOO_LATE_TO_SET_EVENT_BUS
UNKNOWN_PROFILE_NAME
UNKNOWN_TEST_CASE_ID
UNKNOWN_WORKBENCH_ID

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

NULL_LOCAL_SERVER_NAME

public static final ConformanceSuiteErrorCode NULL_LOCAL_SERVER_NAME

NULL_USER_ID

public static final ConformanceSuiteErrorCode NULL_USER_ID

UNKNOWN_TEST_CASE_ID

public static final ConformanceSuiteErrorCode UNKNOWN_TEST_CASE_ID

UNKNOWN_WORKBENCH_ID

public static final ConformanceSuiteErrorCode UNKNOWN_WORKBENCH_ID

BAD_CLIENT_CONFIG

public static final ConformanceSuiteErrorCode BAD_CLIENT_CONFIG

LOCAL_REPOSITORY_MODE_NOT_SET

public static final ConformanceSuiteErrorCode LOCAL_REPOSITORY_MODE_NOT_SET

NULL_SERVER_CONFIG

public static final ConformanceSuiteErrorCode NULL_SERVER_CONFIG

NULL_REPOSITORY_CONFIG

public static final ConformanceSuiteErrorCode NULL_REPOSITORY_CONFIG

NULL_ACCESS_SERVICE_ADMIN_CLASS

public static final ConformanceSuiteErrorCode NULL_ACCESS_SERVICE_ADMIN_CLASS

BAD_ACCESS_SERVICE_ADMIN_CLASS

public static final ConformanceSuiteErrorCode BAD_ACCESS_SERVICE_ADMIN_CLASS

BAD_CONFIG_FILE

public static final ConformanceSuiteErrorCode BAD_CONFIG_FILE

BAD_MAX_PAGE_SIZE

public static final ConformanceSuiteErrorCode BAD_MAX_PAGE_SIZE

ENTERPRISE_TOPIC_START_FAILED

public static final ConformanceSuiteErrorCode ENTERPRISE_TOPIC_START_FAILED

TOO_LATE_TO_SET_EVENT_BUS

public static final ConformanceSuiteErrorCode TOO_LATE_TO_SET_EVENT_BUS

NO_EVENT_BUS_SET

public static final ConformanceSuiteErrorCode NO_EVENT_BUS_SET

NULL_METADATA_COLLECTION_NAME

public static final ConformanceSuiteErrorCode NULL_METADATA_COLLECTION_NAME

EMPTY_CONFIGURATION

public static final ConformanceSuiteErrorCode EMPTY_CONFIGURATION

NULL_ACCESS_SERVICE_ROOT_URL

public static final ConformanceSuiteErrorCode NULL_ACCESS_SERVICE_ROOT_URL

NULL_ACCESS_SERVICE_SERVER_NAME

public static final ConformanceSuiteErrorCode NULL_ACCESS_SERVICE_SERVER_NAME

NULL_FILE_NAME

public static final ConformanceSuiteErrorCode NULL_FILE_NAME

NO_ENTERPRISE_ACCESS

public static final ConformanceSuiteErrorCode NO_ENTERPRISE_ACCESS

UNKNOWN_PROFILE_NAME

public static final ConformanceSuiteErrorCode UNKNOWN_PROFILE_NAME

NO_ENTERPRISE_TOPIC

public static final ConformanceSuiteErrorCode NO_ENTERPRISE_TOPIC

NO_ENTERPRISE_CONNECTOR_MANAGER

public static final ConformanceSuiteErrorCode NO_ENTERPRISE_CONNECTOR_MANAGER

DUPLICATE_TEST_CASE

public static final ConformanceSuiteErrorCode DUPLICATE_TEST_CASE

SERVICE_NOT_INITIALIZED

public static final ConformanceSuiteErrorCode SERVICE_NOT_INITIALIZED

EXCEPTION_RESPONSE_FROM_API

public static final ConformanceSuiteErrorCode EXCEPTION_RESPONSE_FROM_API

Method Details

values

public static ConformanceSuiteErrorCode[] 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 ConformanceSuiteErrorCode 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<ConformanceSuiteErrorCode>

Returns:

string of property names and values for this enum