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:
18: public interface PortletRequestDispatcher {
19:
20: /**
21: *
22: * Includes the content of a resource (servlet, JSP page,
23: * HTML file) in the response. In essence, this method enables
24: * programmatic server-side includes.
25: * <p>
26: * The included servlet cannot set or change the response status code
27: * or set headers; any attempt to make a change is ignored.
28: *
29: *
30: * @param request a {@link RenderRequest} object
31: * that contains the client request
32: *
33: * @param response a {@link RenderResponse} object
34: * that contains the render response
35: *
36: * @exception PortletException if the included resource throws a ServletException,
37: * or other exceptions that are not Runtime-
38: * or IOExceptions.
39: *
40: * @exception java.io.IOException if the included resource throws this exception
41: *
42: *
43: */
44:
45: public void include(RenderRequest request, RenderResponse response)
46: throws PortletException, java.io.IOException;
47:
48: }
|