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

  • 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
    ACTION_PROCESSING_ERROR
    ENGINE-HOST-SERVICES-2000 - {0} caught an exception {1} while processing governance action {2}; the error message was {3}
    ALL_ENGINE_SERVICES_STARTED
    ENGINE-HOST-SERVICES-0014 - {0} out of {1} Open Metadata Engine Services (OMESs) in engine host server {2} have initialized
    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.
    CLEARING_ALL_GOVERNANCE_SERVICE_CONFIG
    ENGINE-HOST-SERVICES-0028 - All governance service configuration is being refreshed for governance engine {0}
    CONFIGURATION_LISTENER_REGISTERED
    ENGINE-HOST-SERVICES-0027 - The engine host services has registered the configuration listener for server {0}.
    ENGINE_ACTION_FAILED
    ENGINE-HOST-SERVICES-0034 - Failed to execute engine action for governance engine {0}.
    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}.
    ENGINE_ACTION_TARGET_COMPLETION
    ENGINE-HOST-SERVICES-0032 - Engine action {0} running governance service {1} for governance engine {2} with request type {3} has recorded completion on action target {4} with status {5} (start time {6}; completion time {7}) and completion message of {8}
    ENGINE_SERVICE_INSTANCE_FAILURE
    ENGINE-HOST-SERVICES-0020 - Engine host server {0} failed to start.
    ENGINE_SERVICE_NULL_HANDLERS
    ENGINE-HOST-SERVICES-0013 - Engine service {0} in engine host {1} is unable to start any governance engines
    ENGINE_SHUTDOWN
    ENGINE-HOST-SERVICES-0015 - The governance engine {0} in server {1} is shutting down
    EXC_ON_ERROR_STATUS_UPDATE
    ENGINE-HOST-SERVICES-0024 - Governance engine {0} is unable to update the status for governance service {1}.
    FINISHED_ALL_GOVERNANCE_SERVICE_CONFIG
    ENGINE-HOST-SERVICES-0029 - Refreshing all governance service configuration has being completed for governance engine {0}
    GOVERNANCE_ENGINE_NO_CONFIG
    ENGINE-HOST-SERVICES-0031 - Failed to refresh configuration for governance engine {0}.
    GOVERNANCE_SERVICE_NO_CONFIG
    ENGINE-HOST-SERVICES-0030 - Failed to refresh configuration for governance service registered as {0} for governance request types {1}.
    NO_CONFIG_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-0005 - Engine host {0} is not configured with the name for the server running its configuration OMAS {1}
    NO_CONFIG_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-0004 - Engine host {0} is not configured with the platform URL root for its configuration OMAS {1}
    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}.
    NO_ENGINES
    ENGINE-HOST-SERVICES-0152 - The {0} in server {1} is not configured with any engines
    NO_ENGINES_FOR_SERVICE
    ENGINE-HOST-SERVICES-0008 - No governance engines are configured in the engine service {0} on engine host {1}
    NO_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-0151 - {0} in server {1} is not configured with the name for the server running the {2}
    NO_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-0150 - {0} in server {1} is not configured with the platform URL root for the {2}
    NO_PARTNER_OMAS_SERVER_NAME
    ENGINE-HOST-SERVICES-0007 - Engine service {0} in engine host {1} is not configured with the name for the server running its partner OMAS {2}
    NO_PARTNER_OMAS_SERVER_URL
    ENGINE-HOST-SERVICES-0006 - Engine service {0} in engine host {1} is not configured with the platform URL root for its partner OMAS {2}
    NO_SUPPORTED_REQUEST_TYPES
    ENGINE-HOST-SERVICES-0022 - Governance engine {0} in engine host server {1} is not configured to support any type of governance requests
    NULL_ENGINE_NAME
    ENGINE-HOST-SERVICES-0009 - {0} in engine host {1} is configured with a null engine name
    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}
    REQUEST_TYPE_CONFIG_ERROR
    ENGINE-HOST-SERVICES-0023 - Governance engine {0} in engine host server {1} is not able to retrieve its configured governance request types from the Governance Engine OMAS running in server {2} on OMAG Server Platform {3}.
    SERVER_INITIALIZED
    ENGINE-HOST-SERVICES-0002 - The engine host {0} has initialized
    SERVER_INITIALIZING
    ENGINE-HOST-SERVICES-0001 - The engine host services are initializing in server {0}
    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}.
    SERVER_SHUTDOWN
    ENGINE-HOST-SERVICES-0018 - The engine host {0} has completed shut down
    SERVER_SHUTTING_DOWN
    ENGINE-HOST-SERVICES-0017 - The engine host {0} is shutting down
    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}
    SKIPPING_ENGINE_SERVICE
    ENGINE-HOST-SERVICES-0016 - The {0} engine service is disabled and will not be started
    STARTING_ENGINE_SERVICES
    ENGINE-HOST-SERVICES-0012 - The Open Metadata Engine Services (OMESs) are initializing in server {0}
    SUPPORTED_REQUEST_TYPE
    ENGINE-HOST-SERVICES-0021 - Governance engine {0} in engine host server {1} is configured to process governance requests of type {2}
    UNKNOWN_GOVERNANCE_ENGINE_NAME
    ENGINE-HOST-SERVICES-0025 - Governance engine called {0} is not known by metadata server {1}.

  • 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()
    toString() JSON-style
    static EngineHostServicesAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EngineHostServicesAuditCode[]
    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

    • 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}

    • NO_CONFIG_OMAS_SERVER_URL

      public static final EngineHostServicesAuditCode NO_CONFIG_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-0004 - Engine host {0} is not configured with the platform URL root for its configuration OMAS {1}

    • NO_CONFIG_OMAS_SERVER_NAME

      public static final EngineHostServicesAuditCode NO_CONFIG_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-0005 - Engine host {0} is not configured with the name for the server running its configuration OMAS {1}

    • NO_PARTNER_OMAS_SERVER_URL

      public static final EngineHostServicesAuditCode NO_PARTNER_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-0006 - Engine service {0} in engine host {1} is not configured with the platform URL root for its partner OMAS {2}

    • NO_PARTNER_OMAS_SERVER_NAME

      public static final EngineHostServicesAuditCode NO_PARTNER_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-0007 - Engine service {0} in engine host {1} is not configured with the name for the server running its partner OMAS {2}

    • NO_ENGINES_FOR_SERVICE

      public static final EngineHostServicesAuditCode NO_ENGINES_FOR_SERVICE
      ENGINE-HOST-SERVICES-0008 - No governance engines are configured in the engine service {0} on engine host {1}

    • NULL_ENGINE_NAME

      public static final EngineHostServicesAuditCode NULL_ENGINE_NAME
      ENGINE-HOST-SERVICES-0009 - {0} in engine host {1} is configured with a null engine name

    • 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}

    • ENGINE_SERVICE_NULL_HANDLERS

      public static final EngineHostServicesAuditCode ENGINE_SERVICE_NULL_HANDLERS
      ENGINE-HOST-SERVICES-0013 - Engine service {0} in engine host {1} is unable to start any governance engines

    • 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_SUPPORTED_REQUEST_TYPES

      public static final EngineHostServicesAuditCode NO_SUPPORTED_REQUEST_TYPES
      ENGINE-HOST-SERVICES-0022 - Governance engine {0} in engine host server {1} is not configured to support any type of governance requests

    • REQUEST_TYPE_CONFIG_ERROR

      public static final EngineHostServicesAuditCode REQUEST_TYPE_CONFIG_ERROR
      ENGINE-HOST-SERVICES-0023 - Governance engine {0} in engine host server {1} is not able to retrieve its configured governance request types from the Governance Engine OMAS running in server {2} on OMAG Server Platform {3}. The error message was {4}

    • EXC_ON_ERROR_STATUS_UPDATE

      public static final EngineHostServicesAuditCode EXC_ON_ERROR_STATUS_UPDATE
      ENGINE-HOST-SERVICES-0024 - Governance engine {0} is unable to update the status for governance service {1}. The exception was {2} with error message {3}

    • UNKNOWN_GOVERNANCE_ENGINE_NAME

      public static final EngineHostServicesAuditCode UNKNOWN_GOVERNANCE_ENGINE_NAME
      ENGINE-HOST-SERVICES-0025 - Governance engine called {0} is not known by metadata server {1}. Exception {2} with message {3} returned to server {4}

    • 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}. It will receive configuration updates from metadata server {1}

    • 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_TARGET_COMPLETION

      public static final EngineHostServicesAuditCode ENGINE_ACTION_TARGET_COMPLETION
      ENGINE-HOST-SERVICES-0032 - Engine action {0} running governance service {1} for governance engine {2} with request type {3} has recorded completion on action target {4} with status {5} (start time {6}; completion time {7}) and completion message of {8}

    • 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}

    • NO_OMAS_SERVER_URL

      public static final EngineHostServicesAuditCode NO_OMAS_SERVER_URL
      ENGINE-HOST-SERVICES-0150 - {0} in server {1} is not configured with the platform URL root for the {2}

    • NO_OMAS_SERVER_NAME

      public static final EngineHostServicesAuditCode NO_OMAS_SERVER_NAME
      ENGINE-HOST-SERVICES-0151 - {0} in server {1} is not configured with the name for the server running the {2}

    • NO_ENGINES

      public static final EngineHostServicesAuditCode NO_ENGINES
      ENGINE-HOST-SERVICES-0152 - The {0} in server {1} is not configured with any engines

    • 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}

  • 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()
      toString() JSON-style
      Overrides:
      toString in class Enum<EngineHostServicesAuditCode>
      Returns:
      string description