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

Enum Class ReportsAuditCode

java.lang.Object
java.lang.Enum<ReportsAuditCode>
org.odpi.openmetadata.adapters.connectors.reports.ffdc.ReportsAuditCode
All Implemented Interfaces:
Serializable, Comparable<ReportsAuditCode>, Constable, AuditLogMessageSet
public enum ReportsAuditCode extends Enum<ReportsAuditCode> implements AuditLogMessageSet
The ReportsAuditCode 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 ReportsAuditCode UNEXPECTED_EXCEPTION
      REPORT-GENERATORS-0001 - The Unity Catalog connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

    • REPORT_CREATED

      public static final ReportsAuditCode REPORT_CREATED
      REPORT-GENERATORS-0002 - The report generating service {0} created report {1}

  • Method Details

    • values

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