|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.internal.impl.PortletRequestDispatcherImpl
public class PortletRequestDispatcherImpl
Implementation of the PortletRequestDispatcher
interface.
The portlet request dispatcher is used to dispatch RenderRequest and
RenderResponse to a URI. Note that ActionRequest and ActionResponse
can never be dispatched.
Constructor Summary | |
---|---|
PortletRequestDispatcherImpl(javax.servlet.RequestDispatcher requestDispatcher)
Creates an instance. |
|
PortletRequestDispatcherImpl(javax.servlet.RequestDispatcher requestDispatcher,
String path)
Creates an instance. |
Method Summary | |
---|---|
void |
forward(PortletRequest request,
PortletResponse response)
Forwards a portlet request from a portlet to another resource (servlet, JSP file, or HTML file) on the server. |
void |
include(PortletRequest request,
PortletResponse response)
Includes the content of a resource (servlet, JSP page, HTML file) in the response. |
void |
include(RenderRequest request,
RenderResponse response)
Includes the content of a resource (servlet, JSP page, HTML file) in the response. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PortletRequestDispatcherImpl(javax.servlet.RequestDispatcher requestDispatcher)
requestDispatcher
- the servlet request dispatcher.PortletContext.getNamedDispatcher(String)
public PortletRequestDispatcherImpl(javax.servlet.RequestDispatcher requestDispatcher, String path)
requestDispatcher
- the servlet request dispatcher.queryString
- the included query string.PortletContext.getRequestDispatcher(String)
Method Detail |
---|
public void include(PortletRequest request, PortletResponse response) throws PortletException, IOException
PortletRequestDispatcher
The included servlet cannot set or change the response status code or set headers; any attempt to make a change is ignored.
include
in interface PortletRequestDispatcher
request
- a PortletRequest
object that contains the portlet
request. Must be either the original request passed to the
portlet or a wrapped version of this request.response
- a PortletResponse
object that contains the portlet
response. Must be either the portlet response passed to the
portlet or a wrapped version of this response.
PortletException
- if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
IOException
- if the included resource throws this exceptionpublic void include(RenderRequest request, RenderResponse response) throws PortletException, IOException
PortletRequestDispatcher
The included servlet cannot set or change the response status code or set headers; any attempt to make a change is ignored.
This method is kept in order to provide backward compatibility with
version 1.0. Please use PortletRequestDispatcher.include(PortletRequest, PortletResponse)
instead
of this method.
include
in interface PortletRequestDispatcher
request
- a RenderRequest
object that contains the client
request. Must be either the render request passed to the
portlet in render
or a wrapped version of this
render request.response
- a RenderResponse
object that contains the render
response. Must be either the render response passed to the
portlet in render
or a wrapped version of this
render response.
PortletException
- if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
IOException
- if the included resource throws this exceptionpublic void forward(PortletRequest request, PortletResponse response) throws PortletException, IOException, IllegalStateException
PortletRequestDispatcher
The forward
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
IllegalStateException
. Uncommitted output in the response buffer
is automatically cleared before the forward.
The request and response parameters must be either the same objects as were passed to the calling portletor be wrapped versions of these.
forward
in interface PortletRequestDispatcher
request
- a request object that represents the request to the
portletresponse
- a reponse object that contains the portlet response
PortletException
- if the included resource throws a ServletException, or
other exceptions that are not Runtime- or IOExceptions.
IOException
- if the included resource throws this exception
IllegalStateException
- if the response was already committed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |