View Javadoc

1   /**
2    *
3    * Copyright 2003-2004 The Apache Software Foundation
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  //
19  // This source code implements specifications defined by the Java
20  // Community Process. In order to remain compliant with the specification
21  // DO NOT add / change / or delete method signatures!
22  //
23  
24  package javax.servlet.jsp;
25  
26  import javax.servlet.*;
27  import javax.servlet.http.*;
28  import java.io.IOException;
29  
30  /**
31   * The HttpJspPage interface describes the interaction that a JSP Page
32   * Implementation Class must satisfy when using the HTTP protocol.
33   *
34   * <p>
35   * The behaviour is identical to that of the JspPage, except for the signature
36   * of the _jspService method, which is now expressible in the Java type
37   * system and included explicitly in the interface.
38   * 
39   * @see JspPage
40   */
41  
42  public interface HttpJspPage extends JspPage {
43  
44      /** The _jspService()method corresponds to the body of the JSP page. This
45       * method is defined automatically by the JSP container and should never
46       * be defined by the JSP page author.
47       * <p>
48       * If a superclass is specified using the extends attribute, that
49       * superclass may choose to perform some actions in its service() method
50       * before or after calling the _jspService() method.  See using the extends
51       * attribute in the JSP_Engine chapter of the JSP specification.
52       *
53       * @param request Provides client request information to the JSP.
54       * @param response Assists the JSP in sending a response to the client.
55       * @throws ServletException Thrown if an error occurred during the 
56       *     processing of the JSP and that the container should take 
57       *     appropriate action to clean up the request.
58       * @throws IOException Thrown if an error occurred while writing the
59       *     response for this page.
60       */
61      public void _jspService(HttpServletRequest request,
62                              HttpServletResponse response)
63         throws ServletException, IOException;
64  }