Package org.odpi.openmetadata.viewservices.dino.api.ffdc

Enum Class DinoViewErrorCode

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

    • SERVICE_NOT_INITIALIZED

      public static final DinoViewErrorCode SERVICE_NOT_INITIALIZED

    • INVALID_CONFIG_PROPERTY

      public static final DinoViewErrorCode INVALID_CONFIG_PROPERTY

    • VIEW_SERVICE_NULL_PLATFORM_NAME

      public static final DinoViewErrorCode VIEW_SERVICE_NULL_PLATFORM_NAME

    • VIEW_SERVICE_NULL_SERVER_NAME

      public static final DinoViewErrorCode VIEW_SERVICE_NULL_SERVER_NAME

    • VIEW_SERVICE_UNKNOWN_SERVER_NAME

      public static final DinoViewErrorCode VIEW_SERVICE_UNKNOWN_SERVER_NAME

    • USER_NOT_AUTHORIZED

      public static final DinoViewErrorCode USER_NOT_AUTHORIZED

    • REPOSITORY_NOT_AVAILABLE

      public static final DinoViewErrorCode REPOSITORY_NOT_AVAILABLE

    • PLATFORM_NOT_AVAILABLE

      public static final DinoViewErrorCode PLATFORM_NOT_AVAILABLE

    • REPOSITORY_ERROR

      public static final DinoViewErrorCode REPOSITORY_ERROR

    • INVALID_PARAMETER

      public static final DinoViewErrorCode INVALID_PARAMETER

    • ENTITY_NOT_KNOWN_IN_REPOSITORY

      public static final DinoViewErrorCode ENTITY_NOT_KNOWN_IN_REPOSITORY

    • ENTITY_NOT_KNOWN_IN_ENTERPRISE

      public static final DinoViewErrorCode ENTITY_NOT_KNOWN_IN_ENTERPRISE

    • ENTITY_PROXY_ONLY

      public static final DinoViewErrorCode ENTITY_PROXY_ONLY

    • RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY

      public static final DinoViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY

    • RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE

      public static final DinoViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE

    • VIEW_SERVICE_REQUEST_BODY_MISSING

      public static final DinoViewErrorCode VIEW_SERVICE_REQUEST_BODY_MISSING

    • TYPE_ERROR

      public static final DinoViewErrorCode TYPE_ERROR

    • PROPERTY_ERROR

      public static final DinoViewErrorCode PROPERTY_ERROR

    • PAGING_ERROR

      public static final DinoViewErrorCode PAGING_ERROR

    • FUNCTION_NOT_SUPPORTED_ERROR

      public static final DinoViewErrorCode FUNCTION_NOT_SUPPORTED_ERROR

    • COULD_NOT_CREATE_HANDLER

      public static final DinoViewErrorCode COULD_NOT_CREATE_HANDLER

    • COULD_NOT_RETRIEVE_SERVER_CONFIGURATION

      public static final DinoViewErrorCode COULD_NOT_RETRIEVE_SERVER_CONFIGURATION

    • COULD_NOT_RETRIEVE_SERVICE_CONFIGURATION

      public static final DinoViewErrorCode COULD_NOT_RETRIEVE_SERVICE_CONFIGURATION

    • COULD_NOT_RETRIEVE_GOVERNANCE_ENGINE

      public static final DinoViewErrorCode COULD_NOT_RETRIEVE_GOVERNANCE_ENGINE

    • UNKNOWN_ERROR

      public static final DinoViewErrorCode UNKNOWN_ERROR

  • Method Details

    • values

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