Module jakarta.messaging

Package jakarta.jms

Class JMSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jakarta.jms.JMSException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IllegalStateException, InvalidClientIDException, InvalidDestinationException, InvalidSelectorException, JMSSecurityException, MessageEOFException, MessageFormatException, MessageNotReadableException, MessageNotWriteableException, ResourceAllocationException, TransactionInProgressException, TransactionRolledBackException

public class JMSException
extends Exception

This is the root class of all checked exceptions in the Jakarta Messaging API.

It provides the following information:

• A provider-specific string describing the error. This string is the standard exception message and is available via the getMessage method.
• A provider-specific string error code
• A reference to another exception. Often a Jakarta Messaging API exception will be the result of a lower-level problem. If appropriate, this lower-level exception can be linked to the Jakarta Messaging API exception.

Since:

JMS 1.0

Version:

Jakarta Messaging 2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JMSException(String reason)	Constructs a JMSException with the specified reason and with the error code defaulting to null.
JMSException(String reason, String errorCode)	Constructs a JMSException with the specified reason and error code.
JMSException(String reason, String errorCode, Exception linkedException)	Constructs a JMSException with the specified reason, error code and linked exception.

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Gets the vendor-specific error code.
Exception	getLinkedException()	Gets the exception linked to this one.
void	setLinkedException(Exception ex)	Adds a linked Exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JMSException

public JMSException(String reason,
                    String errorCode,
                    Exception linkedException)

Constructs a JMSException with the specified reason, error code and linked exception.

Parameters:

reason - a description of the exception

errorCode - a string specifying the vendor-specific error code

linkedException - the linked Exception

JMSException

public JMSException(String reason,
                    String errorCode)

Constructs a JMSException with the specified reason and error code.

Parameters:

reason - a description of the exception

errorCode - a string specifying the vendor-specific error code

JMSException

public JMSException(String reason)

Constructs a JMSException with the specified reason and with the error code defaulting to null.

Parameters:

reason - a description of the exception

Method Detail

getErrorCode

public String getErrorCode()

Gets the vendor-specific error code.

Returns:

a string specifying the vendor-specific error code

getLinkedException

public Exception getLinkedException()

Gets the exception linked to this one.

Returns:

the linked Exception, null if none

setLinkedException

public void setLinkedException(Exception ex)

Adds a linked Exception.

Parameters:

ex - the linked Exception