Package org.odpi.openmetadata.commonservices.multitenant.ffdc

Enum Class OMAGServerInstanceAuditCode

java.lang.Object
java.lang.Enum<OMAGServerInstanceAuditCode>
org.odpi.openmetadata.commonservices.multitenant.ffdc.OMAGServerInstanceAuditCode
All Implemented Interfaces:
Serializable, Comparable<OMAGServerInstanceAuditCode>, Constable, AuditLogMessageSet
public enum OMAGServerInstanceAuditCode extends Enum<OMAGServerInstanceAuditCode> implements AuditLogMessageSet
The OMAGServerInstanceAuditCode 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

    • BAD_TOPIC_CONNECTOR_PROVIDER

      public static final OMAGServerInstanceAuditCode BAD_TOPIC_CONNECTOR_PROVIDER
      OMAG-MULTI-TENANT-0001 - Method {0} called on behalf of the {1} service detected a {2} exception when creating an open metadata topic connection because the connector provider is incorrect. The error message was {3}

    • NO_TOPIC_INFORMATION

      public static final OMAGServerInstanceAuditCode NO_TOPIC_INFORMATION
      OMAG-MULTI-TENANT-0002 - Method {0} called on behalf of the {1} service is unable to create a client-side open metadata topic connection because the topic name is not configured in the configuration for this service.

    • USER_REQUEST_ACTIVITY

      public static final OMAGServerInstanceAuditCode USER_REQUEST_ACTIVITY
      OMAG-MULTI-TENANT-0003 - User {0} issued REST API call to operation {1} of service {2} on server {3}

  • Method Details

    • values

      public static OMAGServerInstanceAuditCode[] 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 OMAGServerInstanceAuditCode 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.