Package 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	Description
BAD_ENTITY
BAD_ENTITY_PROXY
BAD_INSTANCE_TYPE
BAD_INTEGRATOR_NAME
BAD_RELATIONSHIP
INTEGRATOR_NOT_RETURNED
INVALID_BEAN_CLASS
INVALID_GOVERNANCE_ACTION_STATUS
INVALID_PROCESSING_USER
MISSING_CONVERTER_METHOD
MISSING_GOVERNANCE_ACTION
MISSING_GOVERNANCE_ACTION_PROPERTIES
MISSING_METADATA_INSTANCE
MULTIPLE_BEANS_FOUND
MULTIPLE_CONNECTIONS_FOUND
MULTIPLE_ENTITIES_FOUND
MULTIPLE_RELATIONSHIPS_FOUND
NO_PROCESS_IMPLEMENTATION
NULL_ANCHOR_GUID
NULL_EXTERNAL_ID_ENTITY
ONLY_CREATOR_CAN_DELETE
UNEXPECTED_BEAN_CLASS
UNKNOWN_ANCHOR_GUID
UNKNOWN_ENGINE_NAME
UNKNOWN_EXECUTOR
UNKNOWN_EXTERNAL_IDENTITY
UNKNOWN_RESOURCE_LINK
WRONG_END_GUID

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

UNKNOWN_EXTERNAL_IDENTITY

public static final GenericHandlersErrorCode UNKNOWN_EXTERNAL_IDENTITY

UNKNOWN_RESOURCE_LINK

public static final GenericHandlersErrorCode UNKNOWN_RESOURCE_LINK

UNKNOWN_ENGINE_NAME

public static final GenericHandlersErrorCode UNKNOWN_ENGINE_NAME

UNKNOWN_EXECUTOR

public static final GenericHandlersErrorCode UNKNOWN_EXECUTOR

NO_PROCESS_IMPLEMENTATION

public static final GenericHandlersErrorCode NO_PROCESS_IMPLEMENTATION

WRONG_END_GUID

public static final GenericHandlersErrorCode WRONG_END_GUID

ONLY_CREATOR_CAN_DELETE

public static final GenericHandlersErrorCode ONLY_CREATOR_CAN_DELETE

INVALID_PROCESSING_USER

public static final GenericHandlersErrorCode INVALID_PROCESSING_USER

INVALID_GOVERNANCE_ACTION_STATUS

public static final GenericHandlersErrorCode INVALID_GOVERNANCE_ACTION_STATUS

MULTIPLE_CONNECTIONS_FOUND

public static final GenericHandlersErrorCode MULTIPLE_CONNECTIONS_FOUND

MULTIPLE_ENTITIES_FOUND

public static final GenericHandlersErrorCode MULTIPLE_ENTITIES_FOUND

MULTIPLE_BEANS_FOUND

public static final GenericHandlersErrorCode MULTIPLE_BEANS_FOUND

MULTIPLE_RELATIONSHIPS_FOUND

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

NULL_EXTERNAL_ID_ENTITY

public static final GenericHandlersErrorCode NULL_EXTERNAL_ID_ENTITY

MISSING_GOVERNANCE_ACTION

public static final GenericHandlersErrorCode MISSING_GOVERNANCE_ACTION

MISSING_GOVERNANCE_ACTION_PROPERTIES

public static final GenericHandlersErrorCode MISSING_GOVERNANCE_ACTION_PROPERTIES

UNKNOWN_ANCHOR_GUID

public static final GenericHandlersErrorCode UNKNOWN_ANCHOR_GUID

NULL_ANCHOR_GUID

public static final GenericHandlersErrorCode NULL_ANCHOR_GUID

BAD_ENTITY

public static final GenericHandlersErrorCode BAD_ENTITY

BAD_ENTITY_PROXY

public static final GenericHandlersErrorCode BAD_ENTITY_PROXY

BAD_RELATIONSHIP

public static final GenericHandlersErrorCode BAD_RELATIONSHIP

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