001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * Portions Copyright Apache Software Foundation.
007: *
008: * The contents of this file are subject to the terms of either the GNU
009: * General Public License Version 2 only ("GPL") or the Common Development
010: * and Distribution License("CDDL") (collectively, the "License"). You
011: * may not use this file except in compliance with the License. You can obtain
012: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
013: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
014: * language governing permissions and limitations under the License.
015: *
016: * When distributing the software, include this License Header Notice in each
017: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
018: * Sun designates this particular file as subject to the "Classpath" exception
019: * as provided by Sun in the GPL Version 2 section of the License file that
020: * accompanied this code. If applicable, add the following below the License
021: * Header, with the fields enclosed by brackets [] replaced by your own
022: * identifying information: "Portions Copyrighted [year]
023: * [name of copyright owner]"
024: *
025: * Contributor(s):
026: *
027: * If you wish your version of this file to be governed by only the CDDL or
028: * only the GPL Version 2, indicate your decision by adding "[Contributor]
029: * elects to include this software in this distribution under the [CDDL or GPL
030: * Version 2] license." If you don't indicate a single choice of license, a
031: * recipient has the option to distribute your version of this file under
032: * either the CDDL, the GPL Version 2 or to extend the choice of license to
033: * its licensees as provided above. However, if you add GPL Version 2 code
034: * and therefore, elected the GPL Version 2 license, then the option applies
035: * only if the new code is made subject to such option by the copyright
036: * holder.
037: */
038: package javax.servlet.jsp;
039:
040: import javax.servlet.*;
041:
042: /**
043: * The JspPage interface describes the generic interaction that a JSP Page
044: * Implementation class must satisfy; pages that use the HTTP protocol
045: * are described by the HttpJspPage interface.
046: *
047: * <p><B>Two plus One Methods</B>
048: * <p>
049: * The interface defines a protocol with 3 methods; only two of
050: * them: jspInit() and jspDestroy() are part of this interface as
051: * the signature of the third method: _jspService() depends on
052: * the specific protocol used and cannot be expressed in a generic
053: * way in Java.
054: * <p>
055: * A class implementing this interface is responsible for invoking
056: * the above methods at the appropriate time based on the
057: * corresponding Servlet-based method invocations.
058: * <p>
059: * The jspInit() and jspDestroy() methods can be defined by a JSP
060: * author, but the _jspService() method is defined automatically
061: * by the JSP processor based on the contents of the JSP page.
062: *
063: * <p><B>_jspService()</B>
064: * <p>
065: * The _jspService()method corresponds to the body of the JSP page. This
066: * method is defined automatically by the JSP container and should never
067: * be defined by the JSP page author.
068: * <p>
069: * If a superclass is specified using the extends attribute, that
070: * superclass may choose to perform some actions in its service() method
071: * before or after calling the _jspService() method. See using the extends
072: * attribute in the JSP_Engine chapter of the JSP specification.
073: * <p>
074: * The specific signature depends on the protocol supported by the JSP page.
075: *
076: * <pre>
077: * public void _jspService(<em>ServletRequestSubtype</em> request,
078: * <em>ServletResponseSubtype</em> response)
079: * throws ServletException, IOException;
080: * </pre>
081: */
082:
083: public interface JspPage extends Servlet {
084:
085: /**
086: * The jspInit() method is invoked when the JSP page is initialized. It
087: * is the responsibility of the JSP implementation (and of the class
088: * mentioned by the extends attribute, if present) that at this point
089: * invocations to the getServletConfig() method will return the desired
090: * value.
091: *
092: * A JSP page can override this method by including a definition for it
093: * in a declaration element.
094: *
095: * A JSP page should redefine the init() method from Servlet.
096: */
097: public void jspInit();
098:
099: /**
100: * The jspDestroy() method is invoked when the JSP page is about to be
101: * destroyed.
102: *
103: * A JSP page can override this method by including a definition for it
104: * in a declaration element.
105: *
106: * A JSP page should redefine the destroy() method from Servlet.
107: */
108: public void jspDestroy();
109:
110: }
|