Package org.odpi.openmetadata.engineservices.surveyaction.ffdc

Enum Class SurveyActionAuditCode

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

    • SERVICE_INSTANCE_FAILURE

      public static final SurveyActionAuditCode SERVICE_INSTANCE_FAILURE
      OMES-SURVEY-ACTION-0012 - The Survey Action OMES cannot initialize a new instance of itself in server {0}; error message is {1}

    • SERVER_SHUTTING_DOWN

      public static final SurveyActionAuditCode SERVER_SHUTTING_DOWN
      OMES-SURVEY-ACTION-0014 - The Survey Action OMES in server {0} is shutting down

    • SERVER_SHUTDOWN

      public static final SurveyActionAuditCode SERVER_SHUTDOWN
      OMES-SURVEY-ACTION-0016 - The Survey Action OMES in server {0} has completed shutdown

    • SURVEY_ACTION_SERVICE_STARTING

      public static final SurveyActionAuditCode SURVEY_ACTION_SERVICE_STARTING
      OMES-SURVEY-ACTION-0017 - The survey action service {0} is starting to analyze asset {1} with request type {2} in survey action engine {3} (guid={4}); the results will be stored in survey report {5}

    • SURVEY_ACTION_SERVICE_FAILED

      public static final SurveyActionAuditCode SURVEY_ACTION_SERVICE_FAILED
      OMES-SURVEY-ACTION-0018 - The survey action service {0} threw a {1} exception during the generation of survey report {2} for asset {3} during request type {4} in survey action engine {5} (guid={6}). The error message was {7}

    • SURVEY_ACTION_SERVICE_COMPLETE

      public static final SurveyActionAuditCode SURVEY_ACTION_SERVICE_COMPLETE
      OMES-SURVEY-ACTION-0019 - The survey action service {0} has completed the analysis of asset {1} with request type {2} in {3} milliseconds; the results are stored in survey report {4}

    • INVALID_SURVEY_ACTION_SERVICE

      public static final SurveyActionAuditCode INVALID_SURVEY_ACTION_SERVICE
      OMES-SURVEY-ACTION-0029 - The survey action service {0} linked to request type {1} can not be started. The {2} exception was returned with message {3}

    • IGNORING_ASSETS

      public static final SurveyActionAuditCode IGNORING_ASSETS
      OMES-SURVEY-ACTION-0030 - The survey action service {0} linked to request type {1} is processing asset {2} and ignoring the following asset action targets: {3}

  • Method Details

    • values

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