Class DetailedMessageFormatRuntimeException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
jakarta.jms.JMSRuntimeException
jakarta.jms.MessageFormatRuntimeException
com.ibm.msg.client.jakarta.jms.DetailedMessageFormatRuntimeException
All Implemented Interfaces:
JmsExceptionDetail, Serializable
public class DetailedMessageFormatRuntimeException extends jakarta.jms.MessageFormatRuntimeException implements JmsExceptionDetail
DetailedMessageFormatRuntimeException is a subclass of MessageFormatRuntimeException that provides methods to get the message id, explanation, user action and inserts of the translatable message inside the JMSException. When the IBM MQ classes for JMS client throws a JMSRuntimeException, applications can downcast it to a DetailedJMSRuntimeException to get this extra information.
See Also:

  • Constructor Details

    • DetailedMessageFormatRuntimeException

      public DetailedMessageFormatRuntimeException()

  • Method Details

    • getExplanation

      public String getExplanation()
      Gets an explanation of the message in this exception. This may be null.
      Specified by:
      getExplanation in interface JmsExceptionDetail
      Returns:
      the explanation
      See Also:

    • getUserAction

      public String getUserAction()
      Gets a user response to the message in this exception. This may be null.
      Specified by:
      getUserAction in interface JmsExceptionDetail
      Returns:
      the user action
      See Also:

    • getValue

      public String getValue(String insertKey)
      Gets the message insert corresponding to a particular key for the translatable message in this exception. The key is a message insert constant or a property constant that is valid for this message. The valid keys for this message can be obtained using getKeys(). This method will return null if the key is not valid for this message.
      Specified by:
      getValue in interface JmsExceptionDetail
      Parameters:
      insertKey - a message insert constant or property constant valid for this message
      Returns:
      the insert
      See Also:

    • getKeys

      public Iterator<String> getKeys()
      Gets an iterator for all the message insert keys for the message in this exception. The keys are the property constants or message insert constants that are valid for this message. This enables applications to discover which keys are valid for this message.
      Specified by:
      getKeys in interface JmsExceptionDetail
      Returns:
      the iterator for the message insert keys
      See Also:

    • toString

      public String toString()
      Returns a short description of this exception
      Overrides:
      toString in class Throwable
      Returns:
      a String representation of the exception