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

Enum Class OMAGConnectorAuditCode

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

    • UNEXPECTED_EXCEPTION

      public static final OMAGConnectorAuditCode UNEXPECTED_EXCEPTION
      The {0} Egeria Connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • EGERIA_CONNECTOR_START

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

    • NEW_SERVER

      public static final OMAGConnectorAuditCode NEW_SERVER
      The {0} integration connector has created a new {1} server element {2} for server {3} on platform {4}

    • NULL_METADATA_COLLECTION_ID

      public static final OMAGConnectorAuditCode NULL_METADATA_COLLECTION_ID
      The {0} integration connector has detected that the {1} server of type {2} has no metadata collection id

    • EGERIA_TARGET_START

      public static final OMAGConnectorAuditCode EGERIA_TARGET_START
      Connector {0} has started monitoring OMAG Server Platform: {1}

    • EGERIA_TARGET_REFRESH

      public static final OMAGConnectorAuditCode EGERIA_TARGET_REFRESH
      Connector {0} is synchronizing metadata for OMAG Server Platform: {1}

    • SERVER_CATALOG_FAILED

      public static final OMAGConnectorAuditCode SERVER_CATALOG_FAILED
      The {0} integration connector was not able to catalog server {1} on platform {2}; the {3} exception returned message {4}

    • PLATFORM_NAME_MIGRATED

      public static final OMAGConnectorAuditCode PLATFORM_NAME_MIGRATED
      The {0} integration connector has renamed platform element {1} from {2} to {3} so that it can be recognised again

    • PLATFORM_CATALOG_TARGET_ADDED

      public static final OMAGConnectorAuditCode PLATFORM_CATALOG_TARGET_ADDED
      The {0} integration connector is now monitoring the OMAG Server Platform at {1}, catalogued as {2}

    • PLATFORM_REGISTRATION_DEFERRED

      public static final OMAGConnectorAuditCode PLATFORM_REGISTRATION_DEFERRED
      The {0} integration connector could not register the OMAG Server Platform at {1} yet; the {2} exception returned message {3}

  • Method Details

    • values

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