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

Enum Class PepysAuditCode

java.lang.Object
java.lang.Enum<PepysAuditCode>
org.odpi.openmetadata.adapters.connectors.pepys.ffdc.PepysAuditCode
All Implemented Interfaces:
Serializable, Comparable<PepysAuditCode>, Constable, AuditLogMessageSet
public enum PepysAuditCode extends Enum<PepysAuditCode> implements AuditLogMessageSet
The PepysAuditCode is used to define the message content for the 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 for 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 PepysAuditCode UNEXPECTED_EXCEPTION
      PEPYS-ACTIVITY-OBSERVER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • STARTING_CONNECTOR

      public static final PepysAuditCode STARTING_CONNECTOR
      PEPYS-ACTIVITY-OBSERVER-0002 - The {0} integration connector is starting to record the usage activity of the anchor elements in server {1} on platform {2}; the activity of its own user {3} is ignored

    • LISTENING_TO_TOPIC

      public static final PepysAuditCode LISTENING_TO_TOPIC
      PEPYS-ACTIVITY-OBSERVER-0003 - The {0} integration connector is listening for audit log records on topic {1} (connection {2})

    • USAGE_ACTIVITY_RECORDED

      public static final PepysAuditCode USAGE_ACTIVITY_RECORDED
      PEPYS-ACTIVITY-OBSERVER-0004 - The {0} integration connector has added {1} observed activities to the usage activity counts of {2} elements

    • USAGE_ACTIVITY_DEFERRED

      public static final PepysAuditCode USAGE_ACTIVITY_DEFERRED
      PEPYS-ACTIVITY-OBSERVER-0005 - The {0} integration connector is unable to update the usage activity counts of element {1} because of exception {2} with message {3}; {4} observed activities will be retried on the next refresh

    • USAGE_ACTIVITY_DISCARDED

      public static final PepysAuditCode USAGE_ACTIVITY_DISCARDED
      PEPYS-ACTIVITY-OBSERVER-0006 - The {0} integration connector has discarded {1} observed activities for element {2} because it can not be updated: exception {3} with message {4}

  • Method Details

    • values

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