Skip to content

Commit

Permalink
URL patterns for WebFilters are optional
Browse files Browse the repository at this point in the history
According to the spec, servlet names can be specified instead
Fixes quarkusio#11417
  • Loading branch information
gastaldi authored and gsmet committed Aug 24, 2020
1 parent 9f7ab2b commit fc312c8
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 11 deletions.
Expand Up @@ -431,14 +431,29 @@ public ServletDeploymentManagerBuildItem build(List<ServletBuildItem> servlets,
}
if (webMetaData.getFilterMappings() != null) {
for (FilterMappingMetaData mapping : webMetaData.getFilterMappings()) {
for (String m : mapping.getUrlPatterns()) {
if (mapping.getDispatchers() == null || mapping.getDispatchers().isEmpty()) {
recorder.addFilterURLMapping(deployment, mapping.getFilterName(), m, REQUEST);
} else {

for (DispatcherType dispatcher : mapping.getDispatchers()) {
recorder.addFilterURLMapping(deployment, mapping.getFilterName(), m,
javax.servlet.DispatcherType.valueOf(dispatcher.name()));
List<String> urlPatterns = mapping.getUrlPatterns();
List<String> servletNames = mapping.getServletNames();
if (urlPatterns != null && !urlPatterns.isEmpty()) {
for (String m : urlPatterns) {
if (mapping.getDispatchers() == null || mapping.getDispatchers().isEmpty()) {
recorder.addFilterURLMapping(deployment, mapping.getFilterName(), m, REQUEST);
} else {
for (DispatcherType dispatcher : mapping.getDispatchers()) {
recorder.addFilterURLMapping(deployment, mapping.getFilterName(), m,
javax.servlet.DispatcherType.valueOf(dispatcher.name()));
}
}
}
} else if (servletNames != null && !servletNames.isEmpty()) {
// No URL Patterns found, map to servlet name instead
for (String name : servletNames) {
if (mapping.getDispatchers() == null || mapping.getDispatchers().isEmpty()) {
recorder.addFilterServletNameMapping(deployment, mapping.getFilterName(), name, REQUEST);
} else {
for (DispatcherType dispatcher : mapping.getDispatchers()) {
recorder.addFilterServletNameMapping(deployment, mapping.getFilterName(), name,
javax.servlet.DispatcherType.valueOf(dispatcher.name()));
}
}
}
}
Expand Down Expand Up @@ -1005,14 +1020,17 @@ protected DescriptionGroupMetaData getDescriptionGroup(String description, Strin
if (description.length() > 0 || displayName.length() > 0 || smallIcon.length() > 0 || largeIcon.length() > 0) {
dg = new DescriptionGroupMetaData();
Descriptions descriptions = getDescription(description);
if (descriptions != null)
if (descriptions != null) {
dg.setDescriptions(descriptions);
}
DisplayNames displayNames = getDisplayName(displayName);
if (displayNames != null)
if (displayNames != null) {
dg.setDisplayNames(displayNames);
}
Icons icons = getIcons(smallIcon, largeIcon);
if (icons != null)
if (icons != null) {
dg.setIcons(icons);
}
}
return dg;
}
Expand Down
@@ -0,0 +1,19 @@
package io.quarkus.undertow.test;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(name = "named", urlPatterns = "/named")
public class NamedServlet extends HttpServlet {

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.getWriter().write("Hello World");
}

}
@@ -0,0 +1,20 @@
package io.quarkus.undertow.test;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;

@WebFilter(filterName = "MyFilter", servletNames = "named", asyncSupported = true)
public class NoUrlPatternWebFilter implements Filter {

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
response.getWriter().write("Goodbye");
}
}
@@ -0,0 +1,26 @@
package io.quarkus.undertow.test;

import static io.restassured.RestAssured.when;
import static org.hamcrest.Matchers.is;

import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.test.QuarkusUnitTest;

public class WebFilterWithNoUrlPatternTestCase {

@RegisterExtension
static QuarkusUnitTest runner = new QuarkusUnitTest()
.setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
.addClasses(NoUrlPatternWebFilter.class, NamedServlet.class));

@Test
public void testFilterWithNoUrlPattern() {
when().get("/named").then()
.statusCode(200)
.body(is("Goodbye"));
}
}

0 comments on commit fc312c8

Please sign in to comment.