Package org.odpi.openmetadata.accessservices.assetowner.ffdc

Enum Class AssetOwnerErrorCode

java.lang.Object

java.lang.Enum<AssetOwnerErrorCode>

org.odpi.openmetadata.accessservices.assetowner.ffdc.AssetOwnerErrorCode

All Implemented Interfaces:

Serializable, Comparable<AssetOwnerErrorCode>, Constable, ExceptionMessageSet

public enum AssetOwnerErrorCode
extends Enum<AssetOwnerErrorCode>
implements ExceptionMessageSet

The AssetOwnerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Asset Owner OMAS 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
  • 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 owner should correct the error

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NULL_CONNECTOR_RETURNED	OMAS-ASSET-OWNER-500-002 - The requested connector for connection named {0} is not returned by the OMAG Server {1}
NULL_LISTENER	OMAS-ASSET-OWNER-400-019 - A null topic listener has been passed by user {0} on method {1}
OMRS_NOT_INITIALIZED	OMAS-ASSET-OWNER-404-002 - The open metadata repository services are not initialized for the {0} operation
UNABLE_TO_SEND_EVENT	OMAS-ASSET-OWNER-500-004 - An unexpected exception occurred when sending an event through connector {0} to the Asset Owner OMAS out topic.
WRONG_TYPE_OF_CONNECTOR	OMAS-ASSET-OWNER-500-007 - The connector generated from the connection named {0} return by the {1} service running in OMAG Server {2} at {3} is not of the required type.

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 AssetOwnerErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AssetOwnerErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULL_LISTENER

public static final AssetOwnerErrorCode NULL_LISTENER

OMAS-ASSET-OWNER-400-019 - A null topic listener has been passed by user {0} on method {1}

OMRS_NOT_INITIALIZED

public static final AssetOwnerErrorCode OMRS_NOT_INITIALIZED

OMAS-ASSET-OWNER-404-002 - The open metadata repository services are not initialized for the {0} operation

NULL_CONNECTOR_RETURNED

public static final AssetOwnerErrorCode NULL_CONNECTOR_RETURNED

OMAS-ASSET-OWNER-500-002 - The requested connector for connection named {0} is not returned by the OMAG Server {1}

UNABLE_TO_SEND_EVENT

public static final AssetOwnerErrorCode UNABLE_TO_SEND_EVENT

OMAS-ASSET-OWNER-500-004 - An unexpected exception occurred when sending an event through connector {0} to the Asset Owner OMAS out topic. The failing event was {1}, the exception was {2} with message {3}

WRONG_TYPE_OF_CONNECTOR

public static final AssetOwnerErrorCode WRONG_TYPE_OF_CONNECTOR

OMAS-ASSET-OWNER-500-007 - The connector generated from the connection named {0} return by the {1} service running in OMAG Server {2} at {3} is not of the required type. It should be an instance of {4}

Method Details

values

public static AssetOwnerErrorCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AssetOwnerErrorCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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<AssetOwnerErrorCode>

Returns:

string of property names and values for this enum