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

Enum Class DB2LUWAuditCode

java.lang.Object
java.lang.Enum<DB2LUWAuditCode>
org.odpi.openmetadata.adapters.connectors.db2luw.ffdc.DB2LUWAuditCode
All Implemented Interfaces:
Serializable, Comparable<DB2LUWAuditCode>, Constable, AuditLogMessageSet
public enum DB2LUWAuditCode extends Enum<DB2LUWAuditCode> implements AuditLogMessageSet
The DB2LUWAuditCode 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 DB2LUWAuditCode UNEXPECTED_EXCEPTION
      DB2LUW-CONNECTOR-0001 - The Db2 for Linux, UNIX and Windows connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • NO_DATABASES

      public static final DB2LUWAuditCode NO_DATABASES
      DB2LUW-CONNECTOR-0002 - The {0} survey action service cannot retrieve details of any databases for Db2 for Linux, UNIX and Windows Server {1}

    • CATALOGED_DATABASE

      public static final DB2LUWAuditCode CATALOGED_DATABASE
      DB2LUW-CONNECTOR-0003 - The {0} integration connector has catalogued Db2 for Linux, UNIX and Windows Database {1} ({2})

    • SKIPPING_DATABASE

      public static final DB2LUWAuditCode SKIPPING_DATABASE
      DB2LUW-CONNECTOR-0004 - The {0} integration connector is skipping Db2 for Linux, UNIX and Windows Database {1} ({2}) because it is already catalogued

    • FRIENDSHIP_GUID

      public static final DB2LUWAuditCode FRIENDSHIP_GUID
      DB2LUW-CONNECTOR-0007 - The {0} Db2 for Linux, UNIX and Windows Connector has been supplied with a friendship connector with GUID {1}

    • NEW_CATALOG_TARGET

      public static final DB2LUWAuditCode NEW_CATALOG_TARGET
      DB2LUW-CONNECTOR-0009 - The {0} Connector has added a catalog target relationship {1} from friendship connector {2} to Db2 for Linux, UNIX and Windows Database Asset {3} for Database {4}

  • Method Details

    • values

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