Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.ffdc

Enum Class IntegrationDaemonServicesErrorCode

java.lang.Object

java.lang.Enum<IntegrationDaemonServicesErrorCode>

org.odpi.openmetadata.governanceservers.integrationdaemonservices.ffdc.IntegrationDaemonServicesErrorCode

All Implemented Interfaces:

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

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

The IntegrationDaemonServicesErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Daemon Services. It is used in conjunction with all 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 user 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
INTEGRATION_DAEMON_INSTANCE_FAILURE
INTEGRATION_GROUP_NOT_INITIALIZED
INVALID_CONTEXT_MANAGER
NO_CONFIG_DOC
NO_INTEGRATION_CONNECTORS_CONFIGURED
NO_INTEGRATION_DAEMON_CLIENT
NO_INTEGRATION_DAEMONS_STARTED
NO_INTEGRATION_GROUPS
NO_INTEGRATION_SERVICES
NO_INTEGRATION_SERVICES_CONFIGURED
NO_OMAS_SERVER_NAME
NO_OMAS_SERVER_URL
NO_PERMITTED_SYNCHRONIZATION
NULL_CONTEXT_MANAGER
NULL_SERVICE_CONFIG_VALUE
SERVICE_INSTANCE_FAILURE
UNKNOWN_CONNECTOR_NAME
UNKNOWN_GOVERNANCE_ENGINE_CONFIG
UNKNOWN_GROUP_NAME
UNKNOWN_INTEGRATION_DAEMON_CONFIG
UNKNOWN_INTEGRATION_DAEMON_CONFIG_AT_STARTUP
UNKNOWN_INTEGRATION_SERVICE
UNRECOGNIZED_SERVICE

Method Summary

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

NO_CONFIG_DOC

public static final IntegrationDaemonServicesErrorCode NO_CONFIG_DOC

NO_INTEGRATION_SERVICES_CONFIGURED

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_SERVICES_CONFIGURED

NO_OMAS_SERVER_URL

public static final IntegrationDaemonServicesErrorCode NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

public static final IntegrationDaemonServicesErrorCode NO_OMAS_SERVER_NAME

INVALID_CONTEXT_MANAGER

public static final IntegrationDaemonServicesErrorCode INVALID_CONTEXT_MANAGER

NO_INTEGRATION_CONNECTORS_CONFIGURED

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_CONNECTORS_CONFIGURED

INTEGRATION_DAEMON_INSTANCE_FAILURE

public static final IntegrationDaemonServicesErrorCode INTEGRATION_DAEMON_INSTANCE_FAILURE

SERVICE_INSTANCE_FAILURE

public static final IntegrationDaemonServicesErrorCode SERVICE_INSTANCE_FAILURE

UNRECOGNIZED_SERVICE

public static final IntegrationDaemonServicesErrorCode UNRECOGNIZED_SERVICE

NULL_SERVICE_CONFIG_VALUE

public static final IntegrationDaemonServicesErrorCode NULL_SERVICE_CONFIG_VALUE

NO_PERMITTED_SYNCHRONIZATION

public static final IntegrationDaemonServicesErrorCode NO_PERMITTED_SYNCHRONIZATION

UNKNOWN_INTEGRATION_DAEMON_CONFIG_AT_STARTUP

public static final IntegrationDaemonServicesErrorCode UNKNOWN_INTEGRATION_DAEMON_CONFIG_AT_STARTUP

NO_INTEGRATION_DAEMONS_STARTED

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_DAEMONS_STARTED

NO_INTEGRATION_DAEMON_CLIENT

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_DAEMON_CLIENT

UNKNOWN_INTEGRATION_DAEMON_CONFIG

public static final IntegrationDaemonServicesErrorCode UNKNOWN_INTEGRATION_DAEMON_CONFIG

UNKNOWN_INTEGRATION_SERVICE

public static final IntegrationDaemonServicesErrorCode UNKNOWN_INTEGRATION_SERVICE

UNKNOWN_CONNECTOR_NAME

public static final IntegrationDaemonServicesErrorCode UNKNOWN_CONNECTOR_NAME

UNKNOWN_GOVERNANCE_ENGINE_CONFIG

public static final IntegrationDaemonServicesErrorCode UNKNOWN_GOVERNANCE_ENGINE_CONFIG

INTEGRATION_GROUP_NOT_INITIALIZED

public static final IntegrationDaemonServicesErrorCode INTEGRATION_GROUP_NOT_INITIALIZED

UNKNOWN_GROUP_NAME

public static final IntegrationDaemonServicesErrorCode UNKNOWN_GROUP_NAME

NO_INTEGRATION_GROUPS

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_GROUPS

NO_INTEGRATION_SERVICES

public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_SERVICES

NULL_CONTEXT_MANAGER

public static final IntegrationDaemonServicesErrorCode NULL_CONTEXT_MANAGER

Method Details

values

public static IntegrationDaemonServicesErrorCode[] 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 IntegrationDaemonServicesErrorCode 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 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()

JSON-style toString

Overrides:

toString in class Enum<IntegrationDaemonServicesErrorCode>

Returns:

string of property names and values for this enum