/usr/share/doc/libportlet-api-2.0-spec-java/api/javax/portlet/PortletRequestDispatcher.html is in libportlet-api-2.0-spec-java-doc 1.0-2.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Sun Jun 27 09:02:35 UTC 2010 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PortletRequestDispatcher (Java Portlet Specification V2.0 1.0 API)
</TITLE>
<META NAME="date" CONTENT="2010-06-27">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PortletRequestDispatcher (Java Portlet Specification V2.0 1.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletRequestDispatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletRequestDispatcher.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletRequestDispatcher.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.portlet</FONT>
<BR>
Interface PortletRequestDispatcher</H2>
<HR>
<DL>
<DT><PRE>public interface <B>PortletRequestDispatcher</B></DL>
</PRE>
<P>
The <code>PortletRequestDispatcher</code> interface defines an object that
receives requests from the client and sends them to the specified resources
(such as a servlet, HTML file, or JSP file) on the server. The portlet
container creates the <code>PortletRequestDispatcher</code> object, which
is used as a wrapper around a server resource located at a particular path or
given by a particular name.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletRequestDispatcher.html#forward(javax.portlet.PortletRequest, javax.portlet.PortletResponse)">forward</A></B>(<A HREF="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A> request,
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A> response)</CODE>
<BR>
Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file)
on the server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.PortletRequest, javax.portlet.PortletResponse)">include</A></B>(<A HREF="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A> request,
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A> response)</CODE>
<BR>
Includes the content of a resource (servlet, JSP page, HTML file) in the
response.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">include</A></B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A> request,
<A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A> response)</CODE>
<BR>
Includes the content of a resource (servlet, JSP page, HTML file) in the
response.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="include(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
include</H3>
<PRE>
void <B>include</B>(<A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet">RenderRequest</A> request,
<A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet">RenderResponse</A> response)
throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
java.io.IOException</PRE>
<DL>
<DD>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 included servlet cannot set or change the response status code or set
headers; any attempt to make a change is ignored.
<p>
This method is kept in order to provide backward compatibility with
version 1.0. Please use <A HREF="../../javax/portlet/PortletRequestDispatcher.html#include(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"><CODE>include(PortletRequest, PortletResponse)</CODE></A> instead
of this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - a <A HREF="../../javax/portlet/RenderRequest.html" title="interface in javax.portlet"><CODE>RenderRequest</CODE></A> object that contains the client
request. Must be either the render request passed to the
portlet in <code>render</code> or a wrapped version of this
render request.<DD><CODE>response</CODE> - a <A HREF="../../javax/portlet/RenderResponse.html" title="interface in javax.portlet"><CODE>RenderResponse</CODE></A> object that contains the render
response. Must be either the render response passed to the
portlet in <code>render</code> or a wrapped version of this
render response.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
<DD><CODE>java.io.IOException</CODE> - if the included resource throws this exception</DL>
</DD>
</DL>
<HR>
<A NAME="include(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"><!-- --></A><H3>
include</H3>
<PRE>
void <B>include</B>(<A HREF="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A> request,
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A> response)
throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
java.io.IOException</PRE>
<DL>
<DD>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 included servlet cannot set or change the response status code or set
headers; any attempt to make a change is ignored.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - a <A HREF="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet"><CODE>PortletRequest</CODE></A> object that contains the portlet
request. Must be either the original request passed to the
portlet or a wrapped version of this request.<DD><CODE>response</CODE> - a <A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><CODE>PortletResponse</CODE></A> object that contains the portlet
response. Must be either the portlet response passed to the
portlet or a wrapped version of this response.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
<DD><CODE>java.io.IOException</CODE> - if the included resource throws this exception<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="forward(javax.portlet.PortletRequest, javax.portlet.PortletResponse)"><!-- --></A><H3>
forward</H3>
<PRE>
void <B>forward</B>(<A HREF="../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A> request,
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A> response)
throws <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A>,
java.io.IOException</PRE>
<DL>
<DD>Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file)
on the server. This method allows the portlet to do preliminary processing of a
request and another resource to generate the response.
<p>
The <code>forward</code> method should be called before the response has been
committed to the portlet container (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 portlet or be wrapped versions of these.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - a request object that represents the request to the
portlet<DD><CODE>response</CODE> - a reponse object that contains the portlet response
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></CODE> - if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
<DD><CODE>java.io.IOException</CODE> - if the included resource throws this exception
<DD><CODE>java.lang.IllegalStateException</CODE> - if the response was already committed<DT><B>Since:</B></DT>
<DD>2.0</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PortletRequestDispatcher.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/portlet/PortletRequest.P3PUserInfos.html" title="enum in javax.portlet"><B>PREV CLASS</B></A>
<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/portlet/PortletRequestDispatcher.html" target="_top"><B>FRAMES</B></A>
<A HREF="PortletRequestDispatcher.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2010. All Rights Reserved.
</BODY>
</HTML>
|