Package org.odpi.openmetadata.frameworks.integration.ffdc

Enum Class OIFAuditCode

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

    • FILE_MONITORING_STARTING

      public static final OIFAuditCode FILE_MONITORING_STARTING
      OIF-CONNECTOR-0001 - The {0} integration connector is initiating the monitoring of file {1}

    • DIRECTORY_MONITORING_STARTING

      public static final OIFAuditCode DIRECTORY_MONITORING_STARTING
      OIF-CONNECTOR-0002 - The {0} integration connector is initiating the monitoring of file directory {1}

    • UNEXPECTED_EXC_MONITOR_START

      public static final OIFAuditCode UNEXPECTED_EXC_MONITOR_START
      OIF-CONNECTOR-0003 - An unexpected {0} exception was returned to the {1} integration connector by the Apache Commons FileAlterationMonitor while it was starting the monitoring service. The error message was {2}

    • UNEXPECTED_EXC_MONITOR_STOP

      public static final OIFAuditCode UNEXPECTED_EXC_MONITOR_STOP
      OIF-CONNECTOR-0004 - An unexpected {0} exception was returned to the {1} integration connector by the Apache Commons FileAlterationMonitor while it stopping the monitoring service. The error message was {2}

    • FILE_SYSTEM_MONITORING_STOPPING

      public static final OIFAuditCode FILE_SYSTEM_MONITORING_STOPPING
      OIF-CONNECTOR-0005 - The {0} integration connector has stopped its file system monitoring and is shutting down

    • GET_CATALOG_TARGET_EXCEPTION

      public static final OIFAuditCode GET_CATALOG_TARGET_EXCEPTION
      OIF-CONNECTOR-0006 - An unexpected {0} exception was returned to the {1} integration connector while retrieving the action targets. The error message was {2}

    • NO_CATALOG_TARGETS

      public static final OIFAuditCode NO_CATALOG_TARGETS
      OIF-CONNECTOR-0007 - No action targets are defined for the {0} integration connector

    • REFRESHING_CATALOG_TARGET

      public static final OIFAuditCode REFRESHING_CATALOG_TARGET
      OIF-CONNECTOR-0008 - The {0} integration connector is refreshing action target {1}

    • REFRESHED_CATALOG_TARGETS

      public static final OIFAuditCode REFRESHED_CATALOG_TARGETS
      OIF-CONNECTOR-0009 - The {0} integration connector has refreshed {1} action target(s)

  • Method Details

    • values

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