org.odpi.openmetadata.commonservices.generichandlers.ffdc

Enum GenericHandlersErrorCode

java.lang.Object

java.lang.Enum<GenericHandlersErrorCode>

org.odpi.openmetadata.commonservices.generichandlers.ffdc.GenericHandlersErrorCode

All Implemented Interfaces:

Serializable, Comparable<GenericHandlersErrorCode>, ExceptionMessageSet

public enum GenericHandlersErrorCode
extends Enum<GenericHandlersErrorCode>
implements ExceptionMessageSet

The GenericHandlersErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Repository Handler Services. 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
  • 403 - forbidden
  • 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_INSTANCE_TYPE
BAD_INTEGRATOR_NAME
INTEGRATOR_NOT_RETURNED
INVALID_BEAN_CLASS
MISSING_CONVERTER_METHOD
MISSING_METADATA_INSTANCE
MULTIPLE_CONNECTIONS_FOUND
MULTIPLE_ENTITIES_FOUND
ONLY_CREATOR_CAN_DELETE
UNEXPECTED_BEAN_CLASS

Method Summary

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

INTEGRATOR_NOT_RETURNED

public static final GenericHandlersErrorCode INTEGRATOR_NOT_RETURNED

BAD_INTEGRATOR_NAME

public static final GenericHandlersErrorCode BAD_INTEGRATOR_NAME

ONLY_CREATOR_CAN_DELETE

public static final GenericHandlersErrorCode ONLY_CREATOR_CAN_DELETE

MULTIPLE_CONNECTIONS_FOUND

public static final GenericHandlersErrorCode MULTIPLE_CONNECTIONS_FOUND

MULTIPLE_ENTITIES_FOUND

public static final GenericHandlersErrorCode MULTIPLE_ENTITIES_FOUND

INVALID_BEAN_CLASS

public static final GenericHandlersErrorCode INVALID_BEAN_CLASS

MISSING_CONVERTER_METHOD

public static final GenericHandlersErrorCode MISSING_CONVERTER_METHOD

UNEXPECTED_BEAN_CLASS

public static final GenericHandlersErrorCode UNEXPECTED_BEAN_CLASS

MISSING_METADATA_INSTANCE

public static final GenericHandlersErrorCode MISSING_METADATA_INSTANCE

BAD_INSTANCE_TYPE

public static final GenericHandlersErrorCode BAD_INSTANCE_TYPE

Method Detail

values

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

Returns:

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

valueOf

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

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<GenericHandlersErrorCode>

Returns:

string of property names and values for this enum