Merge pull request #3572 from espenaf/master

Added support for filterClass to OpenApiServlet

Author: frantuma

modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/integration/OpenApiServlet.java

@@ -1,12 +1,17 @@
 package io.swagger.v3.jaxrs2.integration;
 
+import io.swagger.v3.core.filter.OpenAPISpecFilter;
+import io.swagger.v3.core.filter.SpecFilter;
 import io.swagger.v3.core.util.Json;
 import io.swagger.v3.core.util.Yaml;
+import io.swagger.v3.jaxrs2.util.ServletUtils;
 import io.swagger.v3.oas.integration.OpenApiConfigurationException;
 import io.swagger.v3.oas.integration.OpenApiContextLocator;
 import io.swagger.v3.oas.integration.api.OpenApiContext;
 import io.swagger.v3.oas.models.OpenAPI;
 import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
@@ -20,6 +25,8 @@
 
 public class OpenApiServlet extends HttpServlet {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(OpenApiServlet.class);
+
     public static final String APPLICATION_JSON = "application/json";
     public static final String APPLICATION_YAML = "application/yaml";
     public static final String ACCEPT_HEADER = "Accept";
@@ -48,6 +55,19 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se
         OpenApiContext ctx = OpenApiContextLocator.getInstance().getOpenApiContext(ctxId);
         OpenAPI oas = ctx.read();
 
+        if (oas != null) {
+            if (ctx.getOpenApiConfiguration() != null && ctx.getOpenApiConfiguration().getFilterClass() != null) {
+                try {
+                    OpenAPISpecFilter filterImpl = (OpenAPISpecFilter) Class.forName(ctx.getOpenApiConfiguration().getFilterClass()).newInstance();
+                    SpecFilter f = new SpecFilter();
+                    oas = f.filter(oas, filterImpl, ServletUtils.getQueryParams(req.getParameterMap()),
+                            ServletUtils.getCookies(req.getCookies()), ServletUtils.getHeaders(req));
+                } catch (Exception e) {
+                    LOGGER.error("failed to load filter", e);
+                }
+            }
+        }
+
         String type = "json";
 
         String acceptHeader = req.getHeader(ACCEPT_HEADER);

modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/util/ServletUtils.java

@@ -0,0 +1,67 @@
+package io.swagger.v3.jaxrs2.util;
+
+import io.swagger.v3.jaxrs2.integration.OpenApiServlet;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.MultivaluedHashMap;
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public class ServletUtils {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(ServletUtils.class);
+
+    public static MultivaluedHashMap<String, String> getQueryParams(Map<String, String[]> parameterMap) {
+        MultivaluedHashMap<String, String> queryParameters = new MultivaluedHashMap<>();
+
+        if (parameterMap.size() == 0) {
+            return queryParameters;
+        }
+
+        for (Map.Entry<String, String[]> parameter : parameterMap.entrySet()) {
+            for (String value : parameter.getValue()) {
+                try {
+                    queryParameters.add(URLDecoder.decode(parameter.getKey(), StandardCharsets.UTF_8.name()),
+                            URLDecoder.decode(value, StandardCharsets.UTF_8.name()));
+                } catch (UnsupportedEncodingException e) {
+                    LOGGER.error("Unable to decode query parameter", e);
+                }
+            }
+        }
+        return queryParameters;
+    }
+
+    public static Map<String, String> getCookies(Cookie[] cookies) {
+        Map<String, String> mapOfCookies = new HashMap<>();
+        if (cookies != null) {
+            for (Cookie cookie : cookies) {
+                mapOfCookies.put(cookie.getName(), cookie.getValue());
+            }
+        }
+        return mapOfCookies;
+    }
+
+    public static Map<String, List<String>> getHeaders(HttpServletRequest req) {
+        if (req.getHeaderNames() == null) {
+            return Collections.emptyMap();
+        } else {
+            return Collections
+                    .list(req.getHeaderNames())
+                    .stream()
+                    .collect(Collectors.toMap(
+                            Function.identity(),
+                            header -> Collections.list(req.getHeaders(header))));
+        }
+    }
+
+}

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/util/ServletUtilsTest.java

@@ -0,0 +1,48 @@
+package io.swagger.v3.jaxrs2.util;
+
+import org.hamcrest.collection.IsMapContaining;
+import org.testng.annotations.Test;
+
+import javax.ws.rs.core.MultivaluedHashMap;
+import java.net.URLEncoder;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.testng.Assert.assertEquals;
+
+public class ServletUtilsTest {
+
+    @Test(description = "convert query parameters to multivaluedmap")
+    public void convertWithRightOutputSize() throws Exception {
+
+        Map<String, String[]> params = new HashMap<>();
+        params.put("key1", new String[]{"value1", "value2"});
+        params.put("key2", new String[]{"value2", "value3", "value4", "value4"});
+
+        MultivaluedHashMap<String, String> multivaluedMap = ServletUtils.getQueryParams(params);
+        assertEquals(multivaluedMap.size(), 2);
+        assertEquals(multivaluedMap.get("key1").size(), 2);
+        assertEquals(multivaluedMap.get("key2").size(), 4);
+        assertEquals(multivaluedMap.keySet().iterator().next(), "key1");
+    }
+
+    @Test(description = "convert query parameters to multivaluedmap with decoded values")
+    public void convertWithDecodedValues() throws Exception {
+
+        Map<String, String[]> params = new HashMap<>();
+        params.put(URLEncoder.encode("key1&", UTF_8.name()), new String[]{"value1", URLEncoder.encode("value2?", UTF_8.name())});
+        params.put("key2", new String[]{URLEncoder.encode("value2", UTF_8.name()), "value3", "value4", "value4"});
+        assertThat(params, IsMapContaining.hasEntry("key1%26", new String[]{"value1", "value2%3F"}));
+
+        MultivaluedHashMap<String, String> multivaluedHashMap = ServletUtils.getQueryParams(params);
+        assertEquals(multivaluedHashMap.size(), 2);
+        assertThat(multivaluedHashMap, IsMapContaining.hasKey("key1&"));
+        assertEquals(multivaluedHashMap.get("key1&").size(), 2);
+        assertEquals(multivaluedHashMap.get("key1&"), Arrays.asList("value1", "value2?"));
+        assertEquals(multivaluedHashMap.get("key2"), Arrays.asList("value2", "value3", "value4", "value4"));
+    }
+
+}