com.ibm.msg.client.jms

Class DetailedMessageNotReadableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.jms.JMSException

javax.jms.MessageNotReadableException

com.ibm.msg.client.jms.DetailedMessageNotReadableException

All Implemented Interfaces:

JmsExceptionDetail, java.io.Serializable

public class DetailedMessageNotReadableException
extends javax.jms.MessageNotReadableException
implements JmsExceptionDetail

DetailedMessageNotReadableException is a subclass of MessageNotReadableException that provides methods to get the message id, explanation, user action and inserts of the translatable message inside the MessageNotReadableException. When the IBM MQ classes for JMS client throws a MessageNotReadableException, applications can cast it to a DetailedMessageNotReadableException to get this extra information.

NOTE One of the few exceptions that doesn't have a Runtime version

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetailedMessageNotReadableException()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExplanation() Gets an explanation of the message in this exception.
java.util.Iterator<java.lang.String>	getKeys() Gets an iterator for all the message insert keys for the message in this exception.
java.lang.String	getUserAction() Gets a user response to the message in this exception.
java.lang.String	getValue(java.lang.String insertKey) Gets the message insert corresponding to a particular key for the translatable message in this exception.
void	setLinkedException(java.lang.Exception ex) Adds a linked exception.
java.lang.String	toString() Returns a short description of this exception

Methods inherited from class javax.jms.JMSException

getErrorCode, getLinkedException

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DetailedMessageNotReadableException

public DetailedMessageNotReadableException()

Method Detail

getExplanation

public java.lang.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:

JmsExceptionDetail.getExplanation()

getUserAction

public java.lang.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:

JmsExceptionDetail.getUserAction()

getValue

public java.lang.String getValue(java.lang.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:

JmsExceptionDetail.getValue(java.lang.String)

getKeys

public java.util.Iterator<java.lang.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:

JmsExceptionDetail.getKeys()

setLinkedException

public void setLinkedException(java.lang.Exception ex)

Adds a linked exception.

Overrides:

setLinkedException in class javax.jms.JMSException

Parameters:

ex - the linked Exception

See Also:

JMSException.setLinkedException(java.lang.Exception)

toString

public java.lang.String toString()

Returns a short description of this exception

Overrides:

toString in class java.lang.Throwable

Returns:

a String representation of the exception