/usr/share/doc/libservlet3.1-java/api/javax/servlet/RequestDispatcher.html is in libservlet3.1-java-doc 8.5.30-1ubuntu1.
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 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 | <!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>RequestDispatcher (Tomcat API Documentation)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RequestDispatcher (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= 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/Registration.Dynamic.html" title="interface in javax.servlet"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/RequestDispatcher.html" target="_top">Frames</a></li>
<li><a href="RequestDispatcher.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>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../javax/servlet/package-summary.html">javax.servlet</a></div>
<h2 title="Interface RequestDispatcher" class="title">Interface RequestDispatcher</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">RequestDispatcher</span></pre>
<div class="block">Defines an object that receives requests from the client and sends them to
any resource (such as a servlet, HTML file, or JSP file) on the server. The
servlet container creates the <code>RequestDispatcher</code> object, which is
used as a wrapper around a server resource located at a particular path or
given by a particular name.
<p>
This interface is intended to wrap servlets, but a servlet container can
create <code>RequestDispatcher</code> objects to wrap any type of resource.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/servlet/ServletContext.html#getRequestDispatcher-java.lang.String-"><code>ServletContext.getRequestDispatcher(java.lang.String)</code></a>,
<a href="../../javax/servlet/ServletContext.html#getNamedDispatcher-java.lang.String-"><code>ServletContext.getNamedDispatcher(java.lang.String)</code></a>,
<a href="../../javax/servlet/ServletRequest.html#getRequestDispatcher-java.lang.String-"><code>ServletRequest.getRequestDispatcher(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_EXCEPTION">ERROR_EXCEPTION</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_EXCEPTION_TYPE">ERROR_EXCEPTION_TYPE</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_MESSAGE">ERROR_MESSAGE</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_REQUEST_URI">ERROR_REQUEST_URI</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_SERVLET_NAME">ERROR_SERVLET_NAME</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#ERROR_STATUS_CODE">ERROR_STATUS_CODE</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#FORWARD_CONTEXT_PATH">FORWARD_CONTEXT_PATH</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#FORWARD_PATH_INFO">FORWARD_PATH_INFO</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#FORWARD_QUERY_STRING">FORWARD_QUERY_STRING</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#FORWARD_REQUEST_URI">FORWARD_REQUEST_URI</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#FORWARD_SERVLET_PATH">FORWARD_SERVLET_PATH</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#INCLUDE_CONTEXT_PATH">INCLUDE_CONTEXT_PATH</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#INCLUDE_PATH_INFO">INCLUDE_PATH_INFO</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#INCLUDE_QUERY_STRING">INCLUDE_QUERY_STRING</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#INCLUDE_REQUEST_URI">INCLUDE_REQUEST_URI</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#INCLUDE_SERVLET_PATH">INCLUDE_SERVLET_PATH</a></span></code></th>
<td class="colLast">
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name.</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" 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></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">forward</a></span>​(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)</code></th>
<td class="colLast">
<div class="block">Forwards a request from a servlet to another resource (servlet, JSP file,
or HTML file) on the server.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">include</a></span>​(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)</code></th>
<td class="colLast">
<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the
response.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="FORWARD_REQUEST_URI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORWARD_REQUEST_URI</h4>
<pre>static final java.lang.String FORWARD_REQUEST_URI</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called. It provides the original value of a path-related property of the
request. See the chapter "Forwarded Request Parameters" in the Servlet
Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_REQUEST_URI">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FORWARD_CONTEXT_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORWARD_CONTEXT_PATH</h4>
<pre>static final java.lang.String FORWARD_CONTEXT_PATH</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called. It provides the original value of a path-related property of the
request. See the chapter "Forwarded Request Parameters" in the Servlet
Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_CONTEXT_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FORWARD_PATH_INFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORWARD_PATH_INFO</h4>
<pre>static final java.lang.String FORWARD_PATH_INFO</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called. It provides the original value of a path-related property of the
request. See the chapter "Forwarded Request Parameters" in the Servlet
Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_PATH_INFO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FORWARD_SERVLET_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORWARD_SERVLET_PATH</h4>
<pre>static final java.lang.String FORWARD_SERVLET_PATH</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called. It provides the original value of a path-related property of the
request. See the chapter "Forwarded Request Parameters" in the Servlet
Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_SERVLET_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FORWARD_QUERY_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FORWARD_QUERY_STRING</h4>
<pre>static final java.lang.String FORWARD_QUERY_STRING</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>forward(ServletRequest, ServletResponse)</code></a> method is
called. It provides the original value of a path-related property of the
request. See the chapter "Forwarded Request Parameters" in the Servlet
Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_QUERY_STRING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INCLUDE_REQUEST_URI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_REQUEST_URI</h4>
<pre>static final java.lang.String INCLUDE_REQUEST_URI</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name. It provides information on the path that was used to obtain the
<code>RequestDispatcher</code> instance for this include call. See the chapter
"Included Request Parameters" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_REQUEST_URI">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INCLUDE_CONTEXT_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_CONTEXT_PATH</h4>
<pre>static final java.lang.String INCLUDE_CONTEXT_PATH</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name. It provides information on the path that was used to obtain the
<code>RequestDispatcher</code> instance for this include call. See the chapter
"Included Request Parameters" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_CONTEXT_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INCLUDE_PATH_INFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_PATH_INFO</h4>
<pre>static final java.lang.String INCLUDE_PATH_INFO</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name. It provides information on the path that was used to obtain the
<code>RequestDispatcher</code> instance for this include call. See the chapter
"Included Request Parameters" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_PATH_INFO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INCLUDE_SERVLET_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_SERVLET_PATH</h4>
<pre>static final java.lang.String INCLUDE_SERVLET_PATH</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name. It provides information on the path that was used to obtain the
<code>RequestDispatcher</code> instance for this include call. See the chapter
"Included Request Parameters" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_SERVLET_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INCLUDE_QUERY_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_QUERY_STRING</h4>
<pre>static final java.lang.String INCLUDE_QUERY_STRING</pre>
<div class="block">The name of the request attribute that should be set by the container
when the <a href="../../javax/servlet/RequestDispatcher.html#include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>include(ServletRequest, ServletResponse)</code></a> method is
called on the <code>RequestDispatcher</code> obtained by a path and not by a
name. It provides information on the path that was used to obtain the
<code>RequestDispatcher</code> instance for this include call. See the chapter
"Included Request Parameters" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_QUERY_STRING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_EXCEPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_EXCEPTION</h4>
<pre>static final java.lang.String ERROR_EXCEPTION</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.Throwable</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_EXCEPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_EXCEPTION_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_EXCEPTION_TYPE</h4>
<pre>static final java.lang.String ERROR_EXCEPTION_TYPE</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.Class</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_EXCEPTION_TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_MESSAGE</h4>
<pre>static final java.lang.String ERROR_MESSAGE</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.String</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_MESSAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_REQUEST_URI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_REQUEST_URI</h4>
<pre>static final java.lang.String ERROR_REQUEST_URI</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.String</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_REQUEST_URI">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_SERVLET_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_SERVLET_NAME</h4>
<pre>static final java.lang.String ERROR_SERVLET_NAME</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.String</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_SERVLET_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_STATUS_CODE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ERROR_STATUS_CODE</h4>
<pre>static final java.lang.String ERROR_STATUS_CODE</pre>
<div class="block">The name of the request attribute that should be set by the container
when custom error-handling servlet or JSP page is invoked. The value of
the attribute is of type <code>java.lang.Integer</code>. See the chapter
"Error Handling" in the Servlet Specification for details.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Servlet 3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_STATUS_CODE">Constant Field Values</a></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="forward-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forward</h4>
<pre>void forward​(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
java.io.IOException</pre>
<div class="block">Forwards a request from a servlet to another resource (servlet, JSP file,
or HTML file) on the server. This method allows one servlet to do
preliminary processing of a request and another resource to generate the
response.
<p>
For a <code>RequestDispatcher</code> obtained via
<code>getRequestDispatcher()</code>, the <code>ServletRequest</code>
object has its path elements and parameters adjusted to match the path of
the target resource.
<p>
<code>forward</code> should be called before the response has been
committed to the client (before response body output has been flushed).
If the response already has been committed, this method throws an
<code>IllegalStateException</code>. Uncommitted output in the response
buffer is automatically cleared before the forward.
<p>
The request and response parameters must be either the same objects as
were passed to the calling servlet's service method or be subclasses of
the <a href="../../javax/servlet/ServletRequestWrapper.html" title="class in javax.servlet"><code>ServletRequestWrapper</code></a> or <a href="../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet"><code>ServletResponseWrapper</code></a>
classes that wrap them.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - a <a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet"><code>ServletRequest</code></a> object that represents the request
the client makes of the servlet</dd>
<dd><code>response</code> - a <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object that represents the response
the servlet returns to the client</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 the target resource throws this exception</dd>
<dd><code>java.io.IOException</code> - if the target resource throws this exception</dd>
<dd><code>java.lang.IllegalStateException</code> - if the response was already committed</dd>
</dl>
</li>
</ul>
<a name="include-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>include</h4>
<pre>void include​(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
<a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)
throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
java.io.IOException</pre>
<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the
response. In essence, this method enables programmatic server-side
includes.
<p>
The <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object has its path elements and parameters
remain unchanged from the caller's. The included servlet cannot change
the response status code or set headers; any attempt to make a change is
ignored.
<p>
The request and response parameters must be either the same objects as
were passed to the calling servlet's service method or be subclasses of
the <a href="../../javax/servlet/ServletRequestWrapper.html" title="class in javax.servlet"><code>ServletRequestWrapper</code></a> or <a href="../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet"><code>ServletResponseWrapper</code></a>
classes that wrap them.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - a <a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet"><code>ServletRequest</code></a> object that contains the client's
request</dd>
<dd><code>response</code> - a <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object that contains 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 the included resource throws this exception</dd>
<dd><code>java.io.IOException</code> - if the included resource throws this 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="../../javax/servlet/Registration.Dynamic.html" title="interface in javax.servlet"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/servlet/RequestDispatcher.html" target="_top">Frames</a></li>
<li><a href="RequestDispatcher.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </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 The Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|