| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ServletException</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServletException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/servlet/ServletContextListener.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/ServletInputStream.html" title="class in jakarta.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/servlet/ServletException.html" target="_top">Frames</a></li> |
| <li><a href="ServletException.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.servlet</div> |
| <h2 title="Class ServletException" class="title">Class ServletException</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.servlet.ServletException</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/servlet/UnavailableException.html" title="class in jakarta.servlet">UnavailableException</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ServletException</span> |
| extends java.lang.Exception</pre> |
| <div class="block">Defines a general exception a servlet can throw when it encounters difficulty.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../serialized-form.html#jakarta.servlet.ServletException">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/security-custom-identitystore.html">security-custom-identitystore</a>, <a href="../../../../../tomee-9.0/examples/resources-declared-in-webapp.html">resources-declared-in-webapp</a>, <a href="../../../../../tomee-9.0/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/examples/moviefun.html">moviefun</a>, <a href="../../../../../tomee-9.0/examples/ejb-examples.html">ejb-examples</a>, <a href="../../../../../tomee-9.0/examples/cdi-session-scope.html">cdi-session-scope</a>, <a href="../../../../../tomee-9.0/examples/cdi-realm.html">cdi-realm</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/es/examples/polling-parent.html">polling-parent</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/pt/examples/cdi-session-scope.html">cdi-session-scope</a>, <a href="../../../../../tomee-9.0/pt/examples/cdi-realm.html">cdi-realm</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/servlet/ServletException.html#ServletException--">ServletException</a></span>()</code> |
| <div class="block">Constructs a new servlet exception.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletException.html#ServletException-java.lang.String-">ServletException</a></span>(java.lang.String message)</code> |
| <div class="block">Constructs a new servlet exception with the specified message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletException.html#ServletException-java.lang.String-java.lang.Throwable-">ServletException</a></span>(java.lang.String message, |
| java.lang.Throwable rootCause)</code> |
| <div class="block">Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root |
| cause" exception that interfered with its normal operation, including a description message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletException.html#ServletException-java.lang.Throwable-">ServletException</a></span>(java.lang.Throwable rootCause)</code> |
| <div class="block">Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root |
| cause" exception that interfered with its normal operation.</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></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.Throwable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/ServletException.html#getRootCause--">getRootCause</a></span>()</code> |
| <div class="block">Returns the exception that caused this servlet exception.</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, getMessage, 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="ServletException--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServletException</h4> |
| <pre>public ServletException()</pre> |
| <div class="block">Constructs a new servlet exception.</div> |
| </li> |
| </ul> |
| <a name="ServletException-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServletException</h4> |
| <pre>public ServletException(java.lang.String message)</pre> |
| <div class="block">Constructs a new servlet exception with the specified message. The message can be written to the server log and/or |
| displayed for the user.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - a <code>String</code> specifying the text of the exception message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ServletException-java.lang.String-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ServletException</h4> |
| <pre>public ServletException(java.lang.String message, |
| java.lang.Throwable rootCause)</pre> |
| <div class="block">Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root |
| cause" exception that interfered with its normal operation, including a description message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - a <code>String</code> containing the text of the exception message</dd> |
| <dd><code>rootCause</code> - the <code>Throwable</code> exception that interfered with the servlet's normal operation, making |
| this servlet exception necessary</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ServletException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServletException</h4> |
| <pre>public ServletException(java.lang.Throwable rootCause)</pre> |
| <div class="block">Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root |
| cause" exception that interfered with its normal operation. The exception's message is based on the localized message |
| of the underlying exception. |
| |
| <p> |
| This method calls the <code>getLocalizedMessage</code> method on the <code>Throwable</code> exception to get a |
| localized exception message. When subclassing <code>ServletException</code>, this method can be overridden to create |
| an exception message designed for a specific locale.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootCause</code> - the <code>Throwable</code> exception that interfered with the servlet's normal operation, making the |
| servlet exception necessary</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="getRootCause--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRootCause</h4> |
| <pre>public java.lang.Throwable getRootCause()</pre> |
| <div class="block">Returns the exception that caused this servlet exception.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Throwable</code> that caused this servlet exception</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/servlet/ServletContextListener.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/ServletInputStream.html" title="class in jakarta.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/servlet/ServletException.html" target="_top">Frames</a></li> |
| <li><a href="ServletException.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> |