Package org.odpi.openmetadata.frameworks.integration.ffdc

Enum Class OIFAuditCode

java.lang.Object
java.lang.Enum<OIFAuditCode>
org.odpi.openmetadata.frameworks.integration.ffdc.OIFAuditCode
All Implemented Interfaces:
Serializable, Comparable<OIFAuditCode>, Constable, AuditLogMessageSet
public enum OIFAuditCode extends Enum<OIFAuditCode> implements AuditLogMessageSet
The OIFAuditCode 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 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
    ALL_CATALOG_TARGETS_FOREIGN
    The {0} integration connector found that every one of its {1} catalog target(s) was registered through another metadata access store, so it is refreshing them all
    BAD_OM_PROPERTY_TYPE
    OIF-CONNECTOR-0018 - The {0} connector has detected that element {1} which should be of type {2} has bean properties of {3} rather than {4} in method {5} - element is {6}
    BAD_OM_VALUE
    OIF-CONNECTOR-0018 - The {0} connector has detected a missing or invalid {1} property in method {2} - element is: {3}
    BITOL_FORMAT_ERROR
    OIF-CONNECTOR-0020 - A {0} exception with message {1} occurred when parsing Bitol document: {2}
    BITOL_PUBLISH_ERROR
    OIF-CONNECTOR-0021 - A {0} exception with message {1} occurred when a listening integration connector tried to process a Bitol document
    BITOL_UNEXPECTED_KIND
    OIF-CONNECTOR-0023 - The integration daemon received a Bitol document of kind {0} through the {1} method which expects {2}; the document begins: {3}
    BITOL_UNSUPPORTED_VERSION
    OIF-CONNECTOR-0022 - The integration daemon received a {0} document with identifier {1} and apiVersion {2} which is not supported by Egeria's beans
    CONNECTOR_STOPPING
    OIF-CONNECTOR-0014 - The {0} integration connector has stopped its monitoring and is shutting down
    CONTEXT_INITIALIZING
    OIF-CONNECTOR-0001 - The integration connector context manager is being initialized for calls to server {0} on platform {1}
    DISCONNECT_EXCEPTION
    OIF-CONNECTOR-0012 - The {0} integration connector received an unexpected exception {1} while trying to disconnect connector {2}; the error message was: {3}
    FOREIGN_CATALOG_TARGETS_SKIPPED
    The {0} integration connector is leaving {1} catalog target(s) to the integration daemons that registered them: {2}
    GET_CATALOG_TARGET_EXCEPTION
    OIF-CONNECTOR-0015 - An unexpected {0} exception was returned to the {1} integration connector while retrieving the action targets.
    IGNORED_EGERIA_ELEMENT
    OIF-CONNECTOR-0010 - The {0} connector has detected an unsynchronized {1} element ({2}) in metadata collection {3} ({4}) but the permitted synchronization to catalog target {5} is {6}
    MEMBER_ACTION
    OIF-CONNECTOR-0019 - The {0} connector is recommending the {1} action to take for element {2}
    NO_CATALOG_TARGETS
    OIF-CONNECTOR-0007 - No action targets are defined for the {0} integration connector
    OPEN_LINEAGE_FORMAT_ERROR
    OIF-CONNECTOR-0005 - A {0} exception with message {1} occurred when parsing open lineage event: {2}
    OPEN_LINEAGE_PUBLISH_ERROR
    OIF-CONNECTOR-0006 - A {0} exception with message {1} occurred when a listening integration connector tried to push an OpenLineage event
    REFRESHED_CATALOG_TARGETS
    OIF-CONNECTOR-0009 - The {0} integration connector has refreshed {1} action target(s)
    REFRESHING_CATALOG_TARGET
    OIF-CONNECTOR-0008 - The {0} integration connector is refreshing action target {1}
    UNABLE_TO_REGISTER_LISTENER
    OIF-CONNECTOR-0016 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem.
    UNEXPECTED_EXCEPTION
    OIF-CONNECTOR-0013 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}
    UNKNOWN_ACTION
    OIF-CONNECTOR-0011 - The {0} connector is unsure which action to take for an element.

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

    • CONTEXT_INITIALIZING

      public static final OIFAuditCode CONTEXT_INITIALIZING
      OIF-CONNECTOR-0001 - The integration connector context manager is being initialized for calls to server {0} on platform {1}

    • OPEN_LINEAGE_FORMAT_ERROR

      public static final OIFAuditCode OPEN_LINEAGE_FORMAT_ERROR
      OIF-CONNECTOR-0005 - A {0} exception with message {1} occurred when parsing open lineage event: {2}

    • OPEN_LINEAGE_PUBLISH_ERROR

      public static final OIFAuditCode OPEN_LINEAGE_PUBLISH_ERROR
      OIF-CONNECTOR-0006 - A {0} exception with message {1} occurred when a listening integration connector tried to push an OpenLineage event

    • NO_CATALOG_TARGETS

      public static final OIFAuditCode NO_CATALOG_TARGETS
      OIF-CONNECTOR-0007 - No action targets are defined for the {0} integration connector

    • REFRESHING_CATALOG_TARGET

      public static final OIFAuditCode REFRESHING_CATALOG_TARGET
      OIF-CONNECTOR-0008 - The {0} integration connector is refreshing action target {1}

    • REFRESHED_CATALOG_TARGETS

      public static final OIFAuditCode REFRESHED_CATALOG_TARGETS
      OIF-CONNECTOR-0009 - The {0} integration connector has refreshed {1} action target(s)

    • IGNORED_EGERIA_ELEMENT

      public static final OIFAuditCode IGNORED_EGERIA_ELEMENT
      OIF-CONNECTOR-0010 - The {0} connector has detected an unsynchronized {1} element ({2}) in metadata collection {3} ({4}) but the permitted synchronization to catalog target {5} is {6}

    • UNKNOWN_ACTION

      public static final OIFAuditCode UNKNOWN_ACTION
      OIF-CONNECTOR-0011 - The {0} connector is unsure which action to take for an element. This is a logic error. The member element information is {1}

    • DISCONNECT_EXCEPTION

      public static final OIFAuditCode DISCONNECT_EXCEPTION
      OIF-CONNECTOR-0012 - The {0} integration connector received an unexpected exception {1} while trying to disconnect connector {2}; the error message was: {3}

    • UNEXPECTED_EXCEPTION

      public static final OIFAuditCode UNEXPECTED_EXCEPTION
      OIF-CONNECTOR-0013 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • CONNECTOR_STOPPING

      public static final OIFAuditCode CONNECTOR_STOPPING
      OIF-CONNECTOR-0014 - The {0} integration connector has stopped its monitoring and is shutting down

    • GET_CATALOG_TARGET_EXCEPTION

      public static final OIFAuditCode GET_CATALOG_TARGET_EXCEPTION
      OIF-CONNECTOR-0015 - An unexpected {0} exception was returned to the {1} integration connector while retrieving the action targets. The error message was {2}

    • UNABLE_TO_REGISTER_LISTENER

      public static final OIFAuditCode UNABLE_TO_REGISTER_LISTENER
      OIF-CONNECTOR-0016 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem. The exception message included was {2}

    • BAD_OM_VALUE

      public static final OIFAuditCode BAD_OM_VALUE
      OIF-CONNECTOR-0018 - The {0} connector has detected a missing or invalid {1} property in method {2} - element is: {3}

    • BAD_OM_PROPERTY_TYPE

      public static final OIFAuditCode BAD_OM_PROPERTY_TYPE
      OIF-CONNECTOR-0018 - The {0} connector has detected that element {1} which should be of type {2} has bean properties of {3} rather than {4} in method {5} - element is {6}

    • MEMBER_ACTION

      public static final OIFAuditCode MEMBER_ACTION
      OIF-CONNECTOR-0019 - The {0} connector is recommending the {1} action to take for element {2}

    • BITOL_FORMAT_ERROR

      public static final OIFAuditCode BITOL_FORMAT_ERROR
      OIF-CONNECTOR-0020 - A {0} exception with message {1} occurred when parsing Bitol document: {2}

    • BITOL_PUBLISH_ERROR

      public static final OIFAuditCode BITOL_PUBLISH_ERROR
      OIF-CONNECTOR-0021 - A {0} exception with message {1} occurred when a listening integration connector tried to process a Bitol document

    • BITOL_UNSUPPORTED_VERSION

      public static final OIFAuditCode BITOL_UNSUPPORTED_VERSION
      OIF-CONNECTOR-0022 - The integration daemon received a {0} document with identifier {1} and apiVersion {2} which is not supported by Egeria's beans

    • BITOL_UNEXPECTED_KIND

      public static final OIFAuditCode BITOL_UNEXPECTED_KIND
      OIF-CONNECTOR-0023 - The integration daemon received a Bitol document of kind {0} through the {1} method which expects {2}; the document begins: {3}

    • FOREIGN_CATALOG_TARGETS_SKIPPED

      public static final OIFAuditCode FOREIGN_CATALOG_TARGETS_SKIPPED
      The {0} integration connector is leaving {1} catalog target(s) to the integration daemons that registered them: {2}

    • ALL_CATALOG_TARGETS_FOREIGN

      public static final OIFAuditCode ALL_CATALOG_TARGETS_FOREIGN
      The {0} integration connector found that every one of its {1} catalog target(s) was registered through another metadata access store, so it is refreshing them all

  • Method Details

    • values

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