Package org.odpi.openmetadata.frameworks.integration.ffdc

Enum Class OIFErrorCode

java.lang.Object
java.lang.Enum<OIFErrorCode>
org.odpi.openmetadata.frameworks.integration.ffdc.OIFErrorCode
All Implemented Interfaces:
Serializable, Comparable<OIFErrorCode>, Constable, ExceptionMessageSet
public enum OIFErrorCode extends Enum<OIFErrorCode> implements ExceptionMessageSet
The OIFErrorCode 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

    • ENGAGE_IMPLEMENTATION_MISSING

      public static final OIFErrorCode ENGAGE_IMPLEMENTATION_MISSING
      OIF-CONNECTOR-400-001 - The integration connector {0} has been configured to have its own thread to issue blocking calls but has not implemented the engage() method

    • NULL_OBJECT

      public static final OIFErrorCode NULL_OBJECT
      OIF-CONNECTOR-400-002 - The object passed on the {0} parameter of the {1} operation is null

    • UNEXPECTED_IO_EXCEPTION

      public static final OIFErrorCode UNEXPECTED_IO_EXCEPTION
      OIF-CONNECTOR-400-003 - The connector received an unexpected IO exception when reading the file named {0}; the error message was: {1}

  • Method Details

    • values

      public static OIFErrorCode[] 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 OIFErrorCode 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 ExceptionMessageDefinition getMessageDefinition()
      Retrieve a message definition object for an exception. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public ExceptionMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      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<OIFErrorCode>
      Returns:
      string of property names and values for this enum