/usr/share/doc/libservlet3.0-java/api/javax/servlet/GenericServlet.html is in libservlet3.0-java-doc 7.0.78-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 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>GenericServlet (Tomcat API Documentation)</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="GenericServlet (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../javax/servlet/FilterRegistration.Dynamic.html" title="interface in javax.servlet"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/servlet/HttpConstraintElement.html" title="class in javax.servlet"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/GenericServlet.html" target="_top">Frames</a></li>
<li><a href="GenericServlet.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 GenericServlet" class="title">Class GenericServlet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.servlet.GenericServlet</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a>, <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../javax/servlet/http/HttpServlet.html" title="class in javax.servlet.http">HttpServlet</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">GenericServlet</span>
extends java.lang.Object
implements <a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a>, <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a>, java.io.Serializable</pre>
<div class="block">Defines a generic, protocol-independent servlet. To write an HTTP servlet for
use on the Web, extend <a href="../../javax/servlet/http/HttpServlet.html" title="class in javax.servlet.http"><code>HttpServlet</code></a> instead.
<p>
<code>GenericServlet</code> implements the <code>Servlet</code> and
<code>ServletConfig</code> interfaces. <code>GenericServlet</code> may be
directly extended by a servlet, although it's more common to extend a
protocol-specific subclass such as <code>HttpServlet</code>.
<p>
<code>GenericServlet</code> makes writing servlets easier. It provides simple
versions of the lifecycle methods <code>init</code> and <code>destroy</code>
and of the methods in the <code>ServletConfig</code> interface.
<code>GenericServlet</code> also implements the <code>log</code> method,
declared in the <code>ServletContext</code> interface.
<p>
To write a generic servlet, you need only override the abstract
<code>service</code> method.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#javax.servlet.GenericServlet">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="../../javax/servlet/GenericServlet.html#GenericServlet--">GenericServlet</a></span>()</code>
<div class="block">Does nothing.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#destroy--">destroy</a></span>()</code>
<div class="block">Called by the servlet container to indicate to a servlet that the servlet
is being taken out of service.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getInitParameter-java.lang.String-">getInitParameter</a></span>(java.lang.String name)</code>
<div class="block">Returns a <code>String</code> containing the value of the named
initialization parameter, or <code>null</code> if the parameter does not
exist.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Enumeration<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getInitParameterNames--">getInitParameterNames</a></span>()</code>
<div class="block">Returns the names of the servlet's initialization parameters as an
<code>Enumeration</code> of <code>String</code> objects, or an empty
<code>Enumeration</code> if the servlet has no initialization parameters.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getServletConfig--">getServletConfig</a></span>()</code>
<div class="block">Returns this servlet's <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getServletContext--">getServletContext</a></span>()</code>
<div class="block">Returns a reference to the <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a> in which this servlet
is running.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getServletInfo--">getServletInfo</a></span>()</code>
<div class="block">Returns information about the servlet, such as author, version, and
copyright.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#getServletName--">getServletName</a></span>()</code>
<div class="block">Returns the name of this servlet instance.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#init--">init</a></span>()</code>
<div class="block">A convenience method which can be overridden so that there's no need to
call <code>super.init(config)</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#init-javax.servlet.ServletConfig-">init</a></span>(<a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> config)</code>
<div class="block">Called by the servlet container to indicate to a servlet that the servlet
is being placed into service.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#log-java.lang.String-">log</a></span>(java.lang.String msg)</code>
<div class="block">Writes the specified message to a servlet log file, prepended by the
servlet's name.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#log-java.lang.String-java.lang.Throwable-">log</a></span>(java.lang.String message,
java.lang.Throwable t)</code>
<div class="block">Writes an explanatory message and a stack trace for a given
<code>Throwable</code> exception to the servlet log file, prepended by
the servlet's name.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/servlet/GenericServlet.html#service-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">service</a></span>(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> req,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> res)</code>
<div class="block">Called by the servlet container to allow the servlet to respond to a
request.</div>
</td>
</tr>
</table>
<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, toString, 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="GenericServlet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GenericServlet</h4>
<pre>public GenericServlet()</pre>
<div class="block">Does nothing. All of the servlet initialization is done by one of the
<code>init</code> methods.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public void destroy()</pre>
<div class="block">Called by the servlet container to indicate to a servlet that the servlet
is being taken out of service. See <a href="../../javax/servlet/Servlet.html#destroy--"><code>Servlet.destroy()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/Servlet.html#destroy--">destroy</a></code> in interface <code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></dd>
</dl>
</li>
</ul>
<a name="getInitParameter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameter</h4>
<pre>public java.lang.String getInitParameter(java.lang.String name)</pre>
<div class="block">Returns a <code>String</code> containing the value of the named
initialization parameter, or <code>null</code> if the parameter does not
exist. See <a href="../../javax/servlet/ServletConfig.html#getInitParameter-java.lang.String-"><code>ServletConfig.getInitParameter(java.lang.String)</code></a>.
<p>
This method is supplied for convenience. It gets the value of the named
parameter from the servlet's <code>ServletConfig</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/ServletConfig.html#getInitParameter-java.lang.String-">getInitParameter</a></code> in interface <code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a <code>String</code> specifying the name of the
initialization parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String a <code>String</code> containing the value of the
initialization parameter</dd>
</dl>
</li>
</ul>
<a name="getInitParameterNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitParameterNames</h4>
<pre>public java.util.Enumeration<java.lang.String> getInitParameterNames()</pre>
<div class="block">Returns the names of the servlet's initialization parameters as an
<code>Enumeration</code> of <code>String</code> objects, or an empty
<code>Enumeration</code> if the servlet has no initialization parameters.
See <a href="../../javax/servlet/ServletConfig.html#getInitParameterNames--"><code>ServletConfig.getInitParameterNames()</code></a>.
<p>
This method is supplied for convenience. It gets the parameter names from
the servlet's <code>ServletConfig</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/ServletConfig.html#getInitParameterNames--">getInitParameterNames</a></code> in interface <code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Enumeration an enumeration of <code>String</code> objects
containing the names of the servlet's initialization parameters</dd>
</dl>
</li>
</ul>
<a name="getServletConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletConfig</h4>
<pre>public <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> getServletConfig()</pre>
<div class="block">Returns this servlet's <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/Servlet.html#getServletConfig--">getServletConfig</a></code> in interface <code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServletConfig the <code>ServletConfig</code> object that
initialized this servlet</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/servlet/Servlet.html#init-javax.servlet.ServletConfig-"><code>Servlet.init(javax.servlet.ServletConfig)</code></a></dd>
</dl>
</li>
</ul>
<a name="getServletContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletContext</h4>
<pre>public <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> getServletContext()</pre>
<div class="block">Returns a reference to the <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a> in which this servlet
is running. See <a href="../../javax/servlet/ServletConfig.html#getServletContext--"><code>ServletConfig.getServletContext()</code></a>.
<p>
This method is supplied for convenience. It gets the context from the
servlet's <code>ServletConfig</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/ServletConfig.html#getServletContext--">getServletContext</a></code> in interface <code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ServletContext the <code>ServletContext</code> object passed to
this servlet by the <code>init</code> method</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a></dd>
</dl>
</li>
</ul>
<a name="getServletInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletInfo</h4>
<pre>public java.lang.String getServletInfo()</pre>
<div class="block">Returns information about the servlet, such as author, version, and
copyright. By default, this method returns an empty string. Override this
method to have it return a meaningful value. See
<a href="../../javax/servlet/Servlet.html#getServletInfo--"><code>Servlet.getServletInfo()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/Servlet.html#getServletInfo--">getServletInfo</a></code> in interface <code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String information about this servlet, by default an empty string</dd>
</dl>
</li>
</ul>
<a name="init-javax.servlet.ServletConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init(<a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> config)
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
<div class="block">Called by the servlet container to indicate to a servlet that the servlet
is being placed into service. See <a href="../../javax/servlet/Servlet.html#init-javax.servlet.ServletConfig-"><code>Servlet.init(javax.servlet.ServletConfig)</code></a>.
<p>
This implementation stores the <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object it receives
from the servlet container for later use. When overriding this form of
the method, call <code>super.init(config)</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/Servlet.html#init-javax.servlet.ServletConfig-">init</a></code> in interface <code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the <code>ServletConfig</code> object that contains
configuration information for this servlet</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code> - if an exception occurs that interrupts the servlet's
normal operation</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/servlet/UnavailableException.html" title="class in javax.servlet"><code>UnavailableException</code></a></dd>
</dl>
</li>
</ul>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init()
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
<div class="block">A convenience method which can be overridden so that there's no need to
call <code>super.init(config)</code>.
<p>
Instead of overriding <a href="../../javax/servlet/GenericServlet.html#init-javax.servlet.ServletConfig-"><code>init(ServletConfig)</code></a>, simply override this
method and it will be called by
<code>GenericServlet.init(ServletConfig config)</code>. The
<code>ServletConfig</code> object can still be retrieved via
<a href="../../javax/servlet/GenericServlet.html#getServletConfig--"><code>getServletConfig()</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code> - if an exception occurs that interrupts the servlet's
normal operation</dd>
</dl>
</li>
</ul>
<a name="log-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>public void log(java.lang.String msg)</pre>
<div class="block">Writes the specified message to a servlet log file, prepended by the
servlet's name. See <a href="../../javax/servlet/ServletContext.html#log-java.lang.String-"><code>ServletContext.log(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - a <code>String</code> specifying the message to be written to
the log file</dd>
</dl>
</li>
</ul>
<a name="log-java.lang.String-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>public void log(java.lang.String message,
java.lang.Throwable t)</pre>
<div class="block">Writes an explanatory message and a stack trace for a given
<code>Throwable</code> exception to the servlet log file, prepended by
the servlet's name. See <a href="../../javax/servlet/ServletContext.html#log-java.lang.String-java.lang.Throwable-"><code>ServletContext.log(String, Throwable)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a <code>String</code> that describes the error or exception</dd>
<dd><code>t</code> - the <code>java.lang.Throwable</code> error or exception</dd>
</dl>
</li>
</ul>
<a name="service-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>service</h4>
<pre>public abstract void service(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> req,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> res)
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
java.io.IOException</pre>
<div class="block">Called by the servlet container to allow the servlet to respond to a
request. See <a href="../../javax/servlet/Servlet.html#service-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</code></a>.
<p>
This method is declared abstract so subclasses, such as
<code>HttpServlet</code>, must override it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/Servlet.html#service-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">service</a></code> in interface <code><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet">Servlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - the <code>ServletRequest</code> object that contains the
client's request</dd>
<dd><code>res</code> - the <code>ServletResponse</code> object that will contain the
servlet's response</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code> - if an exception occurs that interferes with the servlet's
normal operation occurred</dd>
<dd><code>java.io.IOException</code> - if an input or output exception occurs</dd>
</dl>
</li>
</ul>
<a name="getServletName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServletName</h4>
<pre>public java.lang.String getServletName()</pre>
<div class="block">Returns the name of this servlet instance. See
<a href="../../javax/servlet/ServletConfig.html#getServletName--"><code>ServletConfig.getServletName()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../javax/servlet/ServletConfig.html#getServletName--">getServletName</a></code> in interface <code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of this servlet instance</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="../../javax/servlet/FilterRegistration.Dynamic.html" title="interface in javax.servlet"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/servlet/HttpConstraintElement.html" title="class in javax.servlet"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/GenericServlet.html" target="_top">Frames</a></li>
<li><a href="GenericServlet.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-2016 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|