Package org.odpi.openmetadata.commonservices.ffdc

Enum Class OMAGCommonAuditCode

java.lang.Object
java.lang.Enum<OMAGCommonAuditCode>
org.odpi.openmetadata.commonservices.ffdc.OMAGCommonAuditCode
All Implemented Interfaces:
Serializable, Comparable<OMAGCommonAuditCode>, Constable, AuditLogMessageSet
public enum OMAGCommonAuditCode extends Enum<OMAGCommonAuditCode> implements AuditLogMessageSet
The OMAGCommonAuditCode 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 OMAGCommonAuditCode UNEXPECTED_EXCEPTION
      OMAG-COMMON-0001 - The Open Metadata Service has generated an unexpected {0} exception during method {1}. The message was: {2}

    • CLIENT_SIDE_REST_API_ERROR

      public static final OMAGCommonAuditCode CLIENT_SIDE_REST_API_ERROR
      OMAG-COMMON-0002 - A client-side exception was received from API call {0} to OMAG Server {1} at {2}. The error message was {3}

  • Method Details

    • values

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