javax.resource

Class ResourceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.resource.ResourceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationServerInternalException, CommException, EISSystemException, IllegalStateException, InvalidPropertyException, LocalTransactionException, NotSupportedException, ResourceAdapterInternalException, ResourceAllocationException, ResourceWarning, SecurityException, SharingViolationException, UnavailableException, WorkException

public class ResourceException
extends Exception

This is the root exception for the exception hierarchy defined for the connector architecture. A ResourceException contains three items, the first two of which are set from the constructor. The first is a standard message string which is accessed via the getMessage() method. The second is an errorCode which is accessed via the getErrorCode() method. The third is a linked exception which provides more information from a lower level in the resource manager. Linked exceptions are accessed via get/setLinkedException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceException() Create an exception with a null reason.
ResourceException(String reason) Create an exception with a reason.
ResourceException(String reason, String errorCode) Create an exception with a reason and an errorCode.
ResourceException(String reason, Throwable throwable) Create an exception with a reason and an errorCode.
ResourceException(Throwable throwable) Create an exception with a reason and an errorCode.

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorCode() Get the error code.
Exception	getLinkedException() Get any linked exception.
String	getMessage() Get the message composed of the reason and error code.
void	setErrorCode(String errorCode) Set the error code.
void	setLinkedException(Exception linkedException) Deprecated. use initCause

Methods inherited from class java.lang.Throwable

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

ResourceException

public ResourceException()

Create an exception with a null reason.

ResourceException

public ResourceException(String reason)

Create an exception with a reason.

Parameters:

reason - the reason

ResourceException

public ResourceException(String reason,
                 String errorCode)

Create an exception with a reason and an errorCode.

Parameters:

reason - the reason

errorCode - the error code

ResourceException

public ResourceException(String reason,
                 Throwable throwable)

Create an exception with a reason and an errorCode.

Parameters:

reason - the reason

throwable - the linked error

ResourceException

public ResourceException(Throwable throwable)

Create an exception with a reason and an errorCode.

Parameters:

throwable - the linked error

Method Detail

getErrorCode

public String getErrorCode()

Get the error code.

Returns:

the error code

getLinkedException

public Exception getLinkedException()

Get any linked exception.

Returns:

the linked exception

getMessage

public String getMessage()

Get the message composed of the reason and error code.

Overrides:

getMessage in class Throwable

Returns:

message composed of the reason and error code.

setErrorCode

public void setErrorCode(String errorCode)

Set the error code.

Parameters:

errorCode - code the error code

setLinkedException

public void setLinkedException(Exception linkedException)

Deprecated. use initCause

Set a linked exception.

Parameters:

linkedException - the linked exception