Package org.odpi.openmetadata.adapters.connectors.jacquard.ffdc

Enum Class JacquardAuditCode

java.lang.Object
java.lang.Enum<JacquardAuditCode>
org.odpi.openmetadata.adapters.connectors.jacquard.ffdc.JacquardAuditCode
All Implemented Interfaces:
Serializable, Comparable<JacquardAuditCode>, Constable, AuditLogMessageSet
public enum JacquardAuditCode extends Enum<JacquardAuditCode> implements AuditLogMessageSet
The JacquardAuditCode is used to define the message content for the 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 for 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
    BAD_CONFIGURATION
    JACQUARD-HARVESTER-0005 - The {0} integration connector encountered an {1} exception when connecting to {2} during the {3} method.
    BARDOT_STARTED
    JACQUARD-HARVESTER-0006 - The {0} integration connector has initiated the Badot Subscription Manager running as engine action {1} with {2} action targets
    CONNECTOR_STOPPING
    JACQUARD-HARVESTER-0009 - The {0} integration connector has stopped its monitoring of open metadata from server {1} on platform {2} and is shutting down
    CREATED_SUPPORTING_DEFINITION
    JACQUARD-HARVESTER-0010 - The {0} integration connector has created a new {1} supporting definition with GUID {2}
    DATA_SET_UPDATE_DETECTED
    JACQUARD-HARVESTER-0004 - Integration connector {0} detected that row {1} of dataset {2} has been updated on {3}
    LINKING_ELEMENTS
    JACQUARD-HARVESTER-0014 - The {0} integration connector is linking {1} element {2} to {3} element {4} using relationship {5}
    NEW_OPEN_METADATA_PRODUCT
    JACQUARD-HARVESTER-0012 - The {0} integration connector has created a new digital product {1} called {2}
    NO_CREATION_DATE
    JACQUARD-HARVESTER-0003 - Integration connector {0} cannot determine if tabular data source {1} has changed since it has no createTime column
    NO_LAST_UPDATE_DATE
    JACQUARD-HARVESTER-0002 - Integration connector {0} cannot determine if tabular data source {1} has changed since it has no last update time column
    RETRIEVED_VALID_VALUE_PRODUCT
    JACQUARD-HARVESTER-0017 - The {0} integration connector has retrieved existing digital product {1} for valid value set {2}
    RETRIEVING_OPEN_METADATA_PRODUCT
    JACQUARD-HARVESTER-0016 - The {0} integration connector has retrieved an existing digital product {1} called {2}
    RETRIEVING_SUPPORTING_DEFINITION
    JACQUARD-HARVESTER-0015 - The {0} integration connector has retrieved a new {1} supporting definition with GUID {2}
    STARTING_CONNECTOR
    JACQUARD-HARVESTER-0011 - The {0} integration connector is starting its harvesting of open metadata from server {1} on platform {2} into digital products
    UNABLE_TO_REGISTER_LISTENER
    JACQUARD-HARVESTER-0032 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem.
    UNEXPECTED_EXCEPTION
    JACQUARD-HARVESTER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

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

    • UNEXPECTED_EXCEPTION

      public static final JacquardAuditCode UNEXPECTED_EXCEPTION
      JACQUARD-HARVESTER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • NO_LAST_UPDATE_DATE

      public static final JacquardAuditCode NO_LAST_UPDATE_DATE
      JACQUARD-HARVESTER-0002 - Integration connector {0} cannot determine if tabular data source {1} has changed since it has no last update time column

    • NO_CREATION_DATE

      public static final JacquardAuditCode NO_CREATION_DATE
      JACQUARD-HARVESTER-0003 - Integration connector {0} cannot determine if tabular data source {1} has changed since it has no createTime column

    • DATA_SET_UPDATE_DETECTED

      public static final JacquardAuditCode DATA_SET_UPDATE_DETECTED
      JACQUARD-HARVESTER-0004 - Integration connector {0} detected that row {1} of dataset {2} has been updated on {3}

    • BAD_CONFIGURATION

      public static final JacquardAuditCode BAD_CONFIGURATION
      JACQUARD-HARVESTER-0005 - The {0} integration connector encountered an {1} exception when connecting to {2} during the {3} method. The exception message included was {4}

    • BARDOT_STARTED

      public static final JacquardAuditCode BARDOT_STARTED
      JACQUARD-HARVESTER-0006 - The {0} integration connector has initiated the Badot Subscription Manager running as engine action {1} with {2} action targets

    • CONNECTOR_STOPPING

      public static final JacquardAuditCode CONNECTOR_STOPPING
      JACQUARD-HARVESTER-0009 - The {0} integration connector has stopped its monitoring of open metadata from server {1} on platform {2} and is shutting down

    • CREATED_SUPPORTING_DEFINITION

      public static final JacquardAuditCode CREATED_SUPPORTING_DEFINITION
      JACQUARD-HARVESTER-0010 - The {0} integration connector has created a new {1} supporting definition with GUID {2}

    • STARTING_CONNECTOR

      public static final JacquardAuditCode STARTING_CONNECTOR
      JACQUARD-HARVESTER-0011 - The {0} integration connector is starting its harvesting of open metadata from server {1} on platform {2} into digital products

    • NEW_OPEN_METADATA_PRODUCT

      public static final JacquardAuditCode NEW_OPEN_METADATA_PRODUCT
      JACQUARD-HARVESTER-0012 - The {0} integration connector has created a new digital product {1} called {2}

    • LINKING_ELEMENTS

      public static final JacquardAuditCode LINKING_ELEMENTS
      JACQUARD-HARVESTER-0014 - The {0} integration connector is linking {1} element {2} to {3} element {4} using relationship {5}

    • RETRIEVING_SUPPORTING_DEFINITION

      public static final JacquardAuditCode RETRIEVING_SUPPORTING_DEFINITION
      JACQUARD-HARVESTER-0015 - The {0} integration connector has retrieved a new {1} supporting definition with GUID {2}

    • RETRIEVING_OPEN_METADATA_PRODUCT

      public static final JacquardAuditCode RETRIEVING_OPEN_METADATA_PRODUCT
      JACQUARD-HARVESTER-0016 - The {0} integration connector has retrieved an existing digital product {1} called {2}

    • RETRIEVED_VALID_VALUE_PRODUCT

      public static final JacquardAuditCode RETRIEVED_VALID_VALUE_PRODUCT
      JACQUARD-HARVESTER-0017 - The {0} integration connector has retrieved existing digital product {1} for valid value set {2}

    • UNABLE_TO_REGISTER_LISTENER

      public static final JacquardAuditCode UNABLE_TO_REGISTER_LISTENER
      JACQUARD-HARVESTER-0032 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem. The exception message included was {2}

  • Method Details

    • values

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