Package org.odpi.openmetadata.engineservices.watchdogaction.ffdc

Enum Class WatchdogActionAuditCode

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

    • ENGINE_SERVICE_INITIALIZING

      public static final WatchdogActionAuditCode ENGINE_SERVICE_INITIALIZING
      OMES-WATCHDOG-ACTION-0001 - The Watchdog Action engine services are initializing in server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final WatchdogActionAuditCode SERVICE_INSTANCE_FAILURE
      OMES-WATCHDOG-ACTION-0012 - The Watchdog Action OMES is unable to initialize a new instance of itself in server {0}; error message is {1}

    • SERVER_SHUTTING_DOWN

      public static final WatchdogActionAuditCode SERVER_SHUTTING_DOWN
      OMES-WATCHDOG-ACTION-0014 - The Watchdog Action OMES in server {0} is shutting down

    • SERVER_SHUTDOWN

      public static final WatchdogActionAuditCode SERVER_SHUTDOWN
      OMES-WATCHDOG-ACTION-0016 - The Watchdog Action OMES in server {0} has completed shutdown

    • WATCHDOG_ACTION_SERVICE_STARTING

      public static final WatchdogActionAuditCode WATCHDOG_ACTION_SERVICE_STARTING
      OMES-WATCHDOG-ACTION-0017 - The watchdog action service {0} is starting to analyze asset {1} with request type {2} in watchdog action engine {3} (guid={4}); the results will be result in notifications/actions to subscribers of notification type {5}

    • WATCHDOG_ACTION_SERVICE_FAILED

      public static final WatchdogActionAuditCode WATCHDOG_ACTION_SERVICE_FAILED
      OMES-WATCHDOG-ACTION-0018 - The watchdog action service {0} threw a {1} exception during the notification/actioning of subscriber {2} for asset {3} during request type {4} in watchdog action engine {5} (guid={6}). The error message was {7}

    • WATCHDOG_ACTION_SERVICE_COMPLETE

      public static final WatchdogActionAuditCode WATCHDOG_ACTION_SERVICE_COMPLETE
      OMES-WATCHDOG-ACTION-0019 - The watchdog action service {0} has completed monitoring for notification type {1} with request type {2} in {3} milliseconds; the results are notified to subscribers {4}

    • WATCHDOG_ACTION_SERVICE_RETURNED

      public static final WatchdogActionAuditCode WATCHDOG_ACTION_SERVICE_RETURNED
      OMES-WATCHDOG-ACTION-0020 - The {0} governance action service {1} for request type {2} is continuing to run in a background thread

    • NO_WATCHDOG_ACTION_ENGINES_STARTED

      public static final WatchdogActionAuditCode NO_WATCHDOG_ACTION_ENGINES_STARTED
      OMES-WATCHDOG-ACTION-0021 - Watchdog Action OMES in server {0} is unable to start any watchdog action engines

    • EXC_ON_ERROR_STATUS_UPDATE

      public static final WatchdogActionAuditCode EXC_ON_ERROR_STATUS_UPDATE
      OMES-WATCHDOG-ACTION-0022 - Watchdog action engine {0} is unable to update the status for watchdog action service {1}. The exception was {2} with error message {3}

    • NULL_WATCHDOG_SERVICE

      public static final WatchdogActionAuditCode NULL_WATCHDOG_SERVICE
      OMES-WATCHDOG-ACTION-0023 - Method {0} can not execute in the watchdog action engine {1} hosted by Watchdog Action OMES in server {2} because the associated " + "watchdog action service properties are null

    • INVALID_WATCHDOG_ACTION_SERVICE

      public static final WatchdogActionAuditCode INVALID_WATCHDOG_ACTION_SERVICE
      OMES-WATCHDOG-ACTION-0029 - The watchdog action service {0} linked to request type {1} can not be started. The {2} exception was returned with message {3}

    • IGNORING_NOTIFICATION_TYPES

      public static final WatchdogActionAuditCode IGNORING_NOTIFICATION_TYPES
      OMES-WATCHDOG-ACTION-0030 - The watchdog action service {0} linked to request type {1} is processing asset {2} and ignoring the following asset action targets: {3}

    • UNEXPECTED_EXCEPTION

      public static final WatchdogActionAuditCode UNEXPECTED_EXCEPTION
      OMES-GOVERNANCE-ACTION-0033 - The Governance Action OMES has received an unexpected {0} exception during method {1}; the error message was: {2}

  • Method Details

    • values

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