Package org.odpi.openmetadata.frameworkservices.omf.ffdc

Enum Class OMFServicesAuditCode

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

    • SERVICE_INITIALIZING

      public static final OMFServicesAuditCode SERVICE_INITIALIZING
      OMF-SERVICES-0001 - The Open Metadata Store Services are initializing a new server instance

    • SERVICE_PUBLISHING

      public static final OMFServicesAuditCode SERVICE_PUBLISHING
      OMF-SERVICES-0002 The Open Metadata Store is ready to publish asset manager notifications to topic {0}

    • SERVICE_INITIALIZED

      public static final OMFServicesAuditCode SERVICE_INITIALIZED
      OMF-SERVICES-0005 - The Open Metadata Store Services has initialized a new instance for server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final OMFServicesAuditCode SERVICE_INSTANCE_FAILURE
      OMF-SERVICES-0006 - The Open Metadata Store Services are unable to initialize a new instance; error message is {0}

    • PUBLISHING_SHUTDOWN

      public static final OMFServicesAuditCode PUBLISHING_SHUTDOWN
      OMF-SERVICES-0007 The Open Metadata Store is no longer publishing events to topic {0}

    • PUBLISHING_SHUTDOWN_ERROR

      public static final OMFServicesAuditCode PUBLISHING_SHUTDOWN_ERROR
      OMF-SERVICES-0008 The Open Metadata Store caught an unexpected {0} exception whilst shutting down the out topic {1}. The error message was: {2}

    • UNEXPECTED_INITIALIZATION_EXCEPTION

      public static final OMFServicesAuditCode UNEXPECTED_INITIALIZATION_EXCEPTION
      OMF-SERVICES-0008 - The Open Metadata Store Services detected an unexpected {0} exception during the initialization of its services; error message is {1}

    • SERVICE_TERMINATING

      public static final OMFServicesAuditCode SERVICE_TERMINATING
      OMF-SERVICES-0009 - The Open Metadata Store Services are shutting down server instance {0}

    • SERVICE_SHUTDOWN

      public static final OMFServicesAuditCode SERVICE_SHUTDOWN
      OMF-SERVICES-0012 - The Open Metadata Store Services are shutting down its instance for server {0}

    • OUT_TOPIC_EVENT

      public static final OMFServicesAuditCode OUT_TOPIC_EVENT
      OMF-SERVICES-0013 The OMF Services has sent event of type: {0}

    • PROCESS_EVENT_EXCEPTION

      public static final OMFServicesAuditCode PROCESS_EVENT_EXCEPTION
      OMF-SERVICES-0014 Event {0} could not be published due to {1} exception with message: {2}

    • PARSE_EVENT_EXCEPTION

      public static final OMFServicesAuditCode PARSE_EVENT_EXCEPTION
      OMF-SERVICES-0015 Inbound event {0} could not be parsed. IOException included the following message: {1}

    • ASSET_AUDIT_LOG

      public static final OMFServicesAuditCode ASSET_AUDIT_LOG
      OMF-SERVICES-0020 - Log message for asset {0} from governance service {1}: {2}

  • Method Details

    • values

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