Package org.odpi.openmetadata.engineservices.governanceaction.ffdc

Enum Class GovernanceActionAuditCode

java.lang.Object
java.lang.Enum<GovernanceActionAuditCode>
org.odpi.openmetadata.engineservices.governanceaction.ffdc.GovernanceActionAuditCode
All Implemented Interfaces:
Serializable, Comparable<GovernanceActionAuditCode>, Constable, AuditLogMessageSet
public enum GovernanceActionAuditCode extends Enum<GovernanceActionAuditCode> implements AuditLogMessageSet
The GovernanceActionAuditCode 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 GovernanceActionAuditCode ENGINE_SERVICE_INITIALIZING
      OMES-GOVERNANCE-ACTION-0001 - The Governance Action engine services are initializing in server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final GovernanceActionAuditCode SERVICE_INSTANCE_FAILURE
      OMES-GOVERNANCE-ACTION-0002 - The Governance Action OMES is unable to initialize a new instance of itself in server {0}; error message is {1}

    • SERVER_SHUTTING_DOWN

      public static final GovernanceActionAuditCode SERVER_SHUTTING_DOWN
      OMES-GOVERNANCE-ACTION-0014 - The Governance Action OMES in server {0} is shutting down

    • SERVER_SHUTDOWN

      public static final GovernanceActionAuditCode SERVER_SHUTDOWN
      OMES-GOVERNANCE-ACTION-0016 - The Governance Action OMES in server {0} has completed shutdown

    • GOVERNANCE_ACTION_SERVICE_STARTING

      public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_STARTING
      OMES-GOVERNANCE-ACTION-0017 - The {0} governance action service {1} is starting with request type {2} in governance action engine {3} (guid={4})

    • GOVERNANCE_ACTION_SERVICE_FAILED

      public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_FAILED
      OMES-GOVERNANCE-ACTION-0018 - The {0} governance action service {1} threw a {2} exception in governance action engine {3} (guid={4}). The error message was {5}

    • GOVERNANCE_ACTION_SERVICE_COMPLETE

      public static final GovernanceActionAuditCode GOVERNANCE_ACTION_SERVICE_COMPLETE
      OMES-GOVERNANCE-ACTION-0019 - The {0} governance action service {1} for request type {2} has completed with status {3} in {4} milliseconds

    • GOVERNANCE_ACTION_SERVICE_RETURNED

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

    • NO_GOVERNANCE_ACTION_ENGINES_STARTED

      public static final GovernanceActionAuditCode NO_GOVERNANCE_ACTION_ENGINES_STARTED
      OMES-GOVERNANCE-ACTION-0027 - Governance Action OMES in server {0} is unable to start any governance action engines

    • EXC_ON_ERROR_STATUS_UPDATE

      public static final GovernanceActionAuditCode EXC_ON_ERROR_STATUS_UPDATE
      OMES-GOVERNANCE-ACTION-0028 - Governance Action engine {0} is unable to update the completion status for governance action service {1}. The exception was {2} with error message {3}

    • INVALID_GOVERNANCE_ACTION_SERVICE

      public static final GovernanceActionAuditCode INVALID_GOVERNANCE_ACTION_SERVICE
      The governance action service {0} linked to request type {1} can not be started. The {2} exception was returned with message {3}

    • UNKNOWN_GOVERNANCE_ACTION_SERVICE

      public static final GovernanceActionAuditCode UNKNOWN_GOVERNANCE_ACTION_SERVICE
      OMES-GOVERNANCE-ACTION-0030 - The governance action service {0} linked to request type {1} can not be started because the Governance Action OMES does not support the {2} type of governance action service.

    • NOT_GOVERNANCE_ACTION_SERVICE

      public static final GovernanceActionAuditCode NOT_GOVERNANCE_ACTION_SERVICE
      OMES-GOVERNANCE-ACTION-0031 - The governance action service {0} linked to request type {1} can not be started because it is not a governance action service. Its class is {2} rather than a subclass of {3}

    • GOVERNANCE_ACTION_INITIALIZED

      public static final GovernanceActionAuditCode GOVERNANCE_ACTION_INITIALIZED
      OMES-GOVERNANCE-ACTION-0032 - {0} governance service ({1}) with request type {2} has initialized in governance engine {3}

    • UNEXPECTED_EXCEPTION

      public static final GovernanceActionAuditCode 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 GovernanceActionAuditCode[] 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 GovernanceActionAuditCode 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()
      toString() JSON-style
      Overrides:
      toString in class Enum<GovernanceActionAuditCode>
      Returns:
      string description