Package org.odpi.openmetadata.integrationservices.api.ffdc

Enum Class APIIntegratorAuditCode

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

    • CONTEXT_INITIALIZING

      public static final APIIntegratorAuditCode CONTEXT_INITIALIZING
      OMIS-API-INTEGRATOR-0001 - The API integrator context manager is being initialized for calls to server {0} on platform {1}

    • CONNECTOR_CONTEXT_INITIALIZING

      public static final APIIntegratorAuditCode CONNECTOR_CONTEXT_INITIALIZING
      OMIS-API-INTEGRATOR-0002 - Creating context for integration connector {0} ({1}) connecting to third party technology {2} with permitted synchronization of {3} and service options of {4}

    • NULL_CONTEXT

      public static final APIIntegratorAuditCode NULL_CONTEXT
      OMIS-API-INTEGRATOR-0003 - Integration connector {0} has a null context

  • Method Details

    • values

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