Package org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.ffdc

Enum Class AtlasSurveyAuditCode

java.lang.Object
java.lang.Enum<AtlasSurveyAuditCode>
org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.ffdc.AtlasSurveyAuditCode
All Implemented Interfaces:
Serializable, Comparable<AtlasSurveyAuditCode>, Constable, AuditLogMessageSet
public enum AtlasSurveyAuditCode extends Enum<AtlasSurveyAuditCode> implements AuditLogMessageSet
The AtlasDiscoveryAuditCode 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

  • Enum Constant Details

    • UNEXPECTED_EXCEPTION

      public static final AtlasSurveyAuditCode UNEXPECTED_EXCEPTION
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-0001 - The {0} Apache Atlas Discovery Connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • WRONG_REST_CONNECTOR

      public static final AtlasSurveyAuditCode WRONG_REST_CONNECTOR
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-0002 - The {0} Apache Atlas Survey Action Connector has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

    • WRONG_ROOT_SCHEMA_TYPE

      public static final AtlasSurveyAuditCode WRONG_ROOT_SCHEMA_TYPE
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-0003 - The {0} Apache Atlas Discovery Connector has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

    • MISSING_ASSET_UNIVERSE

      public static final AtlasSurveyAuditCode MISSING_ASSET_UNIVERSE
      APACHE-ATLAS-SURVEY-ACTION-CONNECTOR-0004 - The asset universe for Apache Atlas Software Server is null. Apache Atlas Survey Connector {0} is not able to continue with its schema analysis

  • Method Details

    • values

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