org.odpi.openmetadata.accessservices.governanceengine.api.ffdc.errorcode

Enum GovernanceEngineErrorCode

java.lang.Object

java.lang.Enum<GovernanceEngineErrorCode>

org.odpi.openmetadata.accessservices.governanceengine.api.ffdc.errorcode.GovernanceEngineErrorCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceEngineErrorCode>

public enum GovernanceEngineErrorCode
extends Enum<GovernanceEngineErrorCode>

The GovernanceEngineErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Governance Engine Access Service. 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
  • 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 GovernanceEngineInterface should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_USER_ID
CLIENT_SIDE_REST_API_ERROR
EMPTY_USER_ID
GUID_NOT_FOUND_ERROR
INVALID_EVENT_FORMAT
METADATA_QUERY_ERROR
NO_METADATA_COLLECTION
NULL_GUID
NULL_TEXT
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
PROPERTY_SERVER_ERROR
SERVER_URL_NOT_SPECIFIED
SERVICE_NOT_INITIALIZED
USER_NOT_AUTHORIZED

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	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
static GovernanceEngineErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GovernanceEngineErrorCode[]	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

SERVER_URL_NOT_SPECIFIED

public static final GovernanceEngineErrorCode SERVER_URL_NOT_SPECIFIED

BAD_USER_ID

public static final GovernanceEngineErrorCode BAD_USER_ID

EMPTY_USER_ID

public static final GovernanceEngineErrorCode EMPTY_USER_ID

NULL_GUID

public static final GovernanceEngineErrorCode NULL_GUID

INVALID_EVENT_FORMAT

public static final GovernanceEngineErrorCode INVALID_EVENT_FORMAT

USER_NOT_AUTHORIZED

public static final GovernanceEngineErrorCode USER_NOT_AUTHORIZED

PROPERTY_SERVER_ERROR

public static final GovernanceEngineErrorCode PROPERTY_SERVER_ERROR

NULL_TEXT

public static final GovernanceEngineErrorCode NULL_TEXT

OMRS_NOT_INITIALIZED

public static final GovernanceEngineErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final GovernanceEngineErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final GovernanceEngineErrorCode NO_METADATA_COLLECTION

CLIENT_SIDE_REST_API_ERROR

public static final GovernanceEngineErrorCode CLIENT_SIDE_REST_API_ERROR

SERVICE_NOT_INITIALIZED

public static final GovernanceEngineErrorCode SERVICE_NOT_INITIALIZED

METADATA_QUERY_ERROR

public static final GovernanceEngineErrorCode METADATA_QUERY_ERROR

GUID_NOT_FOUND_ERROR

public static final GovernanceEngineErrorCode GUID_NOT_FOUND_ERROR

Method Detail

values

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

Returns:

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

valueOf

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

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