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

Enum Class BaudotAuditCode

java.lang.Object
java.lang.Enum<BaudotAuditCode>
org.odpi.openmetadata.adapters.connectors.baudot.ffdc.BaudotAuditCode
All Implemented Interfaces:
Serializable, Comparable<BaudotAuditCode>, Constable, AuditLogMessageSet
public enum BaudotAuditCode extends Enum<BaudotAuditCode> implements AuditLogMessageSet
The BaudotAuditCode 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
    BAUDOT-SUBSCRIPTION-MANAGER-0004 - The {0} integration connector is stopping
    EVENT_PROCESSING_FAILED
    BAUDOT-SUBSCRIPTION-MANAGER-0007 - The {0} integration connector received a {1} exception while processing a change event for element {2}; the message was {3}
    MONITORED_RESOURCE_NOTIFICATION_TYPE
    BAUDOT-SUBSCRIPTION-MANAGER-0002 - The {0} integration connector has refreshed notification type {1} ({2}) where notifications are triggered by changes to its monitored resources.
    NOTIFICATION_TYPE_REFRESH_FAILED
    BAUDOT-SUBSCRIPTION-MANAGER-0006 - The {0} integration connector was unable to refresh notification type {1} ({2}); the {3} exception had message {4}
    ONE_TIME_NOTIFICATION_TYPE
    BAUDOT-SUBSCRIPTION-MANAGER-0003 - The {0} integration connector has refreshed notification type {1} ({2}) where only one notification is sent to each subscriber
    PERIODIC_NOTIFICATION_TYPE
    BAUDOT-SUBSCRIPTION-MANAGER-0005 - The {0} integration connector has refreshed notification type {1} ({2}) where a notification is sent to each subscriber on a regular schedule no more often than every {3} milliseconds.
    REFRESH_COMPLETE
    BAUDOT-SUBSCRIPTION-MANAGER-0013 - The {0} integration connector has completed a refresh: {1} notification type(s) are its catalog targets, and {2} resource(s) are being monitored for changes
    STARTING_CONNECTOR
    BAUDOT-SUBSCRIPTION-MANAGER-0001 - The {0} integration connector is starting; it is connected to metadata access server {1} on platform {2}
    UNREADABLE_NOTIFICATION_TYPE
    BAUDOT-SUBSCRIPTION-MANAGER-0011 - The {0} integration connector is not monitoring notification type {1} ({2}) because it could not be retrieved, or is not a notification type

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

    • STARTING_CONNECTOR

      public static final BaudotAuditCode STARTING_CONNECTOR
      BAUDOT-SUBSCRIPTION-MANAGER-0001 - The {0} integration connector is starting; it is connected to metadata access server {1} on platform {2}

    • MONITORED_RESOURCE_NOTIFICATION_TYPE

      public static final BaudotAuditCode MONITORED_RESOURCE_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0002 - The {0} integration connector has refreshed notification type {1} ({2}) where notifications are triggered by changes to its monitored resources. {3} monitored resources are currently registered

    • ONE_TIME_NOTIFICATION_TYPE

      public static final BaudotAuditCode ONE_TIME_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0003 - The {0} integration connector has refreshed notification type {1} ({2}) where only one notification is sent to each subscriber

    • CONNECTOR_STOPPING

      public static final BaudotAuditCode CONNECTOR_STOPPING
      BAUDOT-SUBSCRIPTION-MANAGER-0004 - The {0} integration connector is stopping

    • PERIODIC_NOTIFICATION_TYPE

      public static final BaudotAuditCode PERIODIC_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0005 - The {0} integration connector has refreshed notification type {1} ({2}) where a notification is sent to each subscriber on a regular schedule no more often than every {3} milliseconds. The connector's next scheduled refresh is at {4}

    • NOTIFICATION_TYPE_REFRESH_FAILED

      public static final BaudotAuditCode NOTIFICATION_TYPE_REFRESH_FAILED
      BAUDOT-SUBSCRIPTION-MANAGER-0006 - The {0} integration connector was unable to refresh notification type {1} ({2}); the {3} exception had message {4}

    • EVENT_PROCESSING_FAILED

      public static final BaudotAuditCode EVENT_PROCESSING_FAILED
      BAUDOT-SUBSCRIPTION-MANAGER-0007 - The {0} integration connector received a {1} exception while processing a change event for element {2}; the message was {3}

    • UNREADABLE_NOTIFICATION_TYPE

      public static final BaudotAuditCode UNREADABLE_NOTIFICATION_TYPE
      BAUDOT-SUBSCRIPTION-MANAGER-0011 - The {0} integration connector is not monitoring notification type {1} ({2}) because it could not be retrieved, or is not a notification type

    • REFRESH_COMPLETE

      public static final BaudotAuditCode REFRESH_COMPLETE
      BAUDOT-SUBSCRIPTION-MANAGER-0013 - The {0} integration connector has completed a refresh: {1} notification type(s) are its catalog targets, and {2} resource(s) are being monitored for changes

  • Method Details

    • values

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