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, ExceptionMessageSet
public enum IntegrationDaemonServicesErrorCode extends Enum<IntegrationDaemonServicesErrorCode> implements 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-DAEMON-SERVICES-400-008 - The integration daemon services are unable to initialize a new instance of integration daemon {0}; error message is {1}
    INTEGRATION_GROUP_NOT_INITIALIZED
    INTEGRATION-DAEMON-SERVICES-400-033 - Integration daemon {0} is unable to process connectors from integration group {1} because it is unable to retrieve its configuration from the metadata access server
    INVALID_CONTEXT_MANAGER
    INTEGRATION-DAEMON-SERVICES-400-006 - The integration service {0} has been configured with a context manager class of {1} which can not be used by the class loader.
    NO_CONFIG_DOC
    INTEGRATION-DAEMON-SERVICES-400-001 - Integration daemon {0} has been passed a null configuration document section for the integration daemon services
    NO_INTEGRATION_CONNECTORS_CONFIGURED
    INTEGRATION-DAEMON-SERVICES-400-007 - Integration daemon {0} is not configured with any integration connectors
    NO_INTEGRATION_GROUPS
    INTEGRATION-DAEMON-SERVICES-400-035 - No integration groups are running in the integration daemon {0}
    NO_INTEGRATION_SERVICES
    INTEGRATION-DAEMON-SERVICES-500-001 - No integration services are running in the integration daemon
    NO_OMAS_SERVER_NAME
    INTEGRATION-DAEMON-SERVICES-400-004 - Integration service {0} is not configured with the name for the server running the {1}
    NO_OMAS_SERVER_URL
    INTEGRATION-DAEMON-SERVICES-400-003 - Integration service {0} is not configured with the platform URL root for the {1}
    NO_PERMITTED_SYNCHRONIZATION
    INTEGRATION-DAEMON-SERVICES-400-012 - The integration service {0} in integration daemon {1} does not have a default permitted synchronization value set
    NULL_CONTEXT_MANAGER
    INTEGRATION-DAEMON-SERVICES-500-002 - The integration service {0} has been registered with this platform with a null context manager class
    NULL_SERVICE_CONFIG_VALUE
    INTEGRATION-DAEMON-SERVICES-400-011 - The {0} configuration property for integration service {1} in integration daemon {2} is null
    SERVICE_INSTANCE_FAILURE
    INTEGRATION-DAEMON-SERVICES-400-009 - The integration daemon services are unable to initialize a new instance of integration daemon {0}; error message is {1}
    UNKNOWN_CONNECTOR_NAME
    INTEGRATION-DAEMON-SERVICES-400-031 - Integration connector named {0} is not running in the integration daemon {1}
    UNKNOWN_GROUP_NAME
    INTEGRATION-DAEMON-SERVICES-400-034 - Integration group named {0} is not running in the integration daemon {1}
    UNKNOWN_INTEGRATION_GROUP_CONFIG
    INTEGRATION-DAEMON-SERVICES-400-032 - Properties for integration group called {0} have not been returned by open metadata server {1} to the integration daemon services in server {2}
    UNKNOWN_INTEGRATION_SERVICE
    INTEGRATION-DAEMON-SERVICES-400-030 - Integration service with URL marker {0} is not registered in the integration daemon {1}
    UNRECOGNIZED_SERVICE
    INTEGRATION-DAEMON-SERVICES-400-010 - The integration service URL marker {0} is not recognized.

  • 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 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
      INTEGRATION-DAEMON-SERVICES-400-001 - Integration daemon {0} has been passed a null configuration document section for the integration daemon services

    • NO_OMAS_SERVER_URL

      public static final IntegrationDaemonServicesErrorCode NO_OMAS_SERVER_URL
      INTEGRATION-DAEMON-SERVICES-400-003 - Integration service {0} is not configured with the platform URL root for the {1}

    • NO_OMAS_SERVER_NAME

      public static final IntegrationDaemonServicesErrorCode NO_OMAS_SERVER_NAME
      INTEGRATION-DAEMON-SERVICES-400-004 - Integration service {0} is not configured with the name for the server running the {1}

    • INVALID_CONTEXT_MANAGER

      public static final IntegrationDaemonServicesErrorCode INVALID_CONTEXT_MANAGER
      INTEGRATION-DAEMON-SERVICES-400-006 - The integration service {0} has been configured with a context manager class of {1} which can not be used by the class loader. The {2} exception was returned with message {3}

    • NO_INTEGRATION_CONNECTORS_CONFIGURED

      public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_CONNECTORS_CONFIGURED
      INTEGRATION-DAEMON-SERVICES-400-007 - Integration daemon {0} is not configured with any integration connectors

    • INTEGRATION_DAEMON_INSTANCE_FAILURE

      public static final IntegrationDaemonServicesErrorCode INTEGRATION_DAEMON_INSTANCE_FAILURE
      INTEGRATION-DAEMON-SERVICES-400-008 - The integration daemon services are unable to initialize a new instance of integration daemon {0}; error message is {1}

    • SERVICE_INSTANCE_FAILURE

      public static final IntegrationDaemonServicesErrorCode SERVICE_INSTANCE_FAILURE
      INTEGRATION-DAEMON-SERVICES-400-009 - The integration daemon services are unable to initialize a new instance of integration daemon {0}; error message is {1}

    • UNRECOGNIZED_SERVICE

      public static final IntegrationDaemonServicesErrorCode UNRECOGNIZED_SERVICE
      INTEGRATION-DAEMON-SERVICES-400-010 - The integration service URL marker {0} is not recognized. Valid service URL markers are: {1}

    • NULL_SERVICE_CONFIG_VALUE

      public static final IntegrationDaemonServicesErrorCode NULL_SERVICE_CONFIG_VALUE
      INTEGRATION-DAEMON-SERVICES-400-011 - The {0} configuration property for integration service {1} in integration daemon {2} is null

    • NO_PERMITTED_SYNCHRONIZATION

      public static final IntegrationDaemonServicesErrorCode NO_PERMITTED_SYNCHRONIZATION
      INTEGRATION-DAEMON-SERVICES-400-012 - The integration service {0} in integration daemon {1} does not have a default permitted synchronization value set

    • UNKNOWN_INTEGRATION_SERVICE

      public static final IntegrationDaemonServicesErrorCode UNKNOWN_INTEGRATION_SERVICE
      INTEGRATION-DAEMON-SERVICES-400-030 - Integration service with URL marker {0} is not registered in the integration daemon {1}

    • UNKNOWN_CONNECTOR_NAME

      public static final IntegrationDaemonServicesErrorCode UNKNOWN_CONNECTOR_NAME
      INTEGRATION-DAEMON-SERVICES-400-031 - Integration connector named {0} is not running in the integration daemon {1}

    • UNKNOWN_INTEGRATION_GROUP_CONFIG

      public static final IntegrationDaemonServicesErrorCode UNKNOWN_INTEGRATION_GROUP_CONFIG
      INTEGRATION-DAEMON-SERVICES-400-032 - Properties for integration group called {0} have not been returned by open metadata server {1} to the integration daemon services in server {2}

    • INTEGRATION_GROUP_NOT_INITIALIZED

      public static final IntegrationDaemonServicesErrorCode INTEGRATION_GROUP_NOT_INITIALIZED
      INTEGRATION-DAEMON-SERVICES-400-033 - Integration daemon {0} is unable to process connectors from integration group {1} because it is unable to retrieve its configuration from the metadata access server

    • UNKNOWN_GROUP_NAME

      public static final IntegrationDaemonServicesErrorCode UNKNOWN_GROUP_NAME
      INTEGRATION-DAEMON-SERVICES-400-034 - Integration group named {0} is not running in the integration daemon {1}

    • NO_INTEGRATION_GROUPS

      public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_GROUPS
      INTEGRATION-DAEMON-SERVICES-400-035 - No integration groups are running in the integration daemon {0}

    • NO_INTEGRATION_SERVICES

      public static final IntegrationDaemonServicesErrorCode NO_INTEGRATION_SERVICES
      INTEGRATION-DAEMON-SERVICES-500-001 - No integration services are running in the integration daemon

    • NULL_CONTEXT_MANAGER

      public static final IntegrationDaemonServicesErrorCode NULL_CONTEXT_MANAGER
      INTEGRATION-DAEMON-SERVICES-500-002 - The integration service {0} has been registered with this platform with a null context manager class

  • 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 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<IntegrationDaemonServicesErrorCode>
      Returns:
      string of property names and values for this enum