JERSEY-2855: Jersey part now does not require breaking change in Jersey internal SPI, introduced new ExtendedServletContainerProvider interface to accommodate the additional methods handling HTTP Servlet request/response binding, adjusted test code to compile and run

Change-Id: I38125fcf8a54d56c7c3896a29791c09a5adbad39
Signed-off-by: Jakub Podlesak <[email protected]>

Author: japod

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/WebComponent.java

@@ -97,6 +97,7 @@
 import org.glassfish.jersey.servlet.internal.ResponseWriter;
 import org.glassfish.jersey.servlet.internal.ServletContainerProviderFactory;
 import org.glassfish.jersey.servlet.internal.Utils;
+import org.glassfish.jersey.servlet.internal.spi.ExtendedServletContainerProvider;
 import org.glassfish.jersey.servlet.internal.spi.RequestContextProvider;
 import org.glassfish.jersey.servlet.internal.spi.RequestScopedInitializerProvider;
 import org.glassfish.jersey.servlet.internal.spi.ServletContainerProvider;
@@ -364,11 +365,16 @@ public WebComponent(final WebConfig webConfig, ResourceConfig resourceConfig) th
         RequestScopedInitializerProvider rsiProvider = null;
 
         for (final ServletContainerProvider servletContainerProvider : allServletContainerProviders) {
-            if (servletContainerProvider.bindsServletRequestResponse()) {
-                rrbExternalized = true;
-            }
-            if (rsiProvider == null) { // try to take the first non-null provider
-                rsiProvider = servletContainerProvider.getRequestScopedInitializerProvider();
+            if (servletContainerProvider instanceof ExtendedServletContainerProvider) {
+                final ExtendedServletContainerProvider extendedProvider =
+                        (ExtendedServletContainerProvider) servletContainerProvider;
+
+                if (extendedProvider.bindsServletRequestResponse()) {
+                    rrbExternalized = true;
+                }
+                if (rsiProvider == null) { // try to take the first non-null provider
+                    rsiProvider = extendedProvider.getRequestScopedInitializerProvider();
+                }
             }
         }
 

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/internal/spi/ExtendedServletContainerProvider.java

@@ -0,0 +1,83 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.servlet.internal.spi;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.glassfish.jersey.server.ResourceConfig;
+import org.glassfish.jersey.server.spi.RequestScopedInitializer;
+
+/**
+ * Implementations could provide their own {@link HttpServletRequest} and {@link HttpServletResponse}
+ * binding implementation in HK2 locator and also an implementation of {@link RequestScopedInitializer}
+ * that is used to set actual request/response references in HK2 service locator within each request.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
+ * @since 2.21
+ */
+public interface ExtendedServletContainerProvider extends ServletContainerProvider {
+
+    /**
+     * Give me a {@link RequestScopedInitializerProvider} instance, that will be utilized
+     * at runtime to set the actual HTTP Servlet request and response.
+     *
+     * The provider returned will be used at runtime for every and each incoming request
+     * so that the actual request/response instances could be made accessible
+     * from Jersey HK2 service locator.
+     *
+     * @return request scoped initializer provider.
+     */
+    public RequestScopedInitializerProvider getRequestScopedInitializerProvider();
+
+    /**
+     * Used by Jersey runtime to tell if the extension covers HTTP Servlet request response
+     * handling with respect to underlying HK2 service locator.
+     *
+     * Return {@code true}, if your implementation configures HK2 bindings
+     * for {@link HttpServletRequest} and {@link HttpServletResponse}
+     * in {@link #configure(ResourceConfig)} method
+     * and also provides a {@link RequestScopedInitializer} implementation
+     * via {@link #getRequestScopedInitializerProvider()}.
+     *
+     * @return {@code true} if the extension fully covers HTTP request/response handling.
+     */
+    public boolean bindsServletRequestResponse();
+}

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/internal/spi/NoOpServletContainerProvider.java

@@ -55,13 +55,13 @@
 import org.glassfish.hk2.api.TypeLiteral;
 
 /**
- * Basic {@link ServletContainerProvider} that provides
+ * Basic {@link ExtendedServletContainerProvider} that provides
  * dummy no-op method implementation. It should be convenient to extend if you only need to implement
  * a subset of the original SPI methods.
  *
  * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  */
-public class NoOpServletContainerProvider implements ServletContainerProvider {
+public class NoOpServletContainerProvider implements ExtendedServletContainerProvider {
 
     public final Type HTTP_SERVLET_REQUEST_TYPE = (new TypeLiteral<Ref<HttpServletRequest>>() {
     }).getType();

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/internal/spi/ServletContainerProvider.java

@@ -55,12 +55,8 @@
  * {@code org.glassfish.jersey.servlet.init.JerseyServletContainerInitializer}.
  * The provider implementation class is registered via {@code META-INF/services}.
  *
- * Implementations could provide their own {@link HttpServletRequest} and {@link HttpServletResponse}
- * binding implementation in HK2 locator and also an implementation of {@link RequestScopedInitializer}
- * that is used to set actual request/response references in HK2 service locator within each request.
  *
  * @author Libor Kramolis (libor.kramolis at oracle.com)
- * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  * @since 2.4.1
  */
 public interface ServletContainerProvider {
@@ -135,32 +131,4 @@ public void postInit(ServletContext servletContext, Set<Class<?>> classes, final
      *                          is interrupted.
      */
     public void configure(ResourceConfig resourceConfig) throws ServletException;
-
-    /**
-     * Give me a {@link RequestScopedInitializerProvider} instance, that will be utilized
-     * at runtime to set the actual HTTP Servlet request and response.
-     *
-     * The provider returned will be used at runtime for every and each incoming request
-     * so that the actual request/response instances could be made accessible
-     * from Jersey HK2 service locator.
-     *
-     * @return request scoped initializer provider.
-     * @since 2.20
-     */
-    public RequestScopedInitializerProvider getRequestScopedInitializerProvider();
-
-    /**
-     * Used by Jersey runtime to tell if the extension covers HTTP Servlet request response
-     * handling with respect to underlying HK2 service locator.
-     *
-     * Return {@code true}, if your implementation configures HK2 bindings
-     * for {@link HttpServletRequest} and {@link HttpServletResponse}
-     * in {@link #configure(ResourceConfig)} method
-     * and also provides a {@link RequestScopedInitializer} implementation
-     * via {@link #getRequestScopedInitializerProvider()}.
-     *
-     * @return {@code true} if the extension fully covers HTTP request/response handling.
-     * @since 2.20
-     */
-    public boolean bindsServletRequestResponse();
 }

tests/integration/servlet-3-init-provider/src/main/java/org/glassfish/jersey/tests/integration/servlet_3_init_provider/TestServletContainerProvider.java

@@ -93,16 +93,6 @@ public void configure(final ResourceConfig resourceConfig) throws ServletExcepti
         }
     }
 
-    @Override
-    public boolean bindsServletRequestResponse() {
-        return false;
-    }
-
-    @Override
-    public RequestScopedInitializerProvider getRequestScopedInitializerProvider() {
-        return null;
-    }
-
     public static Set<String> getServletNames() {
         return SERVLET_NAMES;
     }