Part 1 of JSP to Jakarta Pages conversion

NOTICE.md

@@ -49,9 +49,3 @@ another country, of encryption software. BEFORE using any encryption software,
 please check the country's laws, regulations and policies concerning the import,
 possession, or use, and re-export of encryption software, to see if this is
 permitted.
-
-## Note
-
-References in this document to JSP refer to the Jakarta Pages unless otherwise
-noted.
-

api/pom.xml

@@ -57,7 +57,7 @@
 
     <mailingLists>
         <mailingList>
-            <name>JSP dev mailing list</name>
+            <name>Jakarta Pages (JSP) dev mailing list</name>
             <post>jsp-dev@eclipse.org</post>
             <subscribe>https://accounts.eclipse.org/mailing-list/jsp-dev</subscribe>
             <unsubscribe>https://accounts.eclipse.org/mailing-list/jsp-dev</unsubscribe>

api/src/main/java/jakarta/servlet/jsp/ErrorData.java

@@ -20,7 +20,7 @@
 
 /**
  * Contains information about an error, for error pages. The information contained in this instance is meaningless if
- * not used in the context of an error page. To indicate a JSP is an error page, the page author must set the
+ * not used in the context of an error page. To indicate a page is an error page, the page author must set the
  * isErrorPage attribute of the page directive to "true".
  *
  * @see PageContext#getErrorData
@@ -60,7 +60,7 @@ public ErrorData(Throwable throwable, int statusCode, String uri, String servlet
      * @param servletName The name of the servlet invoked
      * @param queryString The request query string
      * 
-     * @since JSP 4.0
+     * @since Pages (JSP) 4.0
      */
     public ErrorData(Throwable throwable, int statusCode, String method, String uri, String servletName,
             String queryString) {
@@ -95,7 +95,7 @@ public int getStatusCode() {
      *
      * @return The request method
      * 
-     * @since JSP 4.0
+     * @since Pages (JSP) 4.0
      */
     public String getMethod() {
         return this.method;
@@ -125,7 +125,7 @@ public String getServletName() {
      *
      * @return The request query string
      * 
-     * @since JSP 4.0
+     * @since Pages (JSP) 4.0
      */
     public String getQueryString() {
         return this.queryString;

api/src/main/java/jakarta/servlet/jsp/HttpJspPage.java

@@ -23,28 +23,28 @@
 import jakarta.servlet.ServletException;
 
 /**
- * The HttpJspPage interface describes the interaction that a JSP Page Implementation Class must satisfy when using the
+ * The HttpJspPage interface describes the interaction that a Jakarta Pages (JSP) Page Implementation Class must satisfy when using the
  * HTTP protocol.
  *
  * <p>
  * The behaviour is identical to that of the JspPage, except for the signature of the _jspService method, which is now
  * expressible in the Java type system and included explicitly in the interface.
- * 
+ *
  * @see JspPage
  */
 public interface HttpJspPage extends JspPage {
 
     /**
-     * The _jspService()method corresponds to the body of the JSP page. This method is defined automatically by the JSP
-     * container and should never be defined by the JSP page author.
+     * The _jspService()method corresponds to the body of the page. This method is defined automatically by the Jakarta Pages (JSP)
+     * container and should never be defined by the page author.
      * <p>
      * If a superclass is specified using the extends attribute, that superclass may choose to perform some actions in
      * its service() method before or after calling the _jspService() method. See using the extends attribute in the
-     * JSP_Engine chapter of the JSP specification.
+     * Jakarta Pages (JSP) Container chapter of the Jakarta Pages (JSP) specification.
      *
-     * @param request  Provides client request information to the JSP.
-     * @param response Assists the JSP in sending a response to the client.
-     * @throws ServletException Thrown if an error occurred during the processing of the JSP and that the container
+     * @param request  Provides client request information to the page.
+     * @param response Assists the page in sending a response to the client.
+     * @throws ServletException Thrown if an error occurred during the processing of the page and that the container
      *                          should take appropriate action to clean up the request.
      * @throws IOException      Thrown if an error occurred while writing the response for this page.
      */

api/src/main/java/jakarta/servlet/jsp/JspApplicationContext.java

@@ -23,10 +23,10 @@
 import jakarta.el.ELContextListener;
 
 /**
- * Stores application-scoped information relevant to JSP containers.
+ * Stores application-scoped information relevant to Jakarta Pages (JSP) containers.
  *
  * <p>
- * The JSP container must create a single instance of <code>JspApplicationContext</code> for each
+ * The Jakarta Pages (JSP) container must create a single instance of <code>JspApplicationContext</code> for each
  * <code>ServletContext</code> instance.
  * </p>
  *
@@ -37,13 +37,13 @@
  * </p>
  *
  * <p>
- * The <code>JspApplicationContext</code> provides the following services to JSP applications:
+ * The <code>JspApplicationContext</code> provides the following services to Jakarta Pages (JSP) applications:
  * </p>
  * <ul>
  * <li>Allows registration of <code>ELResolver</code>s, which are used to resolve variables in EL expressions contained
- * in JSP pages and tag files.</li>
+ * in Jakarta Pages (JSP) pages and tag files.</li>
  * <li>Provides an instance of <code>ExpressionFactory</code> for those applications or frameworks that need to perform
- * programmatic evaluation of EL expressions instead of allowing the JSP container to do it for them.</li>
+ * programmatic evaluation of EL expressions instead of allowing the Jakarta Pages (JSP) container to do it for them.</li>
  * <li>Allows the attachment of <code>ELContextListener</code> instances for notification whenever a new
  * <code>ELContext</code> is created. This is necessary when an application wishes to make custom context objects
  * available to their pluggable <code>ELResolver</code>s.</li>
@@ -60,15 +60,15 @@ public interface JspApplicationContext {
 
     /**
      * Adds an <code>ELResolver</code> to affect the way EL variables and properties are resolved for EL expressions
-     * appearing in JSP pages and tag files.
+     * appearing in Jakarta Pages (JSP) pages and tag files.
      *
      * <p>
      * For example, in the EL expression ${employee.lastName}, an <code>ELResolver</code> determines what object
      * "employee" references and how to find its "lastName" property.
      * </p>
      *
      * <p>
-     * When evaluating an expression, the JSP container will consult a set of standard resolvers as well as any
+     * When evaluating an expression, the Jakarta Pages (JSP) container will consult a set of standard resolvers as well as any
      * resolvers registered via this method. The set of resolvers are consulted in the following order:
      * </p>
      * <ul>
@@ -87,7 +87,7 @@ public interface JspApplicationContext {
      * <code>IllegalStateException</code> is thrown.
      * </p>
      * <p>
-     * This restriction is in place to allow the JSP container to optimize for the common case where no additional
+     * This restriction is in place to allow the Jakarta Pages (JSP) container to optimize for the common case where no additional
      * <code>ELResolver</code>s are in the chain, aside from the standard ones. It is permissible to add
      * <code>ELResolver</code>s before or after initialization to a <code>CompositeELResolver</code> that is already in
      * the chain.
@@ -118,7 +118,7 @@ public interface JspApplicationContext {
      *
      * <p>
      * At a minimum, the <code>ELContext</code> objects created will contain a reference to the <code>JspContext</code>
-     * for this request, which is added by the JSP container. This is sufficient for all the default
+     * for this request, which is added by the Jakarta Pages (JSP) container. This is sufficient for all the default
      * <code>ELResolver</code>s listed in {@link #addELResolver}. Note that <code>JspContext.class</code> is used as the
      * key to ELContext.putContext() for the <code>JspContext</code> object reference.
      * </p>

api/src/main/java/jakarta/servlet/jsp/JspContext.java

@@ -42,11 +42,11 @@
  * <code>pushBody()</code> and <code>popBody()</code>
  *
  * <p>
- * <B>Methods Intended for JSP authors</B>
+ * <B>Methods Intended for Jakarta Pages (JSP) authors</B>
  * <p>
  * Some methods provide <B>uniform access</B> to the diverse objects representing scopes. The implementation must use
  * the underlying machinery corresponding to that scope, so information can be passed back and forth between the
- * underlying environment (e.g. Servlets) and JSP pages. The methods are: <code>setAttribute()</code>,
+ * underlying environment (e.g. Servlets) and Jakarta Pages (JSP). The methods are: <code>setAttribute()</code>,
  * <code>getAttribute()</code>, <code>findAttribute()</code>, <code>removeAttribute()</code>,
  * <code>getAttributesScope()</code> and <code>getAttributeNamesInScope()</code>.
  * 
@@ -185,7 +185,7 @@ public JspContext() {
      * </p>
      *
      * <p>
-     * The <code>ELContext</code> must contain the <code>ELResolver</code> described in the JSP specification (and in
+     * The <code>ELContext</code> must contain the <code>ELResolver</code> described in the Jakarta Pages (JSP) specification (and in
      * the javadocs for {@link JspApplicationContext#addELResolver}).
      * </p>
      *

api/src/main/java/jakarta/servlet/jsp/JspEngineInfo.java

@@ -19,7 +19,7 @@
 package jakarta.servlet.jsp;
 
 /**
- * The JspEngineInfo is an abstract class that provides information on the current JSP engine.
+ * The JspEngineInfo is an abstract class that provides information on the current Jakarta Pages (JSP) engine.
  */
 public abstract class JspEngineInfo {
 
@@ -30,7 +30,7 @@ public JspEngineInfo() {
     }
 
     /**
-     * Return the version number of the JSP specification that is supported by this JSP engine.
+     * Return the version number of the Jakarta Pages (JSP) specification that is supported by this Jakarta Pages (JSP) engine.
      * <p>
      * Specification version numbers that consists of positive decimal integers separated by periods ".", for example,
      * "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc

api/src/main/java/jakarta/servlet/jsp/JspException.java

@@ -19,7 +19,7 @@
 package jakarta.servlet.jsp;
 
 /**
- * A generic exception known to the JSP engine; uncaught JspExceptions will result in an invocation of the errorpage
+ * A generic exception known to the Jakarta Pages (JSP) engine; uncaught JspExceptions will result in an invocation of the errorpage
  * machinery.
  */
 public class JspException extends Exception {
@@ -33,7 +33,7 @@ public JspException() {
     }
 
     /**
-     * Constructs a new JSP exception with the specified message. The message can be written to the server log and/or
+     * Constructs a new Jakarta Pages (JSP) exception with the specified message. The message can be written to the server log and/or
      * displayed for the user.
      *
      * @param msg a <code>String</code> specifying the text of the exception message

api/src/main/java/jakarta/servlet/jsp/JspFactory.java

@@ -25,17 +25,17 @@
 
 /**
  * <p>
- * The JspFactory is an abstract class that defines a number of factory methods available to a JSP page at runtime for
- * the purposes of creating instances of various interfaces and classes used to support the JSP implementation.
+ * The JspFactory is an abstract class that defines a number of factory methods available to a Jakarta Pages (JSP) page at runtime for
+ * the purposes of creating instances of various interfaces and classes used to support the Jakarta Pages (JSP) implementation.
  * <p>
- * A conformant JSP Engine implementation will, during it's initialization instantiate an implementation dependent
- * subclass of this class, and make it globally available for use by JSP implementation classes by registering the
+ * A conformant Jakarta Pages (JSP) Engine implementation will, during it's initialization instantiate an implementation dependent
+ * subclass of this class, and make it globally available for use by Jakarta Pages (JSP) implementation classes by registering the
  * instance created with this class via the static <code> setDefaultFactory() </code> method.
  * <p>
  * The only implementation-dependent classes that can be created from the factory are: PageContext, JspEngineInfo, and
  * JspApplicationContext.
  * <p>
- * With the exception of JspApplicationContext, JspFactory objects should not be used by JSP application developers.
+ * With the exception of JspApplicationContext, JspFactory objects should not be used by Jakarta Pages (JSP) application developers.
  */
 public abstract class JspFactory {
 
@@ -49,7 +49,7 @@ public JspFactory() {
 
     /**
      * <p>
-     * set the default factory for this implementation. It is illegal for any principal other than the JSP Engine
+     * set the default factory for this implementation. It is illegal for any principal other than the Jakarta Pages (JSP) Engine
      * runtime to call this method.
      * </p>
      *
@@ -75,7 +75,7 @@ public static JspFactory getDefaultFactory() {
      * </p>
      *
      * <p>
-     * This method is typically called early in the processing of the _jspService() method of a JSP implementation class
+     * This method is typically called early in the processing of the _jspService() method of a Jakarta Pages (JSP) implementation class
      * in order to obtain a PageContext object for the request being processed.
      * </p>
      * <p>
@@ -89,8 +89,8 @@ public static JspFactory getDefaultFactory() {
      * @param servlet      the requesting servlet
      * @param request      the current request pending on the servlet
      * @param response     the current response pending on the servlet
-     * @param errorPageURL the URL of the error page for the requesting JSP, or null
-     * @param needsSession true if the JSP participates in a session
+     * @param errorPageURL the URL of the error page for the requesting page, or null
+     * @param needsSession true if page participates in a session
      * @param buffer       size of buffer in bytes, JspWriter.NO_BUFFER if no buffer, JspWriter.DEFAULT_BUFFER if
      *                     implementation default.
      * @param autoflush    should the buffer autoflush to the output stream on buffer overflow, or throw an IOException?
@@ -105,7 +105,7 @@ public abstract PageContext getPageContext(Servlet servlet, ServletRequest reque
     /**
      * <p>
      * called to release a previously allocated PageContext object. Results in PageContext.release() being invoked. This
-     * method should be invoked prior to returning from the _jspService() method of a JSP implementation class.
+     * method should be invoked prior to returning from the _jspService() method of a Jakarta Pages (JSP) implementation class.
      * </p>
      *
      * @param pc A PageContext previously obtained by getPageContext()
@@ -114,10 +114,10 @@ public abstract PageContext getPageContext(Servlet servlet, ServletRequest reque
 
     /**
      * <p>
-     * called to get implementation-specific information on the current JSP engine.
+     * called to get implementation-specific information on the current Jakarta Pages (JSP) engine.
      * </p>
      *
-     * @return a JspEngineInfo object describing the current JSP engine
+     * @return a JspEngineInfo object describing the current Jakarta Pages (JSP) engine
      */
     public abstract JspEngineInfo getEngineInfo();
 

api/src/main/java/jakarta/servlet/jsp/JspPage.java

@@ -21,7 +21,7 @@
 import jakarta.servlet.Servlet;
 
 /**
- * The JspPage interface describes the generic interaction that a JSP Page Implementation class must satisfy; pages that
+ * The JspPage interface describes the generic interaction that a Jakarta Pages (JSP) Page Implementation class must satisfy; pages that
  * use the HTTP protocol are described by the HttpJspPage interface.
  *
  * <p>
@@ -34,20 +34,20 @@
  * A class implementing this interface is responsible for invoking the above methods at the appropriate time based on
  * the corresponding Servlet-based method invocations.
  * <p>
- * The jspInit() and jspDestroy() methods can be defined by a JSP author, but the _jspService() method is defined
- * automatically by the JSP processor based on the contents of the JSP page.
+ * The jspInit() and jspDestroy() methods can be defined by a page author, but the _jspService() method is defined
+ * automatically by the Jakarta Pages (JSP) processor based on the contents of the page.
  *
  * <p>
  * <B>_jspService()</B>
  * <p>
- * The _jspService()method corresponds to the body of the JSP page. This method is defined automatically by the JSP
- * container and should never be defined by the JSP page author.
+ * The _jspService() method corresponds to the body of the Jakarta Pages (JSP) page. This method is defined automatically by the Jakarta Pages (JSP)
+ * container and should never be defined by page author.
  * <p>
  * If a superclass is specified using the extends attribute, that superclass may choose to perform some actions in its
- * service() method before or after calling the _jspService() method. See using the extends attribute in the JSP_Engine
- * chapter of the JSP specification.
+ * service() method before or after calling the _jspService() method. See using the extends attribute in the Jakarta Pages (JSP) Engine
+ * chapter of the Jakarta Pages (JSP) specification.
  * <p>
- * The specific signature depends on the protocol supported by the JSP page.
+ * The specific signature depends on the protocol supported by the Jakarta Pages (JSP) page.
  *
  * <pre>
  * public void _jspService(<em>ServletRequestSubtype</em> request,
@@ -58,22 +58,22 @@
 public interface JspPage extends Servlet {
 
     /**
-     * The jspInit() method is invoked when the JSP page is initialized. It is the responsibility of the JSP
+     * The jspInit() method is invoked when the page is initialized. It is the responsibility of the Jakarta Pages (JSP)
      * implementation (and of the class mentioned by the extends attribute, if present) that at this point invocations
      * to the getServletConfig() method will return the desired value.
      *
-     * A JSP page can override this method by including a definition for it in a declaration element.
+     * A page can override this method by including a definition for it in a declaration element.
      *
-     * A JSP page should redefine the init() method from Servlet.
+     * A page should redefine the init() method from Servlet.
      */
     public void jspInit();
 
     /**
-     * The jspDestroy() method is invoked when the JSP page is about to be destroyed.
+     * The jspDestroy() method is invoked when the page is about to be destroyed.
      * 
-     * A JSP page can override this method by including a definition for it in a declaration element.
+     * A page can override this method by including a definition for it in a declaration element.
      *
-     * A JSP page should redefine the destroy() method from Servlet.
+     * A page should redefine the destroy() method from Servlet.
      */
     public void jspDestroy();