View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  /*
17   * This source code implements specifications defined by the Java
18   * Community Process. In order to remain compliant with the specification
19   * DO NOT add / change / or delete method signatures!
20   */
21  package javax.portlet;
22  
23  
24  
25  /***
26   * The <code>PortletRequestDispatcher</code> interface 
27   * defines an object that receives requests from the client
28   * and sends them to the specified resources (such as a servlet,
29   * HTML file, or JSP file) on the server. The portlet
30   * container creates the <code>PortletRequestDispatcher</code> object,
31   * which is used as a wrapper around a server resource located
32   * at a particular path or given by a particular name.
33   *
34   */
35   
36  public interface PortletRequestDispatcher {
37  
38  
39      /***
40       *
41       * Includes the content of a resource (servlet, JSP page,
42       * HTML file) in the response. In essence, this method enables 
43       * programmatic server-side includes.
44       * <p>
45       * The included servlet cannot set or change the response status code
46       * or set headers; any attempt to make a change is ignored.
47       *
48       *
49       * @param request 			a {@link RenderRequest} object 
50       *					that contains the client request
51       *
52       * @param response 			a {@link RenderResponse} object 
53       * 					that contains the render response
54       *
55       * @exception PortletException 	if the included resource throws a ServletException, 
56       *                                  or other exceptions that are not Runtime-
57       *                                  or IOExceptions.
58       *
59       * @exception java.io.IOException	if the included resource throws this exception
60       *
61       *
62       */
63       
64      public void include(RenderRequest request, RenderResponse response)
65  	throws PortletException, java.io.IOException;
66  
67  
68  
69  }
70  
71  
72  
73  
74  
75  
76  
77