Package org.odpi.openmetadata.adapters.connectors.postgres.ffdc

Enum Class PostgresAuditCode

java.lang.Object
java.lang.Enum<PostgresAuditCode>
org.odpi.openmetadata.adapters.connectors.postgres.ffdc.PostgresAuditCode
All Implemented Interfaces:
Serializable, Comparable<PostgresAuditCode>, Constable, AuditLogMessageSet
public enum PostgresAuditCode extends Enum<PostgresAuditCode> implements AuditLogMessageSet
The PostgresAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - 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

    • UNEXPECTED_EXCEPTION

      public static final PostgresAuditCode UNEXPECTED_EXCEPTION
      POSTGRES-CONNECTOR-0001 - The PostgreSQL connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • NO_DATABASES

      public static final PostgresAuditCode NO_DATABASES
      POSTGRES-CONNECTOR-0002 - The {0} survey action service is unable to retrieve details of any databases for PostgreSQL Database Server {1}

    • CATALOGED_DATABASE

      public static final PostgresAuditCode CATALOGED_DATABASE
      POSTGRES-CONNECTOR-0003 - The {0} integration connector has catalogued PostgreSQL Database {1} ({2})

    • SKIPPING_DATABASE

      public static final PostgresAuditCode SKIPPING_DATABASE
      POSTGRES-CONNECTOR-0004 - he {0} integration connector is skipping PostgreSQL Database {1} ({2}) because it is already catalogued

  • Method Details

    • values

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