01: /**
02: * Copyright 2003 IBM Corporation and Sun Microsystems, Inc.
03: * All rights reserved.
04: * Use is subject to license terms.
05: */package javax.portlet;
06:
07: /**
08: * The <code>PortletRequestDispatcher</code> interface
09: * defines an object that receives requests from the client
10: * and sends them to the specified resources (such as a servlet,
11: * HTML file, or JSP file) on the server. The portlet
12: * container creates the <code>PortletRequestDispatcher</code> object,
13: * which is used as a wrapper around a server resource located
14: * at a particular path or given by a particular name.
15: */
16:
17: public interface PortletRequestDispatcher {
18:
19: /**
20: * Includes the content of a resource (servlet, JSP page,
21: * HTML file) in the response. In essence, this method enables
22: * programmatic server-side includes.
23: * <p/>
24: * The included servlet cannot set or change the response status code
25: * or set headers; any attempt to make a change is ignored.
26: *
27: * @param request a {@link RenderRequest} object
28: * that contains the client request
29: * @param response a {@link RenderResponse} object
30: * that contains the render response
31: * @throws PortletException if the included resource throws a ServletException,
32: * or other exceptions that are not Runtime-
33: * or IOExceptions.
34: * @throws java.io.IOException if the included resource throws this exception
35: */
36:
37: public void include(RenderRequest request, RenderResponse response)
38: throws PortletException, java.io.IOException;
39:
40: }
|