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

Enum Class DarwinAuditCode

java.lang.Object
java.lang.Enum<DarwinAuditCode>
org.odpi.openmetadata.adapters.connectors.darwin.ffdc.DarwinAuditCode
All Implemented Interfaces:
Serializable, Comparable<DarwinAuditCode>, Constable, AuditLogMessageSet
public enum DarwinAuditCode extends Enum<DarwinAuditCode> implements AuditLogMessageSet
The DarwinAuditCode 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
    CONNECTOR_STOPPING
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0011 - The {0} integration connector has stopped maintaining the digital product dependencies in server {1} on platform {2}
    DEPENDENCY_CREATED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0004 - The {0} integration connector has recorded that digital product {1} depends on digital product {2} through information supply chain {3} (relationship {4})
    DEPENDENCY_REMOVED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0005 - The {0} integration connector has removed the dependency ({1}) of digital product {2} on digital product {3} through information supply chain {4} because the lineage no longer supports it
    EXCEPTION_CLEARED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0008 - The {0} integration connector has cleared the exception ({1}) against digital product {2} because all of its dependencies asserted by external users are now proven by lineage
    LINEAGE_CREATED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0012 - The {0} integration connector has recorded that data flows from {1} to {2} through information supply chain {3} (relationship {4}) because {5}
    LINEAGE_DEPTH_EXCEEDED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0009 - The {0} integration connector stopped following {1} lineage paths because they exceeded the limit of {2} steps
    LINEAGE_REFRESH_COMPLETE
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0015 - The {0} integration connector derived {1} data flows between data assets from the data mappings between their schema elements, and {2} data flows between software servers from the lineage between the data assets their capabilities own; it created {3} DataFlow relationships, removed {4} and set the information supply chain on {5}
    LINEAGE_REMOVED
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0013 - The {0} integration connector has removed the data flow ({1}) from {2} to {3} through information supply chain {4} because the finer-grained lineage no longer supports it
    LINEAGE_SUPPLY_CHAIN_SET
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0014 - The {0} integration connector has set the information supply chain of the data flow ({1}) from {2} to {3}, asserted by {4}, to {5}
    NEW_EXCEPTION_TYPE
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0003 - The {0} integration connector has created the {1} exception type ({2}) to record the digital products whose externally asserted dependencies are not proven by lineage
    REFRESH_COMPLETE
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0010 - The {0} integration connector reviewed {1} digital products and derived {2} dependencies from their lineage; it created {3} relationships, removed {4}, set the information supply chain on {5} and found {6} unproven; it raised {7} exceptions, updated {8} and cleared {9}
    STARTING_CONNECTOR
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0002 - The {0} integration connector is starting to maintain the digital product dependencies in server {1} on platform {2}; lineage paths are followed for up to {3} steps
    SUPPLY_CHAIN_SET
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0006 - The {0} integration connector has set the information supply chain of the dependency ({1}) of digital product {2} on digital product {3}, asserted by {4}, to {5}
    UNEXPECTED_EXCEPTION
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}
    UNPROVEN_DEPENDENCIES
    DARWIN-PRODUCT-DEPENDENCY-MANAGER-0007 - The {0} integration connector has recorded an exception ({1}) against digital product {2} because {3} of its dependencies asserted by external users are not proven by lineage: {4}

  • 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 DarwinAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static DarwinAuditCode[]
    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 DarwinAuditCode UNEXPECTED_EXCEPTION
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • STARTING_CONNECTOR

      public static final DarwinAuditCode STARTING_CONNECTOR
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0002 - The {0} integration connector is starting to maintain the digital product dependencies in server {1} on platform {2}; lineage paths are followed for up to {3} steps

    • NEW_EXCEPTION_TYPE

      public static final DarwinAuditCode NEW_EXCEPTION_TYPE
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0003 - The {0} integration connector has created the {1} exception type ({2}) to record the digital products whose externally asserted dependencies are not proven by lineage

    • DEPENDENCY_CREATED

      public static final DarwinAuditCode DEPENDENCY_CREATED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0004 - The {0} integration connector has recorded that digital product {1} depends on digital product {2} through information supply chain {3} (relationship {4})

    • DEPENDENCY_REMOVED

      public static final DarwinAuditCode DEPENDENCY_REMOVED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0005 - The {0} integration connector has removed the dependency ({1}) of digital product {2} on digital product {3} through information supply chain {4} because the lineage no longer supports it

    • SUPPLY_CHAIN_SET

      public static final DarwinAuditCode SUPPLY_CHAIN_SET
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0006 - The {0} integration connector has set the information supply chain of the dependency ({1}) of digital product {2} on digital product {3}, asserted by {4}, to {5}

    • UNPROVEN_DEPENDENCIES

      public static final DarwinAuditCode UNPROVEN_DEPENDENCIES
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0007 - The {0} integration connector has recorded an exception ({1}) against digital product {2} because {3} of its dependencies asserted by external users are not proven by lineage: {4}

    • EXCEPTION_CLEARED

      public static final DarwinAuditCode EXCEPTION_CLEARED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0008 - The {0} integration connector has cleared the exception ({1}) against digital product {2} because all of its dependencies asserted by external users are now proven by lineage

    • LINEAGE_DEPTH_EXCEEDED

      public static final DarwinAuditCode LINEAGE_DEPTH_EXCEEDED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0009 - The {0} integration connector stopped following {1} lineage paths because they exceeded the limit of {2} steps

    • REFRESH_COMPLETE

      public static final DarwinAuditCode REFRESH_COMPLETE
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0010 - The {0} integration connector reviewed {1} digital products and derived {2} dependencies from their lineage; it created {3} relationships, removed {4}, set the information supply chain on {5} and found {6} unproven; it raised {7} exceptions, updated {8} and cleared {9}

    • CONNECTOR_STOPPING

      public static final DarwinAuditCode CONNECTOR_STOPPING
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0011 - The {0} integration connector has stopped maintaining the digital product dependencies in server {1} on platform {2}

    • LINEAGE_CREATED

      public static final DarwinAuditCode LINEAGE_CREATED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0012 - The {0} integration connector has recorded that data flows from {1} to {2} through information supply chain {3} (relationship {4}) because {5}

    • LINEAGE_REMOVED

      public static final DarwinAuditCode LINEAGE_REMOVED
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0013 - The {0} integration connector has removed the data flow ({1}) from {2} to {3} through information supply chain {4} because the finer-grained lineage no longer supports it

    • LINEAGE_SUPPLY_CHAIN_SET

      public static final DarwinAuditCode LINEAGE_SUPPLY_CHAIN_SET
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0014 - The {0} integration connector has set the information supply chain of the data flow ({1}) from {2} to {3}, asserted by {4}, to {5}

    • LINEAGE_REFRESH_COMPLETE

      public static final DarwinAuditCode LINEAGE_REFRESH_COMPLETE
      DARWIN-PRODUCT-DEPENDENCY-MANAGER-0015 - The {0} integration connector derived {1} data flows between data assets from the data mappings between their schema elements, and {2} data flows between software servers from the lineage between the data assets their capabilities own; it created {3} DataFlow relationships, removed {4} and set the information supply chain on {5}

  • Method Details

    • values

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