/usr/share/doc/libservlet2.5-java/api/javax/servlet/UnavailableException.html is in libservlet2.5-java-doc 6.0.39-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Mon Feb 24 06:09:46 UTC 2014 -->
<title>UnavailableException (Tomcat API Documentation)</title>
<meta name="date" content="2014-02-24">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UnavailableException (Tomcat API Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../javax/servlet/SingleThreadModel.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/UnavailableException.html" target="_top">Frames</a></li>
<li><a href="UnavailableException.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">javax.servlet</div>
<h2 title="Class UnavailableException" class="title">Class UnavailableException</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><a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">javax.servlet.ServletException</a></li>
<li>
<ul class="inheritance">
<li>javax.servlet.UnavailableException</li>
</ul>
</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>
<hr>
<br>
<pre>public class <span class="strong">UnavailableException</span>
extends <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
<div class="block">Defines an exception that a servlet or filter throws to indicate
that it is permanently or temporarily unavailable.
<p>When a servlet or filter is permanently unavailable, something is wrong
with it, and it cannot handle
requests until some action is taken. For example, a servlet
might be configured incorrectly, or a filter's state may be corrupted.
The component should log both the error and the corrective action
that is needed.
<p>A servlet or filter is temporarily unavailable if it cannot handle
requests momentarily due to some system-wide problem. For example,
a third-tier server might not be accessible, or there may be
insufficient memory or disk storage to handle requests. A system
administrator may need to take corrective action.
<p>Servlet containers can safely treat both types of unavailable
exceptions in the same way. However, treating temporary unavailability
effectively makes the servlet container more robust. Specifically,
the servlet container might block requests to the servlet or filter for a period
of time suggested by the exception, rather than rejecting them until
the servlet container restarts.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Version$</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Various</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#javax.servlet.UnavailableException">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="overviewSummary" 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><strong><a href="../../javax/servlet/UnavailableException.html#UnavailableException(int, javax.servlet.Servlet, java.lang.String)">UnavailableException</a></strong>(int seconds,
<a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> servlet,
java.lang.String msg)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.2, use <a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String, int)"><code>UnavailableException(String, int)</code></a> instead.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../javax/servlet/UnavailableException.html#UnavailableException(javax.servlet.Servlet, java.lang.String)">UnavailableException</a></strong>(<a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> servlet,
java.lang.String msg)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.2, use <a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String)"><code>UnavailableException(String)</code></a> instead.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String)">UnavailableException</a></strong>(java.lang.String msg)</code>
<div class="block">Constructs a new exception with a descriptive
message indicating that the servlet is permanently
unavailable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String, int)">UnavailableException</a></strong>(java.lang.String msg,
int seconds)</code>
<div class="block">Constructs a new exception with a descriptive message
indicating that the servlet is temporarily unavailable
and giving an estimate of how long it will be unavailable.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/UnavailableException.html#getServlet()">getServlet</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>As of Java Servlet API 2.2, with no replacement.
Returns the servlet that is reporting its unavailability.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/UnavailableException.html#getUnavailableSeconds()">getUnavailableSeconds</a></strong>()</code>
<div class="block">Returns the number of seconds the servlet expects to
be temporarily unavailable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/UnavailableException.html#isPermanent()">isPermanent</a></strong>()</code>
<div class="block">Returns a <code>boolean</code> indicating
whether the servlet is permanently unavailable.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.servlet.ServletException">
<!-- -->
</a>
<h3>Methods inherited from class javax.servlet.<a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></h3>
<code><a href="../../javax/servlet/ServletException.html#getRootCause()">getRootCause</a></code></li>
</ul>
<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="UnavailableException(javax.servlet.Servlet, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnavailableException</h4>
<pre>public UnavailableException(<a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> servlet,
java.lang.String msg)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.2, use <a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String)"><code>UnavailableException(String)</code></a> instead.</i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>servlet</code> - the <code>Servlet</code> instance that is
unavailable</dd><dd><code>msg</code> - a <code>String</code> specifying the
descriptive message</dd></dl>
</li>
</ul>
<a name="UnavailableException(int, javax.servlet.Servlet, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnavailableException</h4>
<pre>public UnavailableException(int seconds,
<a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> servlet,
java.lang.String msg)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.2, use <a href="../../javax/servlet/UnavailableException.html#UnavailableException(java.lang.String, int)"><code>UnavailableException(String, int)</code></a> instead.</i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>seconds</code> - an integer specifying the number of seconds
the servlet expects to be unavailable; if
zero or negative, indicates that the servlet
can't make an estimate</dd><dd><code>servlet</code> - the <code>Servlet</code> that is unavailable</dd><dd><code>msg</code> - a <code>String</code> specifying the descriptive
message, which can be written to a log file or
displayed for the user.</dd></dl>
</li>
</ul>
<a name="UnavailableException(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnavailableException</h4>
<pre>public UnavailableException(java.lang.String msg)</pre>
<div class="block">Constructs a new exception with a descriptive
message indicating that the servlet is permanently
unavailable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - a <code>String</code> specifying the
descriptive message</dd></dl>
</li>
</ul>
<a name="UnavailableException(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UnavailableException</h4>
<pre>public UnavailableException(java.lang.String msg,
int seconds)</pre>
<div class="block">Constructs a new exception with a descriptive message
indicating that the servlet is temporarily unavailable
and giving an estimate of how long it will be unavailable.
<p>In some cases, the servlet cannot make an estimate. For
example, the servlet might know that a server it needs is
not running, but not be able to report how long it will take
to be restored to functionality. This can be indicated with
a negative or zero value for the <code>seconds</code> argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - a <code>String</code> specifying the
descriptive message, which can be written
to a log file or displayed for the user.</dd><dd><code>seconds</code> - an integer specifying the number of seconds
the servlet expects to be unavailable; if
zero or negative, indicates that the servlet
can't make an estimate</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="isPermanent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPermanent</h4>
<pre>public boolean isPermanent()</pre>
<div class="block">Returns a <code>boolean</code> indicating
whether the servlet is permanently unavailable.
If so, something is wrong with the servlet, and the
system administrator must take some corrective action.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the servlet is
permanently unavailable; <code>false</code>
if the servlet is available or temporarily
unavailable</dd></dl>
</li>
</ul>
<a name="getServlet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServlet</h4>
<pre>public <a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a> getServlet()</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>As of Java Servlet API 2.2, with no replacement.
Returns the servlet that is reporting its unavailability.</i></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>Servlet</code> object that is
throwing the <code>UnavailableException</code></dd></dl>
</li>
</ul>
<a name="getUnavailableSeconds()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUnavailableSeconds</h4>
<pre>public int getUnavailableSeconds()</pre>
<div class="block">Returns the number of seconds the servlet expects to
be temporarily unavailable.
<p>If this method returns a negative number, the servlet
is permanently unavailable or cannot provide an estimate of
how long it will be unavailable. No effort is
made to correct for the time elapsed since the exception was
first reported.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the number of seconds
the servlet will be temporarily unavailable,
or a negative number if the servlet is permanently
unavailable or cannot make an estimate</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../javax/servlet/SingleThreadModel.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/UnavailableException.html" target="_top">Frames</a></li>
<li><a href="UnavailableException.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 ======= -->
<p class="legalCopy"><small>Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|