org.odpi.egeria.connectors.juxt.crux.auditlog

Enum CruxOMRSErrorCode

java.lang.Object

java.lang.Enum<CruxOMRSErrorCode>

org.odpi.egeria.connectors.juxt.crux.auditlog.CruxOMRSErrorCode

All Implemented Interfaces:

Serializable, Comparable<CruxOMRSErrorCode>, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

public enum CruxOMRSErrorCode
extends Enum<CruxOMRSErrorCode>
implements org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

The CruxOMRSErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with Crux as an OMRS Metadata Repository. 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
  • 404 - not found
• 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 AssetConsumerInterface should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANNOT_CLOSE_RESOURCE
CANNOT_READ_CONFIGURATION
ENTITY_HOME_COLLECTION_REFERENCE
ENTITY_NOT_KNOWN
ENTITY_PROXY_ONLY
FAILED_DISCONNECT
INVALID_CLASSIFICATION_FOR_ENTITY
METADATA_COLLECTION_CONFLICT
PERSISTENCE_LAYER_MISMATCH
QUERY_TIMEOUT
REGEX_NOT_IMPLEMENTED
RELATIONSHIP_NOT_KNOWN
UNKNOWN_RUNTIME_ERROR

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for an exception.
String	toString() toString() JSON-style
static CruxOMRSErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CruxOMRSErrorCode[]	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

ENTITY_HOME_COLLECTION_REFERENCE

public static final CruxOMRSErrorCode ENTITY_HOME_COLLECTION_REFERENCE

METADATA_COLLECTION_CONFLICT

public static final CruxOMRSErrorCode METADATA_COLLECTION_CONFLICT

ENTITY_PROXY_ONLY

public static final CruxOMRSErrorCode ENTITY_PROXY_ONLY

INVALID_CLASSIFICATION_FOR_ENTITY

public static final CruxOMRSErrorCode INVALID_CLASSIFICATION_FOR_ENTITY

CANNOT_READ_CONFIGURATION

public static final CruxOMRSErrorCode CANNOT_READ_CONFIGURATION

QUERY_TIMEOUT

public static final CruxOMRSErrorCode QUERY_TIMEOUT

ENTITY_NOT_KNOWN

public static final CruxOMRSErrorCode ENTITY_NOT_KNOWN

RELATIONSHIP_NOT_KNOWN

public static final CruxOMRSErrorCode RELATIONSHIP_NOT_KNOWN

UNKNOWN_RUNTIME_ERROR

public static final CruxOMRSErrorCode UNKNOWN_RUNTIME_ERROR

CANNOT_CLOSE_RESOURCE

public static final CruxOMRSErrorCode CANNOT_CLOSE_RESOURCE

FAILED_DISCONNECT

public static final CruxOMRSErrorCode FAILED_DISCONNECT

PERSISTENCE_LAYER_MISMATCH

public static final CruxOMRSErrorCode PERSISTENCE_LAYER_MISMATCH

REGEX_NOT_IMPLEMENTED

public static final CruxOMRSErrorCode REGEX_NOT_IMPLEMENTED

Method Detail

values

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

Returns:

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

valueOf

public static CruxOMRSErrorCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

Returns:

message definition object.

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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()

toString() JSON-style

Overrides:

toString in class Enum<CruxOMRSErrorCode>

Returns:

string description