KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > portlet > PortletRequestDispatcher


1 /**
2   * Copyright 2003 IBM Corporation and Sun Microsystems, Inc.
3   * All rights reserved.
4   * Use is subject to license terms.
5   */
6
7 package javax.portlet;
8
9
10
11 /**
12  * The <code>PortletRequestDispatcher</code> interface
13  * defines an object that receives requests from the client
14  * and sends them to the specified resources (such as a servlet,
15  * HTML file, or JSP file) on the server. The portlet
16  * container creates the <code>PortletRequestDispatcher</code> object,
17  * which is used as a wrapper around a server resource located
18  * at a particular path or given by a particular name.
19  *
20  */
21  
22 public interface PortletRequestDispatcher {
23
24     /**
25      *
26      * Includes the content of a resource (servlet, JSP page,
27      * HTML file) in the response. In essence, this method enables
28      * programmatic server-side includes.
29      * <p>
30      * The included servlet cannot set or change the response status code
31      * or set headers; any attempt to make a change is ignored.
32      *
33      *
34      * @param request a {@link RenderRequest} object
35      * that contains the client request
36      *
37      * @param response a {@link RenderResponse} object
38      * that contains the render response
39      *
40      * @exception PortletException if the included resource throws a ServletException,
41      * or other exceptions that are not Runtime-
42      * or IOExceptions.
43      *
44      * @exception java.io.IOException if the included resource throws this exception
45      *
46      *
47      */
48      
49     public void include(RenderRequest request, RenderResponse response)
50     throws PortletException, java.io.IOException JavaDoc;
51
52
53
54 }
55
56
57
58
59
60
61
62
63
Popular Tags