Package org.odpi.openmetadata.accessservices.assetlineage.auditlog

Enum Class AssetLineageAuditCode

java.lang.Object
java.lang.Enum<AssetLineageAuditCode>
org.odpi.openmetadata.accessservices.assetlineage.auditlog.AssetLineageAuditCode
All Implemented Interfaces:
Serializable, Comparable<AssetLineageAuditCode>, Constable, AuditLogMessageSet
public enum AssetLineageAuditCode extends Enum<AssetLineageAuditCode> implements AuditLogMessageSet
The AssetLineageAuditCode 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
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • SERVICE_INITIALIZING

      public static final AssetLineageAuditCode SERVICE_INITIALIZING
      OMAS-ASSET-LINEAGE-0001 The Asset Lineage Open Metadata Access Service (OMAS) is initializing a new server instance.

    • SERVICE_INITIALIZED

      public static final AssetLineageAuditCode SERVICE_INITIALIZED
      OMAS-ASSET-LINEAGE-0002 The Asset Lineage OMAS has completed initialization.

    • SERVICE_SHUTDOWN

      public static final AssetLineageAuditCode SERVICE_SHUTDOWN
      OMAS-ASSET-LINEAGE-0003 The local server has requested shut down of an Asset Lineage OMAS server instance.

    • SERVICE_INSTANCE_FAILURE

      public static final AssetLineageAuditCode SERVICE_INSTANCE_FAILURE
      OMAS-ASSET-LINEAGE-0004 The Asset Lineage Open Metadata Access Service (OMAS) is unable to initialize a new instance; error message is {0} from server {1}

    • EVENT_PROCESSING_EXCEPTION

      public static final AssetLineageAuditCode EVENT_PROCESSING_EXCEPTION
      OMAS-ASSET-LINEAGE-0005 The event could not be processed.

    • PUBLISH_PROCESS_INFO

      public static final AssetLineageAuditCode PUBLISH_PROCESS_INFO
      OMAS-ASSET-LINEAGE-0006 The Asset Lineage OMAS records information about processing sequence.

    • ENTITY_INFO

      public static final AssetLineageAuditCode ENTITY_INFO
      OMAS-ASSET-LINEAGE-0007 The Asset Lineage OMAS records information about entity.

    • ENTITY_ERROR

      public static final AssetLineageAuditCode ENTITY_ERROR
      OMAS-ASSET-LINEAGE-0008 The Asset Lineage OMAS records error while processing entity.

    • PUBLISH_EVENT_ERROR

      public static final AssetLineageAuditCode PUBLISH_EVENT_ERROR
      OMAS-ASSET-LINEAGE-0009 Error while trying to use AssetLineagePublisher instance.

    • ASSET_CONTEXT_INFO

      public static final AssetLineageAuditCode ASSET_CONTEXT_INFO
      OMAS-ASSET-LINEAGE-0010 The Asset Lineage OMAS retrieves entity's asset context.

    • CONFIGURED_PUBLISHER_BATCH_SIZE

      public static final AssetLineageAuditCode CONFIGURED_PUBLISHER_BATCH_SIZE
      OMAS-ASSET-LINEAGE-0011 The Asset Lineage OMAS is configured with property name {} and value {}

    • INVALID_PUBLISHER_BATCH_SIZE

      public static final AssetLineageAuditCode INVALID_PUBLISHER_BATCH_SIZE
      OMAS-ASSET-LINEAGE-0012 The access service was passed invalid value in access service's options.

  • Method Details

    • values

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