org.odpi.openmetadata.commonservices.multitenant.ffdc

Enum OMAGServerInstanceErrorCode

java.lang.Object

java.lang.Enum<OMAGServerInstanceErrorCode>

org.odpi.openmetadata.commonservices.multitenant.ffdc.OMAGServerInstanceErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMAGServerInstanceErrorCode>, ExceptionMessageSet

public enum OMAGServerInstanceErrorCode
extends Enum<OMAGServerInstanceErrorCode>
implements ExceptionMessageSet

The OMAGServerInstanceErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OMAG Server instances within the OMAG Server Platform It is used in conjunction with all multi-tenant 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
BAD_SERVER_SECURITY_CONNECTION
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
SERVER_NAME_NOT_AVAILABLE
SERVER_NOT_AVAILABLE
SERVICE_NOT_AVAILABLE
SERVICES_NOT_SHUTDOWN

Method Summary

Modifier and Type	Method and 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 OMAGServerInstanceErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OMAGServerInstanceErrorCode[]	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

BAD_SERVER_SECURITY_CONNECTION

public static final OMAGServerInstanceErrorCode BAD_SERVER_SECURITY_CONNECTION

SERVICES_NOT_SHUTDOWN

public static final OMAGServerInstanceErrorCode SERVICES_NOT_SHUTDOWN

SERVER_NOT_AVAILABLE

public static final OMAGServerInstanceErrorCode SERVER_NOT_AVAILABLE

SERVICE_NOT_AVAILABLE

public static final OMAGServerInstanceErrorCode SERVICE_NOT_AVAILABLE

SERVER_NAME_NOT_AVAILABLE

public static final OMAGServerInstanceErrorCode SERVER_NAME_NOT_AVAILABLE

OMRS_NOT_INITIALIZED

public static final OMAGServerInstanceErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final OMAGServerInstanceErrorCode OMRS_NOT_AVAILABLE

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

string of property names and values for this enum