/usr/share/doc/libservlet2.5-java/api/javax/servlet/RequestDispatcher.html is in libservlet2.5-java-doc 6.0.45+dfsg-1~deb8u1.
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 | <!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_91) on Fri Apr 01 14:23:31 UTC 2016 -->
<title>RequestDispatcher (Tomcat API Documentation)</title>
<meta name="date" content="2016-04-01">
<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="RequestDispatcher (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/GenericServlet.html" title="class in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="strong">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>
<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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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 ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.servlet</div>
<h2 title="Interface RequestDispatcher" class="title">Interface RequestDispatcher</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">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="strong">Author:</span></dt>
<dd>Various</dd>
<dt><span class="strong">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">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest,%20javax.servlet.ServletResponse)">forward</a></strong>(<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>
<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 class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest,%20javax.servlet.ServletResponse)">include</a></strong>(<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>
<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">
<!-- ============ 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="strong">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="strong">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="strong">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="strong">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><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/GenericServlet.html" title="class in javax.servlet"><span class="strong">Prev Class</span></a></li>
<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="strong">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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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-2008 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|