org.odpi.openmetadata.accessservices.connectedasset.ffdc

Enum ConnectedAssetErrorCode

java.lang.Object

java.lang.Enum<ConnectedAssetErrorCode>

org.odpi.openmetadata.accessservices.connectedasset.ffdc.ConnectedAssetErrorCode

All Implemented Interfaces:

Serializable, Comparable<ConnectedAssetErrorCode>

public enum ConnectedAssetErrorCode
extends Enum<ConnectedAssetErrorCode>

The ConnectedAssetErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OCF Connectors. It is used in conjunction with all Connected Asset OMAS 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
  • 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 consumer should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASSET_NOT_FOUND
CLIENT_SIDE_REST_API_ERROR
CONNECTION_NOT_FOUND
NO_CONNECTED_ASSET
NO_METADATA_COLLECTION
NULL_CLASSIFICATION_NAME
NULL_CONNECTION
NULL_CONNECTION_ID
NULL_CONNECTION_RETURNED
NULL_CONNECTOR_RETURNED
NULL_ENUM
NULL_GUID
NULL_NAME
NULL_PROPERTY_NAME
NULL_RELATED_ASSET
NULL_RESPONSE_FROM_API
NULL_TAG_NAME
NULL_USER_ID
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
PROPERTY_SERVER_ERROR
PROXY_CONNECTION_FOUND
SERVER_NOT_AVAILABLE
SERVER_URL_MALFORMED
SERVER_URL_NOT_SPECIFIED
SERVICE_NOT_INITIALIZED
TOO_MANY_CONNECTIONS
UNKNOWN_ASSET
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	getUnformattedErrorMessage() Returns the error message with placeholders for specific details.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
String	toString() JSON-style toString
static ConnectedAssetErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConnectedAssetErrorCode[]	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

SERVER_URL_NOT_SPECIFIED

public static final ConnectedAssetErrorCode SERVER_URL_NOT_SPECIFIED

SERVER_URL_MALFORMED

public static final ConnectedAssetErrorCode SERVER_URL_MALFORMED

NULL_USER_ID

public static final ConnectedAssetErrorCode NULL_USER_ID

NULL_GUID

public static final ConnectedAssetErrorCode NULL_GUID

NULL_NAME

public static final ConnectedAssetErrorCode NULL_NAME

NO_CONNECTED_ASSET

public static final ConnectedAssetErrorCode NO_CONNECTED_ASSET

TOO_MANY_CONNECTIONS

public static final ConnectedAssetErrorCode TOO_MANY_CONNECTIONS

USER_NOT_AUTHORIZED

public static final ConnectedAssetErrorCode USER_NOT_AUTHORIZED

PROPERTY_SERVER_ERROR

public static final ConnectedAssetErrorCode PROPERTY_SERVER_ERROR

NULL_ENUM

public static final ConnectedAssetErrorCode NULL_ENUM

NULL_CONNECTION

public static final ConnectedAssetErrorCode NULL_CONNECTION

NULL_CONNECTION_ID

public static final ConnectedAssetErrorCode NULL_CONNECTION_ID

NULL_RELATED_ASSET

public static final ConnectedAssetErrorCode NULL_RELATED_ASSET

NULL_PROPERTY_NAME

public static final ConnectedAssetErrorCode NULL_PROPERTY_NAME

NULL_CLASSIFICATION_NAME

public static final ConnectedAssetErrorCode NULL_CLASSIFICATION_NAME

NULL_TAG_NAME

public static final ConnectedAssetErrorCode NULL_TAG_NAME

SERVER_NOT_AVAILABLE

public static final ConnectedAssetErrorCode SERVER_NOT_AVAILABLE

OMRS_NOT_INITIALIZED

public static final ConnectedAssetErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final ConnectedAssetErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final ConnectedAssetErrorCode NO_METADATA_COLLECTION

CONNECTION_NOT_FOUND

public static final ConnectedAssetErrorCode CONNECTION_NOT_FOUND

ASSET_NOT_FOUND

public static final ConnectedAssetErrorCode ASSET_NOT_FOUND

PROXY_CONNECTION_FOUND

public static final ConnectedAssetErrorCode PROXY_CONNECTION_FOUND

UNKNOWN_ASSET

public static final ConnectedAssetErrorCode UNKNOWN_ASSET

NULL_CONNECTION_RETURNED

public static final ConnectedAssetErrorCode NULL_CONNECTION_RETURNED

NULL_CONNECTOR_RETURNED

public static final ConnectedAssetErrorCode NULL_CONNECTOR_RETURNED

NULL_RESPONSE_FROM_API

public static final ConnectedAssetErrorCode NULL_RESPONSE_FROM_API

CLIENT_SIDE_REST_API_ERROR

public static final ConnectedAssetErrorCode CLIENT_SIDE_REST_API_ERROR

SERVICE_NOT_INITIALIZED

public static final ConnectedAssetErrorCode SERVICE_NOT_INITIALIZED

Method Detail

values

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

Returns:

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

valueOf

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

getUnformattedErrorMessage

public String getUnformattedErrorMessage()

Returns the error message with placeholders for specific details.

Returns:

errorMessage (unformatted)

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<ConnectedAssetErrorCode>

Returns:

string of property names and values for this enum