Package org.odpi.openmetadata.accessservices.stewardshipaction.ffdc

Enum Class StewardshipActionAuditCode

java.lang.Object
java.lang.Enum<StewardshipActionAuditCode>
org.odpi.openmetadata.accessservices.stewardshipaction.ffdc.StewardshipActionAuditCode
All Implemented Interfaces:
Serializable, Comparable<StewardshipActionAuditCode>, Constable, AuditLogMessageSet
public enum StewardshipActionAuditCode extends Enum<StewardshipActionAuditCode> implements AuditLogMessageSet
The StewardshipActionAuditCode 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 StewardshipActionAuditCode SERVICE_INITIALIZING
      OMAS-STEWARDSHIP-ACTION-0001 - The Stewardship Action Open Metadata Access Service (OMAS) is initializing a new server instance

    • SERVICE_PUBLISHING

      public static final StewardshipActionAuditCode SERVICE_PUBLISHING
      OMAS-STEWARDSHIP-ACTION-0002 - The Stewardship Action Open Metadata Access Service (OMAS) is ready to publish asset notifications to topic {0}

    • SERVICE_INITIALIZED

      public static final StewardshipActionAuditCode SERVICE_INITIALIZED
      OMAS-STEWARDSHIP-ACTION-0003 - The Stewardship Action Open Metadata Access Service (OMAS) has initialized a new instance for server {0}

    • SERVICE_SHUTDOWN

      public static final StewardshipActionAuditCode SERVICE_SHUTDOWN
      OMAS-STEWARDSHIP-ACTION-0004 - The Stewardship Action Open Metadata Access Service (OMAS) is shutting down its instance for server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final StewardshipActionAuditCode SERVICE_INSTANCE_FAILURE
      OMAS-STEWARDSHIP-ACTION-0005 - The Stewardship Action Open Metadata Access Service (OMAS) is unable to initialize a new instance; error message is {0}

    • PUBLISHING_SHUTDOWN

      public static final StewardshipActionAuditCode PUBLISHING_SHUTDOWN
      OMAS-STEWARDSHIP-ACTION-0010 - The Stewardship Action Open Metadata Access Service (OMAS) is no longer publishing events to topic {0}

    • PUBLISHING_SHUTDOWN_ERROR

      public static final StewardshipActionAuditCode PUBLISHING_SHUTDOWN_ERROR
      OMAS-STEWARDSHIP-ACTION-0011 - The Stewardship Action 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 StewardshipActionAuditCode OUT_TOPIC_EVENT
      OMAS-STEWARDSHIP-ACTION-0012 - The Stewardship Action Open Metadata Access Service (OMAS) has sent event of type: {0}

    • PROCESS_EVENT_EXCEPTION

      public static final StewardshipActionAuditCode PROCESS_EVENT_EXCEPTION
      OMAS-STEWARDSHIP-ACTION-0014 - Event {0} could not be published due to {1} exception with message: {2}

    • OUT_TOPIC_FAILURE

      public static final StewardshipActionAuditCode OUT_TOPIC_FAILURE
      OMAS-STEWARDSHIP-ACTION-0018 - The Stewardship Action Open Metadata Access Service (OMAS) is unable to send an event on its out topic {0}; exception {1} returned error message: {2}

  • Method Details

    • values

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