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

Enum Class XTDBAuditCode

java.lang.Object
java.lang.Enum<XTDBAuditCode>
org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.ffdc.XTDBAuditCode
All Implemented Interfaces:
Serializable, Comparable<XTDBAuditCode>, Constable, AuditLogMessageSet
public enum XTDBAuditCode extends Enum<XTDBAuditCode> implements AuditLogMessageSet
The XTDBAuditCode is used to define the message content for the Audit Log. The 5 fields in the enum are:
  • Log Message Id - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • REPOSITORY_NODE_STARTING

      public static final XTDBAuditCode REPOSITORY_NODE_STARTING
      OMRS-XTDB-REPOSITORY-0001 - A request to start an XTDB repository node has been received

    • REPOSITORY_NODE_STARTING_WITH_CONFIG

      public static final XTDBAuditCode REPOSITORY_NODE_STARTING_WITH_CONFIG
      OMRS-XTDB-REPOSITORY-0002 - An XTDB repository node is starting with a persistent store

    • REPOSITORY_NODE_STARTING_NO_CONFIG

      public static final XTDBAuditCode REPOSITORY_NODE_STARTING_NO_CONFIG
      OMRS-XTDB-REPOSITORY-0003 - An XTDB repository node is starting in-memory (only)

    • REPOSITORY_SERVICE_STARTED

      public static final XTDBAuditCode REPOSITORY_SERVICE_STARTED
      OMRS-XTDB-REPOSITORY-0004 - An XTDB repository node has started, running XTDB version {0} with: {1}

    • REPOSITORY_SERVICE_SHUTDOWN

      public static final XTDBAuditCode REPOSITORY_SERVICE_SHUTDOWN
      OMRS-XTDB-REPOSITORY-0005 - The XTDB repository node has shutdown in server {0}

    • FAILED_RELATIONSHIP_DELETE_CASCADE

      public static final XTDBAuditCode FAILED_RELATIONSHIP_DELETE_CASCADE
      OMRS-XTDB-REPOSITORY-0006 - The XTDB repository failed to cascade deletions of all relationships for entity {0} due to {1}

    • FAILED_RELATIONSHIP_DELETE

      public static final XTDBAuditCode FAILED_RELATIONSHIP_DELETE
      OMRS-XTDB-REPOSITORY-0007 - The XTDB repository failed to cascade deletions of relationship {0} for entity {1} due to {2}

    • FAILED_REPOSITORY_STARTUP

      public static final XTDBAuditCode FAILED_REPOSITORY_STARTUP
      OMRS-XTDB-REPOSITORY-0008 - The XTDB repository node failed to start due to {0}

    • FAILED_REPOSITORY_SHUTDOWN

      public static final XTDBAuditCode FAILED_REPOSITORY_SHUTDOWN
      OMRS-XTDB-REPOSITORY-0009 - The XTDB repository node failed to shut down due to {0}

    • CANNOT_READ_CONFIGURATION

      public static final XTDBAuditCode CANNOT_READ_CONFIGURATION
      OMRS-XTDB-REPOSITORY-0010 - Unable to read the configuration for the XTDB repository node due to {0}

    • FAILED_RETRIEVAL

      public static final XTDBAuditCode FAILED_RETRIEVAL
      OMRS-XTDB-REPOSITORY-0011 - Unable to retrieve an instance of kind {0} with GUID {1}: {2}

    • UNMAPPED_TYPE

      public static final XTDBAuditCode UNMAPPED_TYPE
      OMRS-XTDB-REPOSITORY-0012 - The specified type {0} is not mapped in this repository

    • DUPLICATE_PROPERTIES

      public static final XTDBAuditCode DUPLICATE_PROPERTIES
      OMRS-XTDB-REPOSITORY-0013 - "Found more than one property in the instanceType {0} with the name {1}: {2}

    • UNMAPPED_MATCH_CRITERIA

      public static final XTDBAuditCode UNMAPPED_MATCH_CRITERIA
      OMRS-XTDB-REPOSITORY-0014 - The specified search criteria for matching is not mapped: {0}

    • UNKNOWN_COMPARISON_OPERATOR

      public static final XTDBAuditCode UNKNOWN_COMPARISON_OPERATOR
      OMRS-XTDB-REPOSITORY-0015 - The specified comparison operator is not mapped: {0}

    • INVALID_PROPERTY

      public static final XTDBAuditCode INVALID_PROPERTY
      OMRS-XTDB-REPOSITORY-0016 - A search was requested for property {0} which does not match any of the type restrictions: {1}

    • INVALID_STRING_COMPARISON

      public static final XTDBAuditCode INVALID_STRING_COMPARISON
      OMRS-XTDB-REPOSITORY-0017 - A search was requested for property {0} using an invalid comparison operator: {1}

    • SERIALIZATION_FAILURE

      public static final XTDBAuditCode SERIALIZATION_FAILURE
      OMRS-XTDB-REPOSITORY-0018 - Unable to serialize a value for {0} in type {1} due to: {2}

    • DESERIALIZATION_FAILURE

      public static final XTDBAuditCode DESERIALIZATION_FAILURE
      OMRS-XTDB-REPOSITORY-0019 - Unable to deserialize a value for {0} in type {1} into {2} due to: {3}

    • UNEXPECTED_RUNTIME_ERROR

      public static final XTDBAuditCode UNEXPECTED_RUNTIME_ERROR
      OMRS-XTDB-REPOSITORY-0020 - An unexpected runtime error occurred caused by {1}: {0}

    • MAPPING_FAILURE

      public static final XTDBAuditCode MAPPING_FAILURE
      OMRS-XTDB-REPOSITORY-0021 - Unable to map the retrieved {0} instance with XTDB reference {1} into an Egeria object: {2}

    • NON_EXISTENT_ENUM

      public static final XTDBAuditCode NON_EXISTENT_ENUM
      OMRS-XTDB-REPOSITORY-0022 - The requested {0} enumeration with ordinal or symbolic name {1} does not exist

    • UNMAPPED_PROPERTY

      public static final XTDBAuditCode UNMAPPED_PROPERTY
      OMRS-XTDB-REPOSITORY-0023 - Unable to map the property {0} as part of {1}

    • NON_INSTANCE_RETRIEVAL

      public static final XTDBAuditCode NON_INSTANCE_RETRIEVAL
      OMRS-XTDB-REPOSITORY-0024 - Unable to retrieve by GUID when the instance type has no GUID: {0}

    • NO_REGEX

      public static final XTDBAuditCode NO_REGEX
      OMRS-XTDB-REPOSITORY-0025 - A non-string value was provided for a regex search: {0}

    • NO_SORT_PROPERTY

      public static final XTDBAuditCode NO_SORT_PROPERTY
      OMRS-XTDB-REPOSITORY-0026 - Cannot sort by property {0} on types: {1}

  • Method Details

    • values

      public static XTDBAuditCode[] 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 XTDBAuditCode 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 AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      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<XTDBAuditCode>
      Returns:
      string of property names and values for this enum