| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ResourceException</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ResourceException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":42}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/resource/Referenceable.html" title="interface in jakarta.resource"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/resource/ResourceException.html" target="_top">Frames</a></li> |
| <li><a href="ResourceException.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.resource</div> |
| <h2 title="Class ResourceException" class="title">Class ResourceException</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Throwable</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Exception</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.resource.ResourceException</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../jakarta/resource/spi/ApplicationServerInternalException.html" title="class in jakarta.resource.spi">ApplicationServerInternalException</a>, <a href="../../jakarta/resource/spi/CommException.html" title="class in jakarta.resource.spi">CommException</a>, <a href="../../jakarta/resource/spi/EISSystemException.html" title="class in jakarta.resource.spi">EISSystemException</a>, <a href="../../jakarta/resource/spi/IllegalStateException.html" title="class in jakarta.resource.spi">IllegalStateException</a>, <a href="../../jakarta/resource/spi/InvalidPropertyException.html" title="class in jakarta.resource.spi">InvalidPropertyException</a>, <a href="../../jakarta/resource/spi/LocalTransactionException.html" title="class in jakarta.resource.spi">LocalTransactionException</a>, <a href="../../jakarta/resource/NotSupportedException.html" title="class in jakarta.resource">NotSupportedException</a>, <a href="../../jakarta/resource/spi/ResourceAdapterInternalException.html" title="class in jakarta.resource.spi">ResourceAdapterInternalException</a>, <a href="../../jakarta/resource/spi/ResourceAllocationException.html" title="class in jakarta.resource.spi">ResourceAllocationException</a>, <a href="../../jakarta/resource/cci/ResourceWarning.html" title="class in jakarta.resource.cci">ResourceWarning</a>, <a href="../../jakarta/resource/spi/SecurityException.html" title="class in jakarta.resource.spi">SecurityException</a>, <a href="../../jakarta/resource/spi/SharingViolationException.html" title="class in jakarta.resource.spi">SharingViolationException</a>, <a href="../../jakarta/resource/spi/UnavailableException.html" title="class in jakarta.resource.spi">UnavailableException</a>, <a href="../../jakarta/resource/spi/work/WorkException.html" title="class in jakarta.resource.spi.work">WorkException</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ResourceException</span> |
| extends java.lang.Exception</pre> |
| <div class="block">This is the root interface of the exception hierarchy defined |
| for Jakarta™ Connectors. |
| |
| The ResourceException provides the following information: |
| <UL> |
| <LI> A resource adapter vendor specific string describing the error. |
| This string is a standard Java exception message and is available |
| through getMessage() method. |
| <LI> resource adapter vendor specific error code. |
| <LI> reference to another exception. Often a resource exception |
| will be result of a lower level problem. If appropriate, this |
| lower level exception can be linked to the ResourceException. |
| Note, this has been deprecated in favor of J2SE release 1.4 exception |
| chaining facility. |
| </UL></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../serialized-form.html#jakarta.resource.ResourceException">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#ResourceException--">ResourceException</a></span>()</code> |
| <div class="block">Constructs a new instance with null as its detail message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#ResourceException-java.lang.String-">ResourceException</a></span>(java.lang.String message)</code> |
| <div class="block">Constructs a new instance with the specified detail message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#ResourceException-java.lang.String-java.lang.String-">ResourceException</a></span>(java.lang.String message, |
| java.lang.String errorCode)</code> |
| <div class="block">Create a new throwable with the specified message and error code.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#ResourceException-java.lang.String-java.lang.Throwable-">ResourceException</a></span>(java.lang.String message, |
| java.lang.Throwable cause)</code> |
| <div class="block">Constructs a new throwable with the specified detail message and cause.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#ResourceException-java.lang.Throwable-">ResourceException</a></span>(java.lang.Throwable cause)</code> |
| <div class="block">Constructs a new throwable with the specified cause.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#getErrorCode--">getErrorCode</a></span>()</code> |
| <div class="block">Get the error code.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Exception</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#getLinkedException--">getLinkedException</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">J2SE release 1.4 supports a chained exception facility |
| that allows any throwable to know about another throwable, if any, |
| that caused it to get thrown. Refer to <code>getCause</code> and |
| <code>initCause</code> methods of the |
| <code>java.lang.Throwable</code> class..</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#getMessage--">getMessage</a></span>()</code> |
| <div class="block">Returns a detailed message string describing this exception.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#setErrorCode-java.lang.String-">setErrorCode</a></span>(java.lang.String errorCode)</code> |
| <div class="block">Set the error code.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/resource/ResourceException.html#setLinkedException-java.lang.Exception-">setLinkedException</a></span>(java.lang.Exception ex)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">J2SE release 1.4 supports a chained exception facility |
| that allows any throwable to know about another throwable, if any, |
| that caused it to get thrown. Refer to <code>getCause</code> and |
| <code>initCause</code> methods of the |
| <code>java.lang.Throwable</code> class.</span></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Throwable</h3> |
| <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ResourceException--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ResourceException</h4> |
| <pre>public ResourceException()</pre> |
| <div class="block">Constructs a new instance with null as its detail message.</div> |
| </li> |
| </ul> |
| <a name="ResourceException-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ResourceException</h4> |
| <pre>public ResourceException(java.lang.String message)</pre> |
| <div class="block">Constructs a new instance with the specified detail message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the detail message.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ResourceException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ResourceException</h4> |
| <pre>public ResourceException(java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a new throwable with the specified cause.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - a chained exception of type <code>Throwable</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ResourceException-java.lang.String-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ResourceException</h4> |
| <pre>public ResourceException(java.lang.String message, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Constructs a new throwable with the specified detail message and cause.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the detail message.</dd> |
| <dd><code>cause</code> - a chained exception of type <code>Throwable</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ResourceException-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ResourceException</h4> |
| <pre>public ResourceException(java.lang.String message, |
| java.lang.String errorCode)</pre> |
| <div class="block">Create a new throwable with the specified message and error code.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - a description of the exception.</dd> |
| <dd><code>errorCode</code> - a string specifying the vendor specific error code.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setErrorCode-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setErrorCode</h4> |
| <pre>public void setErrorCode(java.lang.String errorCode)</pre> |
| <div class="block">Set the error code.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>errorCode</code> - the error code.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getErrorCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErrorCode</h4> |
| <pre>public java.lang.String getErrorCode()</pre> |
| <div class="block">Get the error code.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the error code.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLinkedException--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedException</h4> |
| <pre>public java.lang.Exception getLinkedException()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">J2SE release 1.4 supports a chained exception facility |
| that allows any throwable to know about another throwable, if any, |
| that caused it to get thrown. Refer to <code>getCause</code> and |
| <code>initCause</code> methods of the |
| <code>java.lang.Throwable</code> class..</span></div> |
| <div class="block">Get the exception linked to this ResourceException</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>linked Exception, null if none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLinkedException-java.lang.Exception-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkedException</h4> |
| <pre>public void setLinkedException(java.lang.Exception ex)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">J2SE release 1.4 supports a chained exception facility |
| that allows any throwable to know about another throwable, if any, |
| that caused it to get thrown. Refer to <code>getCause</code> and |
| <code>initCause</code> methods of the |
| <code>java.lang.Throwable</code> class.</span></div> |
| <div class="block">Add a linked Exception to this ResourceException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ex</code> - linked Exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre>public java.lang.String getMessage()</pre> |
| <div class="block">Returns a detailed message string describing this exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getMessage</code> in class <code>java.lang.Throwable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a detailed message string.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/resource/Referenceable.html" title="interface in jakarta.resource"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/resource/ResourceException.html" target="_top">Frames</a></li> |
| <li><a href="ResourceException.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
