Package org.odpi.openmetadata.governanceservers.enginehostservices.ffdc

Enum Class EngineHostServicesAuditCode

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

    • SERVER_INITIALIZING

      public static final EngineHostServicesAuditCode SERVER_INITIALIZING
      ENGINE-HOST-SERVICES-0001 - The engine host services are initializing in server {0}

    • SERVER_INITIALIZED

      public static final EngineHostServicesAuditCode SERVER_INITIALIZED
      ENGINE-HOST-SERVICES-0002 - The engine host {0} has initialized

    • SERVICE_INSTANCE_FAILURE

      public static final EngineHostServicesAuditCode SERVICE_INSTANCE_FAILURE
      ENGINE-HOST-SERVICES-0003 - The engine host services are unable to initialize a new instance of engine host {0}; exception {1} with message {2}

    • NULL_ENGINE_SERVICE_ADMIN_CLASS

      public static final EngineHostServicesAuditCode NULL_ENGINE_SERVICE_ADMIN_CLASS
      ENGINE-HOST-SERVICES-0010 - The engine service {0} has been configured with a null admin class in engine host {1}

    • BAD_ENGINE_SERVICE_ADMIN_CLASS

      public static final EngineHostServicesAuditCode BAD_ENGINE_SERVICE_ADMIN_CLASS
      ENGINE-HOST-SERVICES-0011 - The engine service {0} has been configured with an admin class of {1} which can not be used by the class loader. The {2} exception was returned with message {3}

    • STARTING_ENGINE_SERVICES

      public static final EngineHostServicesAuditCode STARTING_ENGINE_SERVICES
      ENGINE-HOST-SERVICES-0012 - The Open Metadata Engine Services (OMESs) are initializing in server {0}

    • ALL_ENGINE_SERVICES_STARTED

      public static final EngineHostServicesAuditCode ALL_ENGINE_SERVICES_STARTED
      ENGINE-HOST-SERVICES-0014 - {0} out of {1} Open Metadata Engine Services (OMESs) in engine host server {2} have initialized

    • ENGINE_SHUTDOWN

      public static final EngineHostServicesAuditCode ENGINE_SHUTDOWN
      ENGINE-HOST-SERVICES-0015 - The governance engine {0} in server {1} is shutting down

    • SKIPPING_ENGINE_SERVICE

      public static final EngineHostServicesAuditCode SKIPPING_ENGINE_SERVICE
      ENGINE-HOST-SERVICES-0016 - The {0} engine service is disabled and will not be started

    • SERVER_SHUTTING_DOWN

      public static final EngineHostServicesAuditCode SERVER_SHUTTING_DOWN
      ENGINE-HOST-SERVICES-0017 - The engine host {0} is shutting down

    • SERVER_SHUTDOWN

      public static final EngineHostServicesAuditCode SERVER_SHUTDOWN
      ENGINE-HOST-SERVICES-0018 - The engine host {0} has completed shut down

    • SERVER_NOT_AUTHORIZED

      public static final EngineHostServicesAuditCode SERVER_NOT_AUTHORIZED
      ENGINE-HOST-SERVICES-0019 - Engine host server {0} is not authorized to call the Governance Engine OMAS running in server {1} on OMAG Server Platform {2} with userId {3}. The error message was: {4}

    • ENGINE_SERVICE_INSTANCE_FAILURE

      public static final EngineHostServicesAuditCode ENGINE_SERVICE_INSTANCE_FAILURE
      ENGINE-HOST-SERVICES-0020 - Engine host server {0} failed to start. The exception was {1} with message: {2}

    • SUPPORTED_REQUEST_TYPE

      public static final EngineHostServicesAuditCode SUPPORTED_REQUEST_TYPE
      ENGINE-HOST-SERVICES-0021 - Governance engine {0} in engine host server {1} is configured to process governance requests of type {2}

    • NO_CONFIGURATION_LISTENER

      public static final EngineHostServicesAuditCode NO_CONFIGURATION_LISTENER
      ENGINE-HOST-SERVICES-0026 - The engine host services are unable to retrieve the connection for the configuration listener for server {0} from metadata server {1}. Exception returned was {2} with error message {3}

    • CONFIGURATION_LISTENER_REGISTERED

      public static final EngineHostServicesAuditCode CONFIGURATION_LISTENER_REGISTERED
      ENGINE-HOST-SERVICES-0027 - The engine host services has registered the configuration listener for server {0} and governance engine {1}. It will receive configuration updates from metadata access server {2}

    • CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG

      public static final EngineHostServicesAuditCode CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG
      ENGINE-HOST-SERVICES-0028 - All governance service configuration is being refreshed for governance engine {0}

    • FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG

      public static final EngineHostServicesAuditCode FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG
      ENGINE-HOST-SERVICES-0029 - Refreshing all governance service configuration has being completed for governance engine {0}

    • GOVERNANCE_SERVICE_NO_CONFIG

      public static final EngineHostServicesAuditCode GOVERNANCE_SERVICE_NO_CONFIG
      ENGINE-HOST-SERVICES-0030 - Failed to refresh configuration for governance service registered as {0} for governance request types {1}. The exception was {2} with error message {3}

    • GOVERNANCE_ENGINE_NO_CONFIG

      public static final EngineHostServicesAuditCode GOVERNANCE_ENGINE_NO_CONFIG
      ENGINE-HOST-SERVICES-0031 - Failed to refresh configuration for governance engine {0}. The exception was {1} with error message {2}

    • ENGINE_ACTION_RECORD_COMPLETION

      public static final EngineHostServicesAuditCode ENGINE_ACTION_RECORD_COMPLETION
      ENGINE-HOST-SERVICES-0033 - Engine action {0} running governance service {1} for governance engine {2} with request type {3} has recorded completion status of {4} and output guards of {5}. Next governance action is given request parameters called {6} and action targets of {7}. The completion message was {8}

    • ENGINE_ACTION_FAILED

      public static final EngineHostServicesAuditCode ENGINE_ACTION_FAILED
      ENGINE-HOST-SERVICES-0034 - Failed to execute engine action for governance engine {0}. The exception was {1} with error message {2}

    • ENGINE_ACTION_CANCELLED

      public static final EngineHostServicesAuditCode ENGINE_ACTION_CANCELLED
      ENGINE-HOST-SERVICES-0036 - Governance engine {0} is cancelling running governance service for engine action {1}; thread name is {2}

    • UNEXPECTED_EXCEPTION

      public static final EngineHostServicesAuditCode UNEXPECTED_EXCEPTION
      ENGINE-HOST-SERVICES-0037 - The Governance Action OMES has received an unexpected {0} exception during method {1}; the error message was: {2}

    • CLEARING_ALL_GOVERNANCE_ENGINE_CONFIG

      public static final EngineHostServicesAuditCode CLEARING_ALL_GOVERNANCE_ENGINE_CONFIG
      ENGINE-HOST-SERVICES-0153 - Refreshing governance engine {0}

    • FINISHED_ALL_GOVERNANCE_ENGINE_CONFIG

      public static final EngineHostServicesAuditCode FINISHED_ALL_GOVERNANCE_ENGINE_CONFIG
      ENGINE-HOST-SERVICES-0154 - Refreshing of governance engine {0} is complete

    • ACTION_PROCESSING_ERROR

      public static final EngineHostServicesAuditCode ACTION_PROCESSING_ERROR
      ENGINE-HOST-SERVICES-2000 - {0} caught an exception {1} while processing governance action {2}; the error message was {3}

    • UNEXPECTED_EXCEPTION_DURING_RESTART

      public static final EngineHostServicesAuditCode UNEXPECTED_EXCEPTION_DURING_RESTART
      ENGINE-HOST-SERVICES-2002 - {0} caught an exception {1} while restarting incomplete engine actions; the error message was {2}

  • Method Details

    • values

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