Package org.odpi.openmetadata.accessservices.assetcatalog.auditlog

Enum Class AssetCatalogAuditCode

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

      public static final AssetCatalogAuditCode SERVICE_INITIALIZED
      OMAS-ASSET-CATALOG-0001 The Asset Catalog OMAS has completed initialization of a new instance.

    • SERVICE_INITIALIZING

      public static final AssetCatalogAuditCode SERVICE_INITIALIZING
      OMAS-ASSET-CATALOG-0002 The local server has started up a new instance of the Asset Catalog OMAS.

    • SERVICE_INSTANCE_FAILURE

      public static final AssetCatalogAuditCode SERVICE_INSTANCE_FAILURE
      OMAS-ASSET-CATALOG-0003 The access service detected an error during the start-up of a specific server instance. Its services are not available for the specified server.

    • SERVICE_SHUTDOWN

      public static final AssetCatalogAuditCode SERVICE_SHUTDOWN
      OMAS-ASSET-CATALOG-0004 The local server has requested shut down of an Asset Catalog OMAS instance.

    • EVENT_PROCESSING_EXCEPTION

      public static final AssetCatalogAuditCode EVENT_PROCESSING_EXCEPTION
      OMAS-ASSET-CATALOG-0005 The event could not be processed.

    • EVENT_NOT_PROCESSING

      public static final AssetCatalogAuditCode EVENT_NOT_PROCESSING
      OMAS-ASSET-CATALOG-0006 The event will not be processed.

  • Method Details

    • values

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