Package org.odpi.openmetadata.accessservices.datamanager.ffdc

Enum Class DataManagerAuditCode

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

    • SERVICE_INITIALIZING

      public static final DataManagerAuditCode SERVICE_INITIALIZING
      OMAS-DATA-MANAGER-0001 - The Data Manager Open Metadata Access Service (OMAS) is initializing a new server instance

    • SERVICE_PUBLISHING

      public static final DataManagerAuditCode SERVICE_PUBLISHING
      OMAS-DATA-MANAGER-0002 - The Data Manager Open Metadata Access Service (OMAS) is ready to publish data manager notifications to topic {0}

    • SERVICE_INSTANCE_FAILURE

      public static final DataManagerAuditCode SERVICE_INSTANCE_FAILURE
      OMAS-DATA-MANAGER-0003 - The Data Manager Open Metadata Access Service (OMAS) is unable to initialize a new instance; error message is {0}

    • SERVICE_INITIALIZED

      public static final DataManagerAuditCode SERVICE_INITIALIZED
      OMAS-DATA-MANAGER-0004 - The Data Manager Open Metadata Access Service (OMAS) has initialized a new instance for server {0}

    • SERVICE_SHUTDOWN

      public static final DataManagerAuditCode SERVICE_SHUTDOWN
      OMAS-DATA-MANAGER-0005 - The Data Manager Open Metadata Access Service (OMAS) is shutting down server instance {0}

    • PUBLISHING_SHUTDOWN

      public static final DataManagerAuditCode PUBLISHING_SHUTDOWN
      OMAS-DATA-MANAGER-0006 - The Data Manager Open Metadata Access Service (OMAS) is no longer publishing events to topic {0}

    • PUBLISHING_SHUTDOWN_ERROR

      public static final DataManagerAuditCode PUBLISHING_SHUTDOWN_ERROR
      OMAS-DATA-MANAGER-0007 - The Data Manager Open Metadata Access Service (OMAS) caught an unexpected {0} exception whilst shutting down the out topic {1}. The error message was: {2}

    • OUT_TOPIC_EVENT

      public static final DataManagerAuditCode OUT_TOPIC_EVENT
      OMAS-DATA-MANAGER-0013 - The Data Manager Open Metadata Access Service (OMAS) has sent event of type: {0}

    • OUTBOUND_EVENT_EXCEPTION

      public static final DataManagerAuditCode OUTBOUND_EVENT_EXCEPTION
      OMAS-DATA-MANAGER-0018 - Unable to send an outbound event of type {0} for instance with unique identifier of {1} and type name {2} due to exception {3}. The error message from the exception was {4}

  • Method Details

    • values

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