Package org.odpi.openmetadata.accessservices.governanceengine.ffdc

Enum Class GovernanceEngineAuditCode

java.lang.Object
java.lang.Enum<GovernanceEngineAuditCode>
org.odpi.openmetadata.accessservices.governanceengine.ffdc.GovernanceEngineAuditCode
All Implemented Interfaces:
Serializable, Comparable<GovernanceEngineAuditCode>, Constable, AuditLogMessageSet
public enum GovernanceEngineAuditCode extends Enum<GovernanceEngineAuditCode> implements AuditLogMessageSet
The GovernanceEngineAuditLog is used to define the message content for the OMRS Audit Log.

The 5 fields in the enum are:

  • Log Message Id - 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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ASSET_AUDIT_LOG
    OMAS-GOVERNANCE-ENGINE-0021 - Log message for asset {0} from governance service {1}: {2}
    BAD_GOVERNANCE_ACTION
    OMAS-GOVERNANCE-ENGINE-0016 - The Governance Engine Open Metadata Access Service (OMAS) sent notification of a new engine action with no governance engine executor: {0}
    EVENT_PROCESSING_ERROR
    OMAS-GOVERNANCE-ENGINE-0007 - The Governance Engine Open Metadata Access Service (OMAS) encountered an unexpected {0} exception while processing event from {1} of type {2} for instance {3}.
    NEW_GOVERNANCE_ACTION
    OMAS-GOVERNANCE-ENGINE-0015 - The Governance Engine Open Metadata Access Service (OMAS) sent notification of a new governance action {0} for governance engine {1} ({2})
    OUT_TOPIC_EVENT
    OMAS-GOVERNANCE-ENGINE-0019 - The Governance Engine Open Metadata Access Service (OMAS) has sent event of type {0}
    OUT_TOPIC_FAILURE
    OMAS-GOVERNANCE-ENGINE-0018 - The Governance Engine Open Metadata Access Service (OMAS) is unable to send an event on its out topic {0}; exception {1} returned error message: {2}
    OUT_TOPIC_WATCHDOG_EVENT
    OMAS-GOVERNANCE-ENGINE-0020 - The Governance Engine Open Metadata Access Service (OMAS) has sent a watch dog event of type {0} for instance {1} of type {2}
    PUBLISHING_SHUTDOWN
    OMAS-GOVERNANCE-ENGINE-0010 - The Governance Engine Open Metadata Access Service (OMAS) is no longer publishing events to topic {0}
    PUBLISHING_SHUTDOWN_ERROR
    OMAS-GOVERNANCE-ENGINE-0011 - The Governance Engine Open Metadata Access Service (OMAS) caught an unexpected {0} exception whilst shutting down the out topic {1}.
    REFRESH_GOVERNANCE_ENGINE
    OMAS-GOVERNANCE-ENGINE-0013 - The Governance Engine Open Metadata Access Service (OMAS) sent notification that the configuration for governance engine {0} ({1}) has changed
    REFRESH_GOVERNANCE_SERVICE
    OMAS-GOVERNANCE-ENGINE-0014 - The Governance Engine Open Metadata Access Service (OMAS) sent notification that governance engine {0} ({1}) had a configuration change for governance request type {2} mapped to registered governance service {3}
    SERVICE_INITIALIZED
    OMAS-GOVERNANCE-ENGINE-0005 - The Governance Engine Open Metadata Access Service (OMAS) has initialized a new instance for server {0}
    SERVICE_INITIALIZING
    OMAS-GOVERNANCE-ENGINE-0001 - The Governance Engine Open Metadata Access Service (OMAS) is initializing a new server instance
    SERVICE_INSTANCE_FAILURE
    OMAS-GOVERNANCE-ENGINE-0006 - The Governance Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance; error message is {0}
    SERVICE_PUBLISHING
    OMAS-GOVERNANCE-ENGINE-0004 - The Governance Engine Open Metadata Access Service (OMAS) is ready to publish configuration refresh notifications to topic {0}
    SERVICE_REGISTERED_WITH_TOPIC
    OMAS-GOVERNANCE-ENGINE-0002 - The Governance Engine Open Metadata Access Service (OMAS) is registering a listener with the OMRS Topic for server instance {0}
    SERVICE_SHUTDOWN
    OMAS-GOVERNANCE-ENGINE-0012 - The Governance Engine Open Metadata Access Service (OMAS) is shutting down its instance for server {0}
    SERVICE_TERMINATING
    OMAS-GOVERNANCE-ENGINE-0009 - The Governance Engine Open Metadata Access Service (OMAS) is shutting down server instance {0}
    SKIPPING_INSTANCE
    OMAS-GOVERNANCE-ENGINE-0022 - The Governance Engine Open Metadata Access Service (OMAS) is ignoring event from {0} of type {1} for instance {2} because it does not have access to all the information for the instance.
    UNEXPECTED_INITIALIZATION_EXCEPTION
    OMAS-GOVERNANCE-ENGINE-0008 - The Governance Engine Open Metadata Access Service (OMAS) detected an unexpected {0} exception during the initialization of its services; error message is {1}
    WATCHDOG_EVENT
    OMAS-GOVERNANCE-ENGINE-0017 - The Governance Engine Open Metadata Access Service (OMAS) sent a metadata change event to listening Open Watchdog Governance Action Services: {0}

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static GovernanceEngineAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GovernanceEngineAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • SERVICE_INITIALIZING

      public static final GovernanceEngineAuditCode SERVICE_INITIALIZING
      OMAS-GOVERNANCE-ENGINE-0001 - The Governance Engine Open Metadata Access Service (OMAS) is initializing a new server instance

    • SERVICE_REGISTERED_WITH_TOPIC

      public static final GovernanceEngineAuditCode SERVICE_REGISTERED_WITH_TOPIC
      OMAS-GOVERNANCE-ENGINE-0002 - The Governance Engine Open Metadata Access Service (OMAS) is registering a listener with the OMRS Topic for server instance {0}

    • SERVICE_PUBLISHING

      public static final GovernanceEngineAuditCode SERVICE_PUBLISHING
      OMAS-GOVERNANCE-ENGINE-0004 - The Governance Engine Open Metadata Access Service (OMAS) is ready to publish configuration refresh notifications to topic {0}

    • SERVICE_INITIALIZED

      public static final GovernanceEngineAuditCode SERVICE_INITIALIZED
      OMAS-GOVERNANCE-ENGINE-0005 - The Governance Engine Open Metadata Access Service (OMAS) has initialized a new instance for server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final GovernanceEngineAuditCode SERVICE_INSTANCE_FAILURE
      OMAS-GOVERNANCE-ENGINE-0006 - The Governance Engine Open Metadata Access Service (OMAS) is unable to initialize a new instance; error message is {0}

    • EVENT_PROCESSING_ERROR

      public static final GovernanceEngineAuditCode EVENT_PROCESSING_ERROR
      OMAS-GOVERNANCE-ENGINE-0007 - The Governance Engine Open Metadata Access Service (OMAS) encountered an unexpected {0} exception while processing event from {1} of type {2} for instance {3}. Error message is: {4}

    • UNEXPECTED_INITIALIZATION_EXCEPTION

      public static final GovernanceEngineAuditCode UNEXPECTED_INITIALIZATION_EXCEPTION
      OMAS-GOVERNANCE-ENGINE-0008 - The Governance Engine Open Metadata Access Service (OMAS) detected an unexpected {0} exception during the initialization of its services; error message is {1}

    • SERVICE_TERMINATING

      public static final GovernanceEngineAuditCode SERVICE_TERMINATING
      OMAS-GOVERNANCE-ENGINE-0009 - The Governance Engine Open Metadata Access Service (OMAS) is shutting down server instance {0}

    • PUBLISHING_SHUTDOWN

      public static final GovernanceEngineAuditCode PUBLISHING_SHUTDOWN
      OMAS-GOVERNANCE-ENGINE-0010 - The Governance Engine Open Metadata Access Service (OMAS) is no longer publishing events to topic {0}

    • PUBLISHING_SHUTDOWN_ERROR

      public static final GovernanceEngineAuditCode PUBLISHING_SHUTDOWN_ERROR
      OMAS-GOVERNANCE-ENGINE-0011 - The Governance Engine Open Metadata Access Service (OMAS) caught an unexpected {0} exception whilst shutting down the out topic {1}. The error message was: {2}

    • SERVICE_SHUTDOWN

      public static final GovernanceEngineAuditCode SERVICE_SHUTDOWN
      OMAS-GOVERNANCE-ENGINE-0012 - The Governance Engine Open Metadata Access Service (OMAS) is shutting down its instance for server {0}

    • REFRESH_GOVERNANCE_ENGINE

      public static final GovernanceEngineAuditCode REFRESH_GOVERNANCE_ENGINE
      OMAS-GOVERNANCE-ENGINE-0013 - The Governance Engine Open Metadata Access Service (OMAS) sent notification that the configuration for governance engine {0} ({1}) has changed

    • REFRESH_GOVERNANCE_SERVICE

      public static final GovernanceEngineAuditCode REFRESH_GOVERNANCE_SERVICE
      OMAS-GOVERNANCE-ENGINE-0014 - The Governance Engine Open Metadata Access Service (OMAS) sent notification that governance engine {0} ({1}) had a configuration change for governance request type {2} mapped to registered governance service {3}

    • NEW_GOVERNANCE_ACTION

      public static final GovernanceEngineAuditCode NEW_GOVERNANCE_ACTION
      OMAS-GOVERNANCE-ENGINE-0015 - The Governance Engine Open Metadata Access Service (OMAS) sent notification of a new governance action {0} for governance engine {1} ({2})

    • BAD_GOVERNANCE_ACTION

      public static final GovernanceEngineAuditCode BAD_GOVERNANCE_ACTION
      OMAS-GOVERNANCE-ENGINE-0016 - The Governance Engine Open Metadata Access Service (OMAS) sent notification of a new engine action with no governance engine executor: {0}

    • WATCHDOG_EVENT

      public static final GovernanceEngineAuditCode WATCHDOG_EVENT
      OMAS-GOVERNANCE-ENGINE-0017 - The Governance Engine Open Metadata Access Service (OMAS) sent a metadata change event to listening Open Watchdog Governance Action Services: {0}

    • OUT_TOPIC_FAILURE

      public static final GovernanceEngineAuditCode OUT_TOPIC_FAILURE
      OMAS-GOVERNANCE-ENGINE-0018 - The Governance Engine Open Metadata Access Service (OMAS) is unable to send an event on its out topic {0}; exception {1} returned error message: {2}

    • OUT_TOPIC_EVENT

      public static final GovernanceEngineAuditCode OUT_TOPIC_EVENT
      OMAS-GOVERNANCE-ENGINE-0019 - The Governance Engine Open Metadata Access Service (OMAS) has sent event of type {0}

    • OUT_TOPIC_WATCHDOG_EVENT

      public static final GovernanceEngineAuditCode OUT_TOPIC_WATCHDOG_EVENT
      OMAS-GOVERNANCE-ENGINE-0020 - The Governance Engine Open Metadata Access Service (OMAS) has sent a watch dog event of type {0} for instance {1} of type {2}

    • ASSET_AUDIT_LOG

      public static final GovernanceEngineAuditCode ASSET_AUDIT_LOG
      OMAS-GOVERNANCE-ENGINE-0021 - Log message for asset {0} from governance service {1}: {2}

    • SKIPPING_INSTANCE

      public static final GovernanceEngineAuditCode SKIPPING_INSTANCE
      OMAS-GOVERNANCE-ENGINE-0022 - The Governance Engine Open Metadata Access Service (OMAS) is ignoring event from {0} of type {1} for instance {2} because it does not have access to all the information for the instance. Error message is: {3}

  • Method Details

    • values

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