com.ibm.websphere.sib.exception

Class SIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.websphere.sib.exception.SIException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SIDataGraphException, SIIncorrectCallException, SIInvalidParameterException, SIMessageException, SINotPossibleInCurrentConfigurationException, SINotPossibleInCurrentStateException, SINotSupportedException, SIResourceException

public abstract class SIException
extends java.lang.Exception

SIException is the superclass of all SIBus Exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SIException() Construct a new SIException when no additional details can be provided
SIException(java.lang.String message) Constructor for when the Exception is to be thrown for a reason other than that an Exception has been caught during the copy.
SIException(java.lang.String message, java.lang.Throwable cause) Constructor for when the Exception is to be thrown because another Exception has been caught during the copy and additional information is to be included.
SIException(java.lang.Throwable cause) Constructor for when the Exception is to be thrown because another Exception has been caught during the copy.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getExceptionInserts() Returns an array of "exception inserts", which are used in conjunction with the exception reason to identify the reason that a message could not be delivered.
int	getExceptionReason() Returns an integer that indicates the reason a message could not be delivered.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

SIException

public SIException()

Construct a new SIException when no additional details can be provided

SIException

public SIException(java.lang.Throwable cause)

Constructor for when the Exception is to be thrown because another Exception has been caught during the copy.

Parameters:

cause - The original Throwable which has caused this to be thrown.

SIException

public SIException(java.lang.String message)

Constructor for when the Exception is to be thrown for a reason other than that an Exception has been caught during the copy.

Parameters:

message - A String giving information about the problem which caused this to be thrown.

SIException

public SIException(java.lang.String message,
           java.lang.Throwable cause)

Constructor for when the Exception is to be thrown because another Exception has been caught during the copy and additional information is to be included.

Parameters:

message - A String giving information about the problem which caused this to be thrown.

cause - The original Throwable which has caused this to be thrown.

Method Detail

getExceptionReason

public int getExceptionReason()

Returns an integer that indicates the reason a message could not be delivered. Some subclasses of SIException can indicate a failure to deliver a message (i.e. those thrown by SICoreConnection.createProducerSession and send). These subclasses will include a specific exception reason, chosen from those documented in com.ibm.websphere.sib.SIRCConstants, to indicate the reason that the message could not be delivered. All other exceptions will just return SIRC0001_DELIVERY_ERROR.

Returns:

the exception reason

getExceptionInserts

public java.lang.String[] getExceptionInserts()

Returns an array of "exception inserts", which are used in conjunction with the exception reason to identify the reason that a message could not be delivered. For example, if getExceptionReason returns a value of SIRC0003_DESTINATION_NOT_FOUND, the array will contain, as its only element, the name of the destination that could not be found. See getExceptionInserts() for further information.

Returns:

exception inserts

See Also:

getExceptionReason()