Add the ability to set <jsp-file> though the ServletRegistration interface

[jakartaee]

Add the ability to set though the ServletRegistration interface

from servlet.

[glassfishrobot]

• Issue Imported From: https://github.com/javaee/servlet-spec/issues/16
• Original Issue Raised By:@glassfishrobot
• Original Issue Assigned To: @shingwaichan
• Original Issue Closed By:@glassfishrobot

[glassfishrobot]

@glassfishrobot Commented
Reported by markt_asf

[glassfishrobot]

@glassfishrobot Commented
mode said:
Not everything defined in the web.xml can be done via ServletRegistration.

[glassfishrobot]

@glassfishrobot Commented
markt_asf said:
Indeed, but is there a reason not to add jsp-file that I have missed?

[glassfishrobot]

@glassfishrobot Commented
mode said:
There was no specific discussion about jsp-file, however the main goal of the APIs for adding Servlet, Filters and Listeners was for pluggability of frameworks. Not sure how many frameworks will really need to the jsp-file for pluggability.

[glassfishrobot]

@glassfishrobot Commented
markt_asf said:
Here is the Tomcat discussion that triggered this request:
http://tomcat.markmail.org/thread/pg65fgqhfra7czy5

[glassfishrobot]

@glassfishrobot Commented
@edburns said:
Here is a proposal that implements this.

@WebListener()
public class NewServletListener  implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {

        final ServletContext servletContext = sce.getServletContext();
        final ServletRegistration.Dynamic dynamic = servletContext.addServlet("newjsp",
ServletContext.JSP_SERVLET_CLASS_REFERENCE);
        dynamic.setJspFile("/newjsp.jsp");
        dynamic.addMapping("/newjsp");

    }

}

[glassfishrobot]

@glassfishrobot Commented
@edburns said:
The use of the constant JSP_SERVLET_CLASS_REFERENCE enables the implementation to take the necessary actions to ensure this is equivalent to the implementation private JspServlet.

[glassfishrobot]

@glassfishrobot Commented
@shingwaichan said:
is a deployment descriptor. If the API is to set , do we need to introduce the constant JSP_SERVLET_CLASS_REFERENCE?

[glassfishrobot]

@glassfishrobot Commented
@edburns said:
I chose adding the constant to minimize impact on the existing API for programmatic servlet registration, which is:

@WebListener()
public class NewServletListener  implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {

        final ServletContext servletContext = sce.getServletContext();
        final ServletRegistration.Dynamic dynamic = servletContext.addServlet("newjsp",
[String, Class or Servlet]);
        dynamic.addMapping("/newjsp");

    }

}

As far as I know, and I could be wrong about this, but the existing API does require the use of one of the addServlet() variants on ServletContext. Given that assumption, neither the Class nor the Servlet variants are appropriate for a Servlet that is a JSP page. That leaves String. We have a private constant that is used internally for such things, but that is implementation specific. So, I judged the easiest and most minimal impact would be achieved by introducing a new constant whose meaning is as I've documented in the patch.

[glassfishrobot]

@glassfishrobot Commented
markt_asf said:
I originally thought of using null. Looking at the addSevlet() Javadoc that looks legal. However, a specific constant strikes me as a better idea than giving null a special meaning.

[glassfishrobot]

@glassfishrobot Commented
@shingwaichan said:
Revisions:

64485

Modified Paths:

trunk/api/javaee-api/javax.servlet/src/main/java/javax/servlet/ServletContext.java

[glassfishrobot]

@glassfishrobot Commented
@shingwaichan said:
add ServletContext#addJspFile()

[glassfishrobot]

@glassfishrobot Commented
Issue-Links:
is related to
GLASSFISH-21666

[glassfishrobot]

@glassfishrobot Commented
This issue was imported from java.net JIRA SERVLET_SPEC-16

[glassfishrobot]

@glassfishrobot Commented
Marked as fixed on Thursday, February 9th 2017, 3:52:46 pm