Package org.odpi.openmetadata.adapters.connectors.integration.bitol.ffdc

Enum Class BitolIntegrationConnectorAuditCode

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

    • TOPIC_RECEIVER_CONFIGURATION

      public static final BitolIntegrationConnectorAuditCode TOPIC_RECEIVER_CONFIGURATION
      BITOL-INTEGRATION-CONNECTOR-0001 - The {0} integration connector is monitoring topic {1} with connection: {2} for Bitol documents

    • DIRECTORY_MONITORED

      public static final BitolIntegrationConnectorAuditCode DIRECTORY_MONITORED
      BITOL-INTEGRATION-CONNECTOR-0002 - The {0} integration connector is monitoring directory {1} (from {2}) for Bitol documents

    • DOCUMENT_PUBLISHED

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_PUBLISHED
      BITOL-INTEGRATION-CONNECTOR-0003 - The {0} integration connector published the {1} document from file {2}

    • DIRECTORY_NOT_ACCESSIBLE

      public static final BitolIntegrationConnectorAuditCode DIRECTORY_NOT_ACCESSIBLE
      BITOL-INTEGRATION-CONNECTOR-0004 - The {0} integration connector is unable to read directory {1} (from {2}): {3}

    • DOCUMENT_STORED

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_STORED
      BITOL-INTEGRATION-CONNECTOR-0005 - The {0} integration connector stored a {1} document as {2}

    • DOCUMENT_CATALOGUED

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_CATALOGUED
      BITOL-INTEGRATION-CONNECTOR-0006 - The {0} integration connector {1} element {2} for {3} document {4} version {5}

    • DOCUMENT_MAPPING_WARNING

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_MAPPING_WARNING
      BITOL-INTEGRATION-CONNECTOR-0007 - The {0} integration connector could not fully represent {1} document {2} version {3}: {4}

    • DOCUMENT_WITHOUT_ID

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_WITHOUT_ID
      BITOL-INTEGRATION-CONNECTOR-0008 - The {0} integration connector skipped a {1} document because it has no identifier; the document begins: {2}

    • DOCUMENT_GENERATED

      public static final BitolIntegrationConnectorAuditCode DOCUMENT_GENERATED
      BITOL-INTEGRATION-CONNECTOR-0009 - The {0} integration connector generated and published the {1} document {2} version {3} from element {4}

    • FILE_CATALOGUED

      public static final BitolIntegrationConnectorAuditCode FILE_CATALOGUED
      BITOL-INTEGRATION-CONNECTOR-0011 - The {0} integration connector catalogued the {1} document file {2} as asset {3} with deployed implementation type {4}

    • FILE_NOT_CATALOGUED

      public static final BitolIntegrationConnectorAuditCode FILE_NOT_CATALOGUED
      BITOL-INTEGRATION-CONNECTOR-0012 - The {0} integration connector could not catalog the {1} document file {2}: {3}

    • UNEXPECTED_EXCEPTION

      public static final BitolIntegrationConnectorAuditCode UNEXPECTED_EXCEPTION
      BITOL-INTEGRATION-CONNECTOR-0010 - The {0} integration connector received an unexpected {1} exception in method {2} when working with Bitol documents; the error message was: {3}

  • Method Details

    • values

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