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

Enum Class EgeriaInfrastructureConnectorAuditCode

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

    • EGERIA_CONNECTOR_START

      public static final EgeriaInfrastructureConnectorAuditCode EGERIA_CONNECTOR_START
      The {0} integration connector has been started and will call the platforms with userId {1}. The monitored platforms are: {2}

    • KAFKA_CONNECTOR_START

      public static final EgeriaInfrastructureConnectorAuditCode KAFKA_CONNECTOR_START
      The {0} integration connector has been initialized with the following platforms: {1}

    • UNABLE_TO_RETRIEVE_TOPICS

      public static final EgeriaInfrastructureConnectorAuditCode UNABLE_TO_RETRIEVE_TOPICS
      The {0} integration connector received an unexpected {2} exception when auditing topics. The error message was {2}

    • UNKNOWN_TOPIC

      public static final EgeriaInfrastructureConnectorAuditCode UNKNOWN_TOPIC
      The {0} integration connector has retrieved a topic called {1} from {2} that is not catalogued

    • PLATFORM_DETECTED

      public static final EgeriaInfrastructureConnectorAuditCode PLATFORM_DETECTED
      The {0} integration connector has detected an Egeria OMAG Server Platform called '{1}' ({2}) with unique identifier {3}

    • PLATFORM_CATALOGUING_STARTED

      public static final EgeriaInfrastructureConnectorAuditCode PLATFORM_CATALOGUING_STARTED
      The {0} integration connector has started cataloguing Egeria OMAG Server Platform called '{1}' ({2}) with unique identifier {3} located at URL {4}

    • UNEXPECTED_EXCEPTION

      public static final EgeriaInfrastructureConnectorAuditCode UNEXPECTED_EXCEPTION
      The {0} integration connector received an unexpected {1} exception when retrieving details of a platform. The error message was {2}

    • UNKNOWN_PLATFORM

      public static final EgeriaInfrastructureConnectorAuditCode UNKNOWN_PLATFORM
      The {0} integration connector is not able to retrieve platform {1} ({2}) from the catalog

    • CONNECTOR_STOPPING

      public static final EgeriaInfrastructureConnectorAuditCode CONNECTOR_STOPPING
      The {0} integration connector has stopped its platform monitoring and is shutting down

  • Method Details

    • values

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