J-523 Application WADL not found when Jersey filter not mapped to /*

Change-Id: I0bb19c787a9c4d27c28ad2d3e87c8b8a40f75fae

Author: Adam Lindenthal

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

@@ -41,6 +41,8 @@
 
 import java.io.IOException;
 import java.net.URI;
+import java.util.Iterator;
+import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
@@ -62,6 +64,7 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+import org.glassfish.jersey.internal.inject.Providers;
 import org.glassfish.jersey.internal.util.ExtendedLogger;
 import org.glassfish.jersey.internal.util.collection.Value;
 import org.glassfish.jersey.server.ApplicationHandler;
@@ -74,6 +77,7 @@
 import org.glassfish.jersey.server.spi.ContainerLifecycleListener;
 import org.glassfish.jersey.servlet.internal.LocalizationMessages;
 import org.glassfish.jersey.servlet.internal.ResponseWriter;
+import org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider;
 import org.glassfish.jersey.uri.UriComponent;
 
 /**
@@ -159,6 +163,7 @@ public class ServletContainer extends HttpServlet implements Filter, Container {
     private transient ResourceConfig resourceConfig;
     private transient Pattern staticContentPattern;
     private transient String filterContextPath;
+    private transient List<String> filterUrlMappings;
 
     private transient volatile ContainerLifecycleListener containerListener;
 
@@ -432,6 +437,19 @@ public void init(final FilterConfig filterConfig) throws ServletException {
                 }
             }
         }
+
+        // get the url-pattern defined (e.g.) in the filter-mapping section of web.xml
+        final FilterUrlMappingsProvider filterUrlMappingsProvider = getFilterUrlMappingsProvider();
+        if (filterUrlMappingsProvider != null) {
+            filterUrlMappings = filterUrlMappingsProvider.getFilterUrlMappings(filterConfig);
+        }
+
+        // we need either the url-pattern from the filter mapping (in case of Servlet 3) or specific init-param to
+        // determine the baseUri and request relative URI. If we do not have either one, the app will most likely
+        // not work (won't be accessible)
+        if (filterUrlMappings == null && filterContextPath == null) {
+            LOGGER.warning(LocalizationMessages.FILTER_CONTEXT_PATH_MISSING());
+        }
     }
 
     @Override
@@ -545,14 +563,14 @@ private void doFilter(final HttpServletRequest request, final HttpServletRespons
         try {
             final UriBuilder absoluteUriBuilder = UriBuilder.fromUri(request.getRequestURL().toString());
 
-            baseUri = (filterContextPath == null)
-                    ? absoluteUriBuilder.replacePath(request.getContextPath())
-                    .path("/")
-                    .build()
-                    : absoluteUriBuilder.replacePath(request.getContextPath())
-                            .path(filterContextPath)
-                            .path("/")
-                            .build();
+            // depending on circumstances, use the correct path to replace in the absolute request URI
+            final String pickedUrlMapping = pickUrlMapping(request.getRequestURL().toString(), filterUrlMappings);
+            final String replacingPath = pickedUrlMapping != null
+                    ? pickedUrlMapping
+                    : (filterContextPath != null ? filterContextPath : "");
+
+            baseUri = absoluteUriBuilder.replacePath(request.getContextPath()).path(replacingPath).path("/").build();
+
 
             requestUri = absoluteUriBuilder.replacePath(requestURI)
                     .replaceQuery(ContainerUtils.encodeUnsafeCharacters(queryString))
@@ -590,6 +608,49 @@ private void doFilter(final HttpServletRequest request, final HttpServletRespons
         }
     }
 
+    /**
+     * Picks the most suitable url mapping (in case more than one is defined) based on the request URI.
+     *
+     * @param requestUri String representation of the request URI
+     * @param filterUrlMappings set of configured filter url-patterns
+     * @return the most suitable context path, or {@code null} if empty
+     */
+    private String pickUrlMapping(final String requestUri, final List<String> filterUrlMappings) {
+        if (filterUrlMappings == null || filterUrlMappings.isEmpty()) {
+            return null;
+        }
+
+        if (filterUrlMappings.size() == 1) {
+            return filterUrlMappings.get(0);
+        }
+
+        for (final String pattern : filterUrlMappings) {
+            if (requestUri.contains(pattern)) {
+                return pattern;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Resolve the {@link FilterUrlMappingsProvider} service via hk2.
+     *
+     * Will only work in Servlet 3 container, as the older API version
+     * does not provide access to the filter mapping structure.
+     *
+     * @return {@code FilterContextPath} instance, if available, {@code null} otherwise.
+     */
+    private FilterUrlMappingsProvider getFilterUrlMappingsProvider() {
+        FilterUrlMappingsProvider filterUrlMappingsProvider = null;
+        final Iterator<FilterUrlMappingsProvider> providers = Providers.getAllProviders(
+                getApplicationHandler().getServiceLocator(), FilterUrlMappingsProvider.class).iterator();
+        if (providers.hasNext()) {
+             filterUrlMappingsProvider = providers.next();
+        }
+        return filterUrlMappingsProvider;
+    }
+
     /**
      * Get the static content path pattern.
      *

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

@@ -103,6 +103,7 @@
 import org.glassfish.jersey.servlet.internal.spi.ServletContainerProvider;
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegate;
 import org.glassfish.jersey.servlet.spi.AsyncContextDelegateProvider;
+import org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider;
 import org.glassfish.jersey.uri.UriComponent;
 
 import org.glassfish.hk2.api.Factory;
@@ -297,6 +298,7 @@ public void dispose(final WebConfig instance) {
             }).to(WebConfig.class).in(Singleton.class);
 
             install(new ServiceFinderBinder<>(AsyncContextDelegateProvider.class, applicationProperties, RuntimeType.SERVER));
+            install(new ServiceFinderBinder<>(FilterUrlMappingsProvider.class, applicationProperties, RuntimeType.SERVER));
         }
     }
 

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

@@ -0,0 +1,59 @@
+/*
+ * 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.spi;
+
+import javax.servlet.FilterConfig;
+import java.util.List;
+
+/**
+ * Provides an access to context path from the filter configuration.
+ *
+ * @author Adam Lindenthal (adam.lindenthal at oracle.com)
+ */
+public interface FilterUrlMappingsProvider {
+
+    /**
+     * Return configured context path from the filter configuration.
+     *
+     * @param filterConfig the {@link FilterConfig} object
+     * @returns the {@code List} of url-patterns
+     */
+    List<String> getFilterUrlMappings(final FilterConfig filterConfig);
+}

containers/jersey-servlet-core/src/main/resources/org/glassfish/jersey/servlet/internal/localization.properties

@@ -52,4 +52,7 @@ resource.config.unable.to.load=Resource configuration class {0} could not be loa
 servlet.path.mismatch=The servlet path {0} does not start with the filter context path {1}.
 servlet.request.suspend.failed=Attempt to put servlet request into asynchronous mode has failed. Please check your servlet configuration \
   - all Servlet instances and Servlet filters involved in the request processing must explicitly declare support for asynchronous request processing.
-header.value.read.failed=Attempt to read the header value failed.
+header.value.read.failed=Attempt to read the header value failed.
+filter.context.path.missing=The root of the app was not properly defined. Either use a Servlet 3.x container or add \
+  an init-param 'jersey.config.servlet.filter.contextPath' to the filter configuration. Due to Servlet 2.x API, Jersey cannot \
+  determine the request base URI solely from the ServletContext. The application will most likely not work.

containers/jersey-servlet/src/main/java/org/glassfish/jersey/servlet/init/FilterUrlMappingsProviderImpl.java

@@ -0,0 +1,75 @@
+/*
+ * 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.init;
+
+import org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider;
+
+import javax.servlet.FilterConfig;
+import javax.servlet.FilterRegistration;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Provide all configured context paths (url mappings) of the application deployed using filter.
+ * <p>
+ * The url patterns are returned without the eventual trailing asterisk.
+ * <p>
+ * The functionality is available in Servlet 3.x environment only, so this
+ * implementation of {@link FilterUrlMappingsProvider} interface is Servlet 3 specific.
+ *
+ * @author Adam Lindenthal (adam.lindenthal at oracle.com)
+ */
+public class FilterUrlMappingsProviderImpl implements FilterUrlMappingsProvider {
+    @Override
+    public List<String> getFilterUrlMappings(FilterConfig filterConfig) {
+        FilterRegistration filterRegistration =
+          filterConfig.getServletContext().getFilterRegistration(filterConfig.getFilterName());
+
+        Collection<String> urlPatternMappings = filterRegistration.getUrlPatternMappings();
+        List<String> result = new ArrayList<>();
+
+        for (String pattern : urlPatternMappings) {
+            result.add(pattern.endsWith("*") ? pattern.substring(0, pattern.length() - 1) : pattern);
+        }
+
+        return result;
+    }
+}

containers/jersey-servlet/src/main/resources/META-INF/services/org.glassfish.jersey.servlet.spi.FilterUrlMappingsProvider

@@ -0,0 +1 @@
+org.glassfish.jersey.servlet.init.FilterUrlMappingsProviderImpl

docs/src/main/docbook/deployment.xml

@@ -555,6 +555,16 @@ Server server = JettyHttpContainerFactory.createServer(baseUri, config);</progra
                 </example>
             </para>
 
+            <important>
+                <para>
+                    Servlet 2.x API does not provide a way how to programmatically read the filter mappings. To make application
+                    deployed using filter work correctly, either Servlet 3.x container must be used
+                    (<literal>jersey-container-servlet</literal> instead of <literal>jersey-container-servlet-core</literal>), or
+                    the context path of the app needs to be defined using init parameter
+                    <literal>jersey.config.servlet.filter.contextPath</literal>.
+                </para>
+            </important>
+
             <para>
                 The content of the <literal>&lt;init-param&gt;</literal> element will vary depending on the way you decide to
                 configure Jersey resources.

tests/integration/async-jersey-filter/src/main/webapp/WEB-INF/web.xml

@@ -68,16 +68,16 @@
 
     <filter-mapping>
         <filter-name>jersey2812</filter-name>
-        <url-pattern>/async/wait/*</url-pattern>
+        <url-pattern>/asyncTest/async/wait/*</url-pattern>
     </filter-mapping>
 
     <filter-mapping>
         <filter-name>jersey</filter-name>
-        <url-pattern>/exception/*</url-pattern>
+        <url-pattern>/exceptionTest/*</url-pattern>
     </filter-mapping>
     <filter-mapping>
         <filter-name>jersey</filter-name>
-        <url-pattern>/async/*</url-pattern>
+        <url-pattern>/asyncTest/*</url-pattern>
     </filter-mapping>
 
     <absolute-ordering />

tests/integration/async-jersey-filter/src/test/java/org/glassfish/jersey/tests/integration/jersey2730/Jersey2730ITCase.java

@@ -58,48 +58,48 @@
 public class Jersey2730ITCase extends AbstractAsyncJerseyTest {
 
     private void assertLastThreadNotStuck() {
-        final boolean lastThreadGotStuck = target("exception/rpc/lastthreadstuck").request().get(boolean.class);
+        final boolean lastThreadGotStuck = target("/exceptionTest/exception/rpc/lastthreadstuck").request().get(boolean.class);
 
         assertFalse("Thread processing last request got stuck while processing the request for "
                         + TestExceptionResource.class.getCanonicalName(),
                 lastThreadGotStuck);
     }
 
     @Test
-    public void asyncResourceNullThrowableReturns500AndDoesNotStuck() throws Exception {
-        final Response response = target("/exception/null").request().get();
+    public void asyncResourceNullThrowableReturns500AndDoesNotStuck() throws Exception  {
+        final Response response = target("/exceptionTest/exception/null").request().get();
 
         assertEquals(500, response.getStatus());
         assertLastThreadNotStuck();
     }
 
     @Test
-    public void asyncResourceUnmappedExceptionReturns500AndDoesNotStuck() throws Exception {
-        final Response response = target("/exception/unmapped").request().get();
+    public void asyncResourceUnmappedExceptionReturns500AndDoesNotStuck() throws Exception  {
+        final Response response = target("/exceptionTest/exception/unmapped").request().get();
 
         assertEquals(500, response.getStatus());
         assertLastThreadNotStuck();
     }
 
     @Test
-    public void asyncResourceUnmappedRuntimeExceptionReturns500AndDoesNotStuck() throws Exception {
-        final Response response = target("/exception/runtime").request().get();
+    public void asyncResourceUnmappedRuntimeExceptionReturns500AndDoesNotStuck() throws Exception  {
+        final Response response = target("/exceptionTest/exception/runtime").request().get();
 
         assertEquals(500, response.getStatus());
         assertLastThreadNotStuck();
     }
 
     @Test
-    public void asyncResourceMappedExceptionReturns432() throws Exception {
-        final Response response = target("/exception/mapped").request().get();
+    public void asyncResourceMappedExceptionReturns432() throws Exception  {
+        final Response response = target("/exceptionTest/exception/mapped").request().get();
 
         assertEquals(432, response.getStatus());
         assertLastThreadNotStuck();
     }
 
     @Test
     public void asyncResourceNonExistentReturns404() throws Exception {
-        final Response response = target("/exception/notfound").request().get();
+        final Response response = target("/exceptionTest/exception/notfound").request().get();
 
         assertEquals(404, response.getStatus());
     }