Package org.odpi.openmetadata.viewservices.validmetadata.ffdc

Enum Class ValidMetadataAuditCode

java.lang.Object
java.lang.Enum<ValidMetadataAuditCode>
org.odpi.openmetadata.viewservices.validmetadata.ffdc.ValidMetadataAuditCode
All Implemented Interfaces:
Serializable, Comparable<ValidMetadataAuditCode>, Constable, AuditLogMessageSet
public enum ValidMetadataAuditCode extends Enum<ValidMetadataAuditCode> implements AuditLogMessageSet
The ValidMetadataAuditCode 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 ValidMetadataAuditCode SERVICE_INITIALIZING
      OMVS-VALID-METADATA-0001 The Valid Metadata Open Metadata View Service (OMVS) is initializing

    • SERVICE_INITIALIZED

      public static final ValidMetadataAuditCode SERVICE_INITIALIZED
      OMVS-VALID-METADATA-0002 The Valid Metadata Open Metadata View Service (OMVS) is initialized

    • SERVICE_SHUTDOWN

      public static final ValidMetadataAuditCode SERVICE_SHUTDOWN
      OMVS-VALID-METADATA-0003 The Valid Metadata Open Metadata View Service (OMVS) is shutting down

    • SERVICE_INSTANCE_FAILURE

      public static final ValidMetadataAuditCode SERVICE_INSTANCE_FAILURE
      OMVS-VALID-METADATA-0004 The Valid Metadata Open Metadata View Service (OMVS) is unable to initialize a new instance; error message is {0}

    • SERVICE_TERMINATING

      public static final ValidMetadataAuditCode SERVICE_TERMINATING
      OMVS-VALID-METADATA-0005 The Valid Metadata Open Metadata View Service (OMVS) is shutting down server instance {0}

    • UNEXPECTED_EXCEPTION

      public static final ValidMetadataAuditCode UNEXPECTED_EXCEPTION
      OMVS-VALID-METADATA-0006 The Open Metadata Service has generated an unexpected {0} exception during method {1}. The message was: {2}

  • Method Details

    • values

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