All Implemented Interfaces:
Serializable, Comparable<ApacheAtlasAuditCode>, Constable, AuditLogMessageSet

public enum ApacheAtlasAuditCode extends Enum<ApacheAtlasAuditCode> implements AuditLogMessageSet
The ApacheAtlasAuditCode 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


      public static final ApacheAtlasAuditCode BAD_CONFIGURATION
      APACHE-ATLAS-REST-CONNECTOR-0005 - The {0} Apache Atlas REST Connector encountered an {1} exception when connecting to {2} during the {3} method. The exception message included was {4}

      public static final ApacheAtlasAuditCode UNEXPECTED_EXCEPTION
      APACHE-ATLAS-REST-CONNECTOR-0008 - The {0} Apache Atlas REST Connector received an unexpected exception {1} during method {2}; the error message was: {3}

      public static final ApacheAtlasAuditCode CONNECTOR_STOPPING
      APACHE-ATLAS-REST-CONNECTOR-0009 - The {0} Apache Atlas REST Connector has stopped its monitoring of Apache Atlas at {1} and is shutting down

      public static final ApacheAtlasAuditCode CLIENT_SIDE_REST_API_ERROR
      APACHE-ATLAS-REST-CONNECTOR-0031 - A client-side exception was received from API call {0} to server {1} at {2}. The error message was {3}
  • Method Details

    • values

      public static ApacheAtlasAuditCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ApacheAtlasAuditCode 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      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
      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
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      message definition object.
    • toString

      public String toString()
      JSON-style toString
      toString in class Enum<ApacheAtlasAuditCode>
      string of property names and values for this enum