Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.ffdc

Enum Class XTDBErrorCode

java.lang.Object
java.lang.Enum<XTDBErrorCode>
org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.ffdc.XTDBErrorCode
All Implemented Interfaces:
Serializable, Comparable<XTDBErrorCode>, Constable, ExceptionMessageSet
public enum XTDBErrorCode extends Enum<XTDBErrorCode> implements ExceptionMessageSet
The XTDBErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with XTDB as an OMRS Metadata Repository. It is used in conjunction with both Checked and Runtime (unchecked) 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
    • 400 - invalid parameters
    • 404 - not found
  • 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 AssetConsumerInterface 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
    BAD_CATEGORY_FOR_TYPEDEF_ATTRIBUTE
    OMRS-XTDB-REPOSITORY-500-005 Requested type {0} with an incompatible category of {1} from the type definition cache
    BAD_INSTANCE_STATUS
    OMRS-XTDB-REPOSITORY-400-017 An instance status of {0} has been passed but this status is not valid for an instance of type {1}
    BAD_PROPERTY_FOR_TYPE
    OMRS-XTDB-REPOSITORY-400-018 A property called {0} has been proposed for a new metadata instance of category {1} and type {2}; it is not supported for this type
    BAD_PROPERTY_TYPE
    OMRS-XTDB-REPOSITORY-400-020 A property called {0} of type {1} has been proposed for a new metadata instance of category {2} and type {3}; this property should be of type {4}
    CANNOT_CLOSE_RESOURCE
    OMRS-XTDB-REPOSITORY-500-002 Unable to close an open XTDB resource
    CANNOT_READ_CONFIGURATION
    OMRS-XTDB-REPOSITORY-400-005 Investigate the logs for additional information, and correct the configurationProperties sent to the connector.
    CLASSIFICATION_HOME_COLLECTION_REFERENCE
    OMRS-XTDB-REPOSITORY-400-025 Attempt to save classification on entity with GUID {0} as a reference copy in its home collection in repository {1}
    DUPLICATE_PROPERTIES
    OMRS-XTDB-REPOSITORY-500-004 Found more than one property in the type {0} with the name: {1}
    ENTITY_HOME_COLLECTION_REFERENCE
    OMRS-XTDB-REPOSITORY-400-001 Attempt to save entity with GUID {0} as a reference copy in its home collection in repository {1}
    ENTITY_NOT_CLASSIFIED
    OMRS-XTDB-REPOSITORY-400-012 A request has been made to modify a non-existent classification {0} on entity {1}
    ENTITY_NOT_KNOWN
    OMRS-XTDB-REPOSITORY-404-001 The repository does not contain any entity with the GUID {0}
    ENTITY_PROXY_ONLY
    OMRS-XTDB-REPOSITORY-400-003 The attempt to retrieve an entity with GUID {0} found only an entity proxy in repository {1}
    FAILED_DISCONNECT
    OMRS-XTDB-REPOSITORY-500-002 The XTDB connector failed to disconnect
    INACTIVE_INSTANCE_TYPE
    OMRS-METADATA-COLLECTION-500-007 Retrieved instance (guid={0}) has an inactive type called {1} (type guid = {2})
    INSTANCE_ALREADY_DELETED
    OMRS-XTDB-REPOSITORY-400-008 A request has been made to delete an instance {0} that is already deleted
    INSTANCE_HOME_NOT_LOCAL
    OMRS-XTDB-METADATA-COLLECTION-500-006 The home metadata collection identifier {0} found for instance with GUID {1} is not the metadata collection identifier {2} for the local metadata repository
    INSTANCE_NOT_DELETED
    OMRS-XTDB-REPOSITORY-400-009 - A request has been made to purge an instance {0} that is not deleted
    INVALID_CLASSIFICATION_FOR_ENTITY
    OMRS-XTDB-REPOSITORY-400-004 Open metadata repository is unable to assign a classification of type {0} to an entity of type {1} as the classification type is not valid for this type of entity
    INVALID_ENTITY_FROM_STORE
    OMRS-XTDB-REPOSITORY-400-013 The entity {0} retrieved from the repository has invalid contents: {1}
    INVALID_INSTANCE_FROM_STORE
    The instance {0} retrieved from the repository has invalid contents ({1}): {2}
    INVALID_RELATIONSHIP_ENDS
    OMRS-XTDB-REPOSITORY-400-015 A request has been made for a relationship that has one or more ends of the wrong or invalid type.
    INVALID_TYPEDEF
    OMRS-XTDB-REPOSITORY-400-011 A request has been made to persist a type definition {0} that has invalid contents
    METADATA_COLLECTION_CONFLICT
    OMRS-XTDB-REPOSITORY-400-002 There is an already an instance with GUID {0} from a different metadata collection, cannot create instance with same GUID in repository {1}
    NO_PROPERTIES_FOR_TYPE
    OMRS-XTDB-REPOSITORY-400-019 Properties have been proposed for a new metadata instance of category {0} and type {1}; properties not supported for this type
    NULL_PROPERTY_NAME_FOR_INSTANCE
    OMRS-XTDB-REPOSITORY-400-021 A null property name has been passed on a request to the open metadata repository
    NULL_PROPERTY_TYPE_FOR_INSTANCE
    OMRS-XTDB-REPOSITORY-400-023 A null property type for property {0} has been passed on a request to the open metadata repository
    NULL_PROPERTY_VALUE_FOR_INSTANCE
    OMRS-XTDB-REPOSITORY-400-022 A null property value for property {0} has been passed on a request to the open metadata repository
    NULL_REQUIRED_PROPERTY
    OMRS-XTDB-REPOSITORY-400-007 A null value has been passed for the required {0} property for instance {1}
    PERSISTENCE_LAYER_MISMATCH
    OMRS-XTDB-REPOSITORY-500-003 The XTDB connector detected a different version of the persistence layer ({0}) than is supported by this release ({1})
    QUERY_TIMEOUT
    OMRS-XTDB-REPOSITORY-400-006 The requested query against the XTDB repository at {0} timed out
    REGEX_NOT_IMPLEMENTED
    OMRS-XTDB-REPOSITORY-501-001 Repository {0} is not able to support the regular expression "{1}"
    RELATIONSHIP_HOME_COLLECTION_REFERENCE
    OMRS-XTDB-REPOSITORY-400-024 Attempt to save relationship with GUID {0} as a reference copy in its home collection in repository {1}
    RELATIONSHIP_NOT_KNOWN
    OMRS-XTDB-REPOSITORY-404-002 The repository does not contain any relationship with the GUID {0}
    TYPEDEF_NOT_KNOWN_FOR_INSTANCE
    OMRS-XTDB-REPOSITORY-404-003 The TypeDef {0} of category {1} is not known to the open metadata repository
    UNKNOWN_ENUMERATED_VALUE
    OMRS-XTDB-REPOSITORY-400-016 A request has been made for an enumerated value {0} for {1} that is not recognized
    UNKNOWN_RUNTIME_ERROR
    OMRS-XTDB-REPOSITORY-500-001 An unknown runtime error occurred, and the system is unable to proceed with its processing
    UNMAPPABLE_PROPERTY
    OMRS-XTDB-REPOSITORY-400-010 A request has been made to persist a property {0} that cannot be persisted

  • 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 XTDBErrorCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static XTDBErrorCode[]
    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

    • ENTITY_HOME_COLLECTION_REFERENCE

      public static final XTDBErrorCode ENTITY_HOME_COLLECTION_REFERENCE
      OMRS-XTDB-REPOSITORY-400-001 Attempt to save entity with GUID {0} as a reference copy in its home collection in repository {1}

    • METADATA_COLLECTION_CONFLICT

      public static final XTDBErrorCode METADATA_COLLECTION_CONFLICT
      OMRS-XTDB-REPOSITORY-400-002 There is an already an instance with GUID {0} from a different metadata collection, cannot create instance with same GUID in repository {1}

    • ENTITY_PROXY_ONLY

      public static final XTDBErrorCode ENTITY_PROXY_ONLY
      OMRS-XTDB-REPOSITORY-400-003 The attempt to retrieve an entity with GUID {0} found only an entity proxy in repository {1}

    • INVALID_CLASSIFICATION_FOR_ENTITY

      public static final XTDBErrorCode INVALID_CLASSIFICATION_FOR_ENTITY
      OMRS-XTDB-REPOSITORY-400-004 Open metadata repository is unable to assign a classification of type {0} to an entity of type {1} as the classification type is not valid for this type of entity

    • CANNOT_READ_CONFIGURATION

      public static final XTDBErrorCode CANNOT_READ_CONFIGURATION
      OMRS-XTDB-REPOSITORY-400-005 Investigate the logs for additional information, and correct the configurationProperties sent to the connector.

    • QUERY_TIMEOUT

      public static final XTDBErrorCode QUERY_TIMEOUT
      OMRS-XTDB-REPOSITORY-400-006 The requested query against the XTDB repository at {0} timed out

    • NULL_REQUIRED_PROPERTY

      public static final XTDBErrorCode NULL_REQUIRED_PROPERTY
      OMRS-XTDB-REPOSITORY-400-007 A null value has been passed for the required {0} property for instance {1}

    • INSTANCE_ALREADY_DELETED

      public static final XTDBErrorCode INSTANCE_ALREADY_DELETED
      OMRS-XTDB-REPOSITORY-400-008 A request has been made to delete an instance {0} that is already deleted

    • INSTANCE_NOT_DELETED

      public static final XTDBErrorCode INSTANCE_NOT_DELETED
      OMRS-XTDB-REPOSITORY-400-009 - A request has been made to purge an instance {0} that is not deleted

    • UNMAPPABLE_PROPERTY

      public static final XTDBErrorCode UNMAPPABLE_PROPERTY
      OMRS-XTDB-REPOSITORY-400-010 A request has been made to persist a property {0} that cannot be persisted

    • INVALID_TYPEDEF

      public static final XTDBErrorCode INVALID_TYPEDEF
      OMRS-XTDB-REPOSITORY-400-011 A request has been made to persist a type definition {0} that has invalid contents

    • ENTITY_NOT_CLASSIFIED

      public static final XTDBErrorCode ENTITY_NOT_CLASSIFIED
      OMRS-XTDB-REPOSITORY-400-012 A request has been made to modify a non-existent classification {0} on entity {1}

    • INVALID_ENTITY_FROM_STORE

      public static final XTDBErrorCode INVALID_ENTITY_FROM_STORE
      OMRS-XTDB-REPOSITORY-400-013 The entity {0} retrieved from the repository has invalid contents: {1}

    • INVALID_INSTANCE_FROM_STORE

      public static final XTDBErrorCode INVALID_INSTANCE_FROM_STORE
      The instance {0} retrieved from the repository has invalid contents ({1}): {2}

    • INVALID_RELATIONSHIP_ENDS

      public static final XTDBErrorCode INVALID_RELATIONSHIP_ENDS
      OMRS-XTDB-REPOSITORY-400-015 A request has been made for a relationship that has one or more ends of the wrong or invalid type. Relationship type is {0}; entity proxy {1} for end 1 is of type {2} rather than {3} and entity proxy {4} for end 2 is of type {5} rather than {6}

    • UNKNOWN_ENUMERATED_VALUE

      public static final XTDBErrorCode UNKNOWN_ENUMERATED_VALUE
      OMRS-XTDB-REPOSITORY-400-016 A request has been made for an enumerated value {0} for {1} that is not recognized

    • BAD_INSTANCE_STATUS

      public static final XTDBErrorCode BAD_INSTANCE_STATUS
      OMRS-XTDB-REPOSITORY-400-017 An instance status of {0} has been passed but this status is not valid for an instance of type {1}

    • BAD_PROPERTY_FOR_TYPE

      public static final XTDBErrorCode BAD_PROPERTY_FOR_TYPE
      OMRS-XTDB-REPOSITORY-400-018 A property called {0} has been proposed for a new metadata instance of category {1} and type {2}; it is not supported for this type

    • NO_PROPERTIES_FOR_TYPE

      public static final XTDBErrorCode NO_PROPERTIES_FOR_TYPE
      OMRS-XTDB-REPOSITORY-400-019 Properties have been proposed for a new metadata instance of category {0} and type {1}; properties not supported for this type

    • BAD_PROPERTY_TYPE

      public static final XTDBErrorCode BAD_PROPERTY_TYPE
      OMRS-XTDB-REPOSITORY-400-020 A property called {0} of type {1} has been proposed for a new metadata instance of category {2} and type {3}; this property should be of type {4}

    • NULL_PROPERTY_NAME_FOR_INSTANCE

      public static final XTDBErrorCode NULL_PROPERTY_NAME_FOR_INSTANCE
      OMRS-XTDB-REPOSITORY-400-021 A null property name has been passed on a request to the open metadata repository

    • NULL_PROPERTY_VALUE_FOR_INSTANCE

      public static final XTDBErrorCode NULL_PROPERTY_VALUE_FOR_INSTANCE
      OMRS-XTDB-REPOSITORY-400-022 A null property value for property {0} has been passed on a request to the open metadata repository

    • NULL_PROPERTY_TYPE_FOR_INSTANCE

      public static final XTDBErrorCode NULL_PROPERTY_TYPE_FOR_INSTANCE
      OMRS-XTDB-REPOSITORY-400-023 A null property type for property {0} has been passed on a request to the open metadata repository

    • RELATIONSHIP_HOME_COLLECTION_REFERENCE

      public static final XTDBErrorCode RELATIONSHIP_HOME_COLLECTION_REFERENCE
      OMRS-XTDB-REPOSITORY-400-024 Attempt to save relationship with GUID {0} as a reference copy in its home collection in repository {1}

    • CLASSIFICATION_HOME_COLLECTION_REFERENCE

      public static final XTDBErrorCode CLASSIFICATION_HOME_COLLECTION_REFERENCE
      OMRS-XTDB-REPOSITORY-400-025 Attempt to save classification on entity with GUID {0} as a reference copy in its home collection in repository {1}

    • ENTITY_NOT_KNOWN

      public static final XTDBErrorCode ENTITY_NOT_KNOWN
      OMRS-XTDB-REPOSITORY-404-001 The repository does not contain any entity with the GUID {0}

    • RELATIONSHIP_NOT_KNOWN

      public static final XTDBErrorCode RELATIONSHIP_NOT_KNOWN
      OMRS-XTDB-REPOSITORY-404-002 The repository does not contain any relationship with the GUID {0}

    • TYPEDEF_NOT_KNOWN_FOR_INSTANCE

      public static final XTDBErrorCode TYPEDEF_NOT_KNOWN_FOR_INSTANCE
      OMRS-XTDB-REPOSITORY-404-003 The TypeDef {0} of category {1} is not known to the open metadata repository

    • UNKNOWN_RUNTIME_ERROR

      public static final XTDBErrorCode UNKNOWN_RUNTIME_ERROR
      OMRS-XTDB-REPOSITORY-500-001 An unknown runtime error occurred, and the system is unable to proceed with its processing

    • CANNOT_CLOSE_RESOURCE

      public static final XTDBErrorCode CANNOT_CLOSE_RESOURCE
      OMRS-XTDB-REPOSITORY-500-002 Unable to close an open XTDB resource

    • FAILED_DISCONNECT

      public static final XTDBErrorCode FAILED_DISCONNECT
      OMRS-XTDB-REPOSITORY-500-002 The XTDB connector failed to disconnect

    • PERSISTENCE_LAYER_MISMATCH

      public static final XTDBErrorCode PERSISTENCE_LAYER_MISMATCH
      OMRS-XTDB-REPOSITORY-500-003 The XTDB connector detected a different version of the persistence layer ({0}) than is supported by this release ({1})

    • DUPLICATE_PROPERTIES

      public static final XTDBErrorCode DUPLICATE_PROPERTIES
      OMRS-XTDB-REPOSITORY-500-004 Found more than one property in the type {0} with the name: {1}

    • BAD_CATEGORY_FOR_TYPEDEF_ATTRIBUTE

      public static final XTDBErrorCode BAD_CATEGORY_FOR_TYPEDEF_ATTRIBUTE
      OMRS-XTDB-REPOSITORY-500-005 Requested type {0} with an incompatible category of {1} from the type definition cache

    • INSTANCE_HOME_NOT_LOCAL

      public static final XTDBErrorCode INSTANCE_HOME_NOT_LOCAL
      OMRS-XTDB-METADATA-COLLECTION-500-006 The home metadata collection identifier {0} found for instance with GUID {1} is not the metadata collection identifier {2} for the local metadata repository

    • INACTIVE_INSTANCE_TYPE

      public static final XTDBErrorCode INACTIVE_INSTANCE_TYPE
      OMRS-METADATA-COLLECTION-500-007 Retrieved instance (guid={0}) has an inactive type called {1} (type guid = {2})

    • REGEX_NOT_IMPLEMENTED

      public static final XTDBErrorCode REGEX_NOT_IMPLEMENTED
      OMRS-XTDB-REPOSITORY-501-001 Repository {0} is not able to support the regular expression "{1}"

  • Method Details

    • values

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