Package org.odpi.openmetadata.adminservices.ffdc

Enum Class OMAGAdminErrorCode

java.lang.Object
java.lang.Enum<OMAGAdminErrorCode>
org.odpi.openmetadata.adminservices.ffdc.OMAGAdminErrorCode
All Implemented Interfaces:
Serializable, Comparable<OMAGAdminErrorCode>, Constable, ExceptionMessageSet
public enum OMAGAdminErrorCode extends Enum<OMAGAdminErrorCode> implements ExceptionMessageSet
The OMAGAdminErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMAG Server It is used in conjunction with OMAG 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
    • 501 - not implemented
    • 503 - Service not available
    • 400 - invalid parameters
    • 401 - unauthorized
    • 404 - not found
    • 405 - method not allowed
    • 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

  • Enum Constant Details

    • NULL_LOCAL_SERVER_NAME

      public static final OMAGAdminErrorCode NULL_LOCAL_SERVER_NAME

    • INCOMPATIBLE_SERVER_NAMES

      public static final OMAGAdminErrorCode INCOMPATIBLE_SERVER_NAMES

    • NULL_LOCAL_SERVER_USERID

      public static final OMAGAdminErrorCode NULL_LOCAL_SERVER_USERID

    • NULL_USER_NAME

      public static final OMAGAdminErrorCode NULL_USER_NAME

    • ACCESS_SERVICE_NOT_RECOGNIZED

      public static final OMAGAdminErrorCode ACCESS_SERVICE_NOT_RECOGNIZED

    • ACCESS_SERVICE_NOT_ENABLED

      public static final OMAGAdminErrorCode ACCESS_SERVICE_NOT_ENABLED

    • NULL_COHORT_NAME

      public static final OMAGAdminErrorCode NULL_COHORT_NAME

    • LOCAL_REPOSITORY_MODE_NOT_SET

      public static final OMAGAdminErrorCode LOCAL_REPOSITORY_MODE_NOT_SET

    • NULL_SERVER_CONFIG

      public static final OMAGAdminErrorCode NULL_SERVER_CONFIG

    • NULL_REPOSITORY_CONFIG

      public static final OMAGAdminErrorCode NULL_REPOSITORY_CONFIG

    • NULL_ACCESS_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_ADMIN_CLASS

    • BAD_ACCESS_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode BAD_ACCESS_SERVICE_ADMIN_CLASS

    • BAD_CONFIG_FILE

      public static final OMAGAdminErrorCode BAD_CONFIG_FILE

    • BAD_MAX_PAGE_SIZE

      public static final OMAGAdminErrorCode BAD_MAX_PAGE_SIZE

    • ENTERPRISE_TOPIC_START_FAILED

      public static final OMAGAdminErrorCode ENTERPRISE_TOPIC_START_FAILED

    • TOO_LATE_TO_SET_EVENT_BUS

      public static final OMAGAdminErrorCode TOO_LATE_TO_SET_EVENT_BUS

    • NO_EVENT_BUS_SET

      public static final OMAGAdminErrorCode NO_EVENT_BUS_SET

    • NULL_METADATA_COLLECTION_NAME

      public static final OMAGAdminErrorCode NULL_METADATA_COLLECTION_NAME

    • EMPTY_CONFIGURATION

      public static final OMAGAdminErrorCode EMPTY_CONFIGURATION

    • NULL_ACCESS_SERVICE_ROOT_URL

      public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_ROOT_URL

    • NULL_ACCESS_SERVICE_SERVER_NAME

      public static final OMAGAdminErrorCode NULL_ACCESS_SERVICE_SERVER_NAME

    • NULL_FILE_NAME

      public static final OMAGAdminErrorCode NULL_FILE_NAME

    • INCOMPATIBLE_CONFIG_FILE

      public static final OMAGAdminErrorCode INCOMPATIBLE_CONFIG_FILE

    • BAD_CONFIG_PROPERTIES

      public static final OMAGAdminErrorCode BAD_CONFIG_PROPERTIES

    • NO_ENTERPRISE_TOPIC

      public static final OMAGAdminErrorCode NO_ENTERPRISE_TOPIC

    • BAD_TOPIC_CONNECTOR

      public static final OMAGAdminErrorCode BAD_TOPIC_CONNECTOR

    • NULL_CONNECTION

      public static final OMAGAdminErrorCode NULL_CONNECTION

    • NULL_PLATFORM_CONNECTION

      public static final OMAGAdminErrorCode NULL_PLATFORM_CONNECTION

    • NULL_VIEW_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode NULL_VIEW_SERVICE_ADMIN_CLASS

    • BAD_VIEW_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode BAD_VIEW_SERVICE_ADMIN_CLASS

    • INCOMPATIBLE_SUBSYSTEMS

      public static final OMAGAdminErrorCode INCOMPATIBLE_SUBSYSTEMS

    • MISSING_CONFIGURATION_PROPERTY

      public static final OMAGAdminErrorCode MISSING_CONFIGURATION_PROPERTY

    • COHORT_NOT_KNOWN

      public static final OMAGAdminErrorCode COHORT_NOT_KNOWN

    • COHORT_TOPIC_STRANGE

      public static final OMAGAdminErrorCode COHORT_TOPIC_STRANGE

    • UNCLASSIFIABLE_SERVER

      public static final OMAGAdminErrorCode UNCLASSIFIABLE_SERVER

    • VIEW_SERVICE_NOT_RECOGNIZED

      public static final OMAGAdminErrorCode VIEW_SERVICE_NOT_RECOGNIZED

    • VIEW_SERVICE_NOT_ENABLED

      public static final OMAGAdminErrorCode VIEW_SERVICE_NOT_ENABLED

    • NULL_CLIENT_CONFIG

      public static final OMAGAdminErrorCode NULL_CLIENT_CONFIG

    • NULL_OMAG_SERVER_ROOT_URL

      public static final OMAGAdminErrorCode NULL_OMAG_SERVER_ROOT_URL

    • NULL_OMAG_SERVER_NAME

      public static final OMAGAdminErrorCode NULL_OMAG_SERVER_NAME

    • BAD_CONNECTION

      public static final OMAGAdminErrorCode BAD_CONNECTION

    • VIEW_SERVICE_CONFIG

      public static final OMAGAdminErrorCode VIEW_SERVICE_CONFIG

    • RETRIEVE_ALL_CONFIGS_NOT_SUPPORTED

      public static final OMAGAdminErrorCode RETRIEVE_ALL_CONFIGS_NOT_SUPPORTED

    • UNABLE_TO_OBTAIN_SERVER_CONFIG_STORE

      public static final OMAGAdminErrorCode UNABLE_TO_OBTAIN_SERVER_CONFIG_STORE

    • NULL_SERVICE_URL_MARKER

      public static final OMAGAdminErrorCode NULL_SERVICE_URL_MARKER

    • ENGINE_SERVICE_NOT_RECOGNIZED

      public static final OMAGAdminErrorCode ENGINE_SERVICE_NOT_RECOGNIZED

    • ENGINE_SERVICE_NOT_ENABLED

      public static final OMAGAdminErrorCode ENGINE_SERVICE_NOT_ENABLED

    • BAD_ENGINE_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode BAD_ENGINE_SERVICE_ADMIN_CLASS

    • NULL_ENGINE_SERVICE_ADMIN_CLASS

      public static final OMAGAdminErrorCode NULL_ENGINE_SERVICE_ADMIN_CLASS

    • OLD_CONFIGURATION

      public static final OMAGAdminErrorCode OLD_CONFIGURATION

    • VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW

      public static final OMAGAdminErrorCode VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW

    • LOCAL_REPOSITORY_MODE_NOT_PROXY

      public static final OMAGAdminErrorCode LOCAL_REPOSITORY_MODE_NOT_PROXY

    • NO_CONFIG_DOC

      public static final OMAGAdminErrorCode NO_CONFIG_DOC

    • NULL_PROPERTY_NAME

      public static final OMAGAdminErrorCode NULL_PROPERTY_NAME

    • AUDIT_LOG_DESTINATION_NOT_FOUND

      public static final OMAGAdminErrorCode AUDIT_LOG_DESTINATION_NOT_FOUND

    • UNEXPECTED_EXCEPTION

      public static final OMAGAdminErrorCode UNEXPECTED_EXCEPTION

    • UNEXPECTED_PLATFORM_EXCEPTION

      public static final OMAGAdminErrorCode UNEXPECTED_PLATFORM_EXCEPTION

    • BAD_TOPIC_CONNECTOR_PROVIDER

      public static final OMAGAdminErrorCode BAD_TOPIC_CONNECTOR_PROVIDER

    • UNEXPECTED_INITIALIZATION_EXCEPTION

      public static final OMAGAdminErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION

    • CLIENT_SIDE_REST_API_ERROR

      public static final OMAGAdminErrorCode CLIENT_SIDE_REST_API_ERROR

  • Method Details

    • values

      public static OMAGAdminErrorCode[] 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 OMAGAdminErrorCode 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<OMAGAdminErrorCode>
      Returns:
      string of property names and values for this enum