refs swagger-api#2312 - enhanced support for custom reader and scanner

Author: frantuma

modules/swagger-integration/src/main/java/io/swagger/oas/integration/ContextUtils.java

@@ -1,5 +1,6 @@
 package io.swagger.oas.integration;
 
+import io.swagger.oas.web.OpenAPIConfig;
 import io.swagger.util.Json;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -20,4 +21,18 @@ public static OpenApiConfiguration deepCopy (OpenApiConfiguration config) {
         }
     }
 
+    public static OpenApiConfiguration cloneConfigFromInterface(OpenAPIConfig configInterface) {
+
+        return new OpenApiConfiguration()
+                .openApi(configInterface.getOpenAPI())
+                .userDefinedOptions(configInterface.getUserDefinedOptions())
+                .filterClass(configInterface.getFilterClass())
+                .prettyPrint(configInterface.isPrettyPrint())
+                .readerClass(configInterface.getReaderClass())
+                .resourcePackages(configInterface.getResourcePackages())
+                .resourceClasses(configInterface.getResourceClasses())
+                .scanAllResources(configInterface.isScanAllResources())
+                .scannerClass(configInterface.getScannerClass());
+    }
+
 }

modules/swagger-integration/src/main/java/io/swagger/oas/integration/GenericOpenApiContext.java

@@ -1,6 +1,7 @@
 package io.swagger.oas.integration;
 
 import io.swagger.oas.models.OpenAPI;
+import io.swagger.oas.web.OpenAPIConfig;
 import io.swagger.oas.web.OpenApiReader;
 import io.swagger.oas.web.OpenApiScanner;
 import org.apache.commons.lang3.StringUtils;
@@ -166,27 +167,36 @@ protected OpenApiReader buildReader(final OpenApiConfiguration openApiConfigurat
         OpenApiReader reader;
         if (StringUtils.isNotBlank(openApiConfiguration.getReaderClass())) {
             Class cls = getClass().getClassLoader().loadClass(openApiConfiguration.getReaderClass());
-            // TODO instantiate with configuration
             reader = (OpenApiReader) cls.newInstance();
         } else {
-            reader = (classes, resources) -> {
-                OpenAPI openApi = openApiConfiguration.getOpenAPI();
-                return openApi;
+            reader = new OpenApiReader() {
 
+                OpenAPIConfig openApiConfiguration;
+                @Override
+                public void setConfiguration(OpenAPIConfig openApiConfiguration) {
+                    this.openApiConfiguration = openApiConfiguration;
+                }
+
+                @Override
+                public OpenAPI read(Set<Class<?>> classes, Map<String, Object> resources) {
+                    OpenAPI openApi = openApiConfiguration.getOpenAPI();
+                    return openApi;
+                }
             };
         }
+        reader.setConfiguration(openApiConfiguration);
         return reader;
     }
 
     protected OpenApiScanner buildScanner(final OpenApiConfiguration openApiConfiguration) throws Exception {
         OpenApiScanner scanner;
         if (StringUtils.isNotBlank(openApiConfiguration.getScannerClass())) {
             Class cls = getClass().getClassLoader().loadClass(openApiConfiguration.getScannerClass());
-            // TODO instantiate with configuration
             scanner = (OpenApiScanner) cls.newInstance();
         } else {
-            scanner = new GenericOpenApiScanner(openApiConfiguration);
+            scanner = new GenericOpenApiScanner();
         }
+        scanner.setConfiguration(openApiConfiguration);
         return scanner;
     }
 

modules/swagger-integration/src/main/java/io/swagger/oas/integration/GenericOpenApiScanner.java

@@ -1,5 +1,6 @@
 package io.swagger.oas.integration;
 
+import io.swagger.oas.web.OpenAPIConfig;
 import io.swagger.oas.web.OpenApiScanner;
 import org.apache.commons.lang3.StringUtils;
 import org.reflections.Reflections;
@@ -22,8 +23,9 @@ public class GenericOpenApiScanner implements OpenApiScanner {
 
     OpenApiConfiguration openApiConfiguration;
 
-    public GenericOpenApiScanner(OpenApiConfiguration openApiConfiguration) {
-        this.openApiConfiguration = openApiConfiguration;
+    @Override
+    public void setConfiguration(OpenAPIConfig openApiConfiguration) {
+        this.openApiConfiguration = ContextUtils.cloneConfigFromInterface(openApiConfiguration);
     }
 
     @Override

modules/swagger-integration/src/main/java/io/swagger/oas/integration/ServiceOpenApiConfigurationLoader.java

@@ -1,6 +1,5 @@
 package io.swagger.oas.integration;
 
-import io.swagger.oas.web.OpenAPIConfig;
 import io.swagger.oas.web.OpenAPIConfigBuilder;
 
 import java.io.IOException;
@@ -14,7 +13,7 @@ public OpenApiConfiguration load(String path)  throws IOException {
 
         ServiceLoader<OpenAPIConfigBuilder> loader = ServiceLoader.load(OpenAPIConfigBuilder.class);
         if (loader.iterator().hasNext()) {
-            return cloneFromInterface(loader.iterator().next().build());
+            return ContextUtils.cloneConfigFromInterface(loader.iterator().next().build());
         }
         throw new IOException("Error loading OpenAPIConfigBuilder service implementation.");
     }
@@ -33,18 +32,4 @@ public boolean exists(String path) {
             return false;
         }
     }
-
-    private OpenApiConfiguration cloneFromInterface(OpenAPIConfig configInterface) {
-
-        return new OpenApiConfiguration()
-                .openApi(configInterface.getOpenAPI())
-                .userDefinedOptions(configInterface.getUserDefinedOptions())
-                .filterClass(configInterface.getFilterClass())
-                .prettyPrint(configInterface.isPrettyPrint())
-                .readerClass(configInterface.getReaderClass())
-                .resourcePackages(configInterface.getResourcePackages())
-                .resourceClasses(configInterface.getResourceClasses())
-                .scanAllResources(configInterface.isScanAllResources())
-                .scannerClass(configInterface.getScannerClass());
-    }
 }

modules/swagger-integration/src/main/resources/META-INF/MANIFEST.MF

@@ -1,5 +1,5 @@
 Manifest-Version: 1.0
-Bnd-LastModified: 1501577298741
+Bnd-LastModified: 1501600916611
 Build-Jdk: 1.8.0_72
 Built-By: frantuma
 Bundle-Description: Sonatype helps open source projects to set up Maven 

modules/swagger-jaxrs2/src/main/java/io/swagger/jaxrs2/Reader.java

@@ -23,6 +23,7 @@
 import io.swagger.oas.models.parameters.RequestBody;
 import io.swagger.oas.models.security.SecurityScheme;
 import io.swagger.oas.models.tags.Tag;
+import io.swagger.oas.web.OpenAPIConfig;
 import io.swagger.oas.web.OpenApiReader;
 import io.swagger.util.Json;
 import io.swagger.util.ParameterProcessor;
@@ -54,7 +55,7 @@ public class Reader implements OpenApiReader {
     private static final Logger LOGGER = LoggerFactory.getLogger(Reader.class);
     public static final String DEFAULT_MEDIA_TYPE_VALUE = "*/*";
 
-    private final OpenApiConfiguration config;
+    protected OpenApiConfiguration config;
 
     private OpenAPI openAPI;
     private Components components;
@@ -73,20 +74,22 @@ public class Reader implements OpenApiReader {
     private static final String HEAD_METHOD = "head";
     private static final String OPTIONS_METHOD = "options";
 
+    public Reader() {
+        this.openAPI = new OpenAPI();
+        paths = new Paths();
+        openApiTags = new LinkedHashSet<>();
+        components = new Components();
+
+    }
     public Reader(OpenAPI openAPI) {
-        this(ContextUtils.deepCopy(new OpenApiConfiguration().openApi(openAPI)));
+        this();
+        setConfiguration(new OpenApiConfiguration().openApi(openAPI));
     }
 
     public Reader(OpenApiConfiguration openApiConfiguration) {
-        this.config = ContextUtils.deepCopy(openApiConfiguration);
-
-        // TODO init openApi by cloning the one in config
-        //clone openApiConfiguration.getOpenAPI();
+        this();
+        setConfiguration(openApiConfiguration);
         this.openAPI = config.getOpenAPI();
-        paths = new Paths();
-        openApiTags = new LinkedHashSet<>();
-        //this.config = new DefaultReaderConfig();
-        components = new Components();
     }
 
     public OpenAPI getOpenAPI() {
@@ -131,6 +134,11 @@ public int compare(Class<?> class1, Class<?> class2) {
         return openAPI;
     }
 
+    @Override
+    public void setConfiguration(OpenAPIConfig openApiConfiguration) {
+        this.config = ContextUtils.deepCopy(ContextUtils.cloneConfigFromInterface(openApiConfiguration));
+    }
+
     public OpenAPI read(Set<Class<?>> classes, Map<String, Object> resources) {
         return read(classes);
     }

modules/swagger-jaxrs2/src/main/java/io/swagger/jaxrs2/integration/JaxrsAnnotationScanner.java

@@ -1,7 +1,8 @@
 package io.swagger.jaxrs2.integration;
 
+import io.swagger.oas.integration.ContextUtils;
 import io.swagger.oas.integration.OpenApiConfiguration;
-import io.swagger.oas.web.OpenApiScanner;
+import io.swagger.oas.web.OpenAPIConfig;
 import org.reflections.Reflections;
 import org.reflections.scanners.ResourcesScanner;
 import org.reflections.scanners.SubTypesScanner;
@@ -11,21 +12,40 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.ws.rs.core.Application;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
 
-public class JaxrsAnnotationScanner<T extends JaxrsAnnotationScanner<T>> implements OpenApiScanner {
+public class JaxrsAnnotationScanner<T extends JaxrsAnnotationScanner<T>> implements JaxrsOpenApiScanner {
 
-    private OpenApiConfiguration openApiConfiguration;
+    protected OpenApiConfiguration openApiConfiguration;
+    protected Application application;
     protected static Logger LOGGER = LoggerFactory.getLogger(JaxrsAnnotationScanner.class);
 
+    public JaxrsAnnotationScanner application (Application application) {
+        this.application = application;
+        return this;
+    }
+
+    @Override
+    public void setApplication(Application application) {
+        this.application = application;
+    }
+
+
+
     public T openApiConfiguration (OpenApiConfiguration openApiConfiguration) {
         this.openApiConfiguration = openApiConfiguration;
         return (T)this;
     }
 
+    @Override
+    public void setConfiguration(OpenAPIConfig openApiConfiguration) {
+        this.openApiConfiguration = ContextUtils.cloneConfigFromInterface(openApiConfiguration);
+    }
+
     @Override
     public Set<Class<?>> classes() {
 

modules/swagger-jaxrs2/src/main/java/io/swagger/jaxrs2/integration/JaxrsApplicationAndAnnotationScanner.java

@@ -1,28 +1,21 @@
 package io.swagger.jaxrs2.integration;
 
-import javax.ws.rs.core.Application;
 import java.util.HashSet;
 import java.util.Set;
 
 public class JaxrsApplicationAndAnnotationScanner extends JaxrsAnnotationScanner<JaxrsApplicationAndAnnotationScanner> {
 
-    private Application app;
-
-    public JaxrsApplicationAndAnnotationScanner application (Application app) {
-        this.app = app;
-        return this;
-    }
 
     @Override
     public Set<Class<?>> classes() {
         Set<Class<?>> classes = super.classes();
         Set<Class<?>> output = new HashSet<Class<?>>();
-        if (app != null) {
-            Set<Class<?>> clz = app.getClasses();
+        if (application != null) {
+            Set<Class<?>> clz = application.getClasses();
             if (clz != null) {
                 output.addAll(clz);
             }
-            Set<Object> singletons = app.getSingletons();
+            Set<Object> singletons = application.getSingletons();
             if (singletons != null) {
                 for (Object o : singletons) {
                     output.add(o.getClass());

modules/swagger-jaxrs2/src/main/java/io/swagger/jaxrs2/integration/JaxrsApplicationScanner.java

@@ -1,27 +1,19 @@
 package io.swagger.jaxrs2.integration;
 
-import javax.ws.rs.core.Application;
 import java.util.HashSet;
 import java.util.Set;
 
 public class JaxrsApplicationScanner extends JaxrsAnnotationScanner<JaxrsApplicationScanner> {
 
-    private Application app;
-
-    public JaxrsApplicationScanner application (Application app) {
-        this.app = app;
-        return this;
-    }
-
     @Override
     public Set<Class<?>> classes() {
         Set<Class<?>> output = new HashSet<Class<?>>();
-        if (app != null) {
-            Set<Class<?>> clz = app.getClasses();
+        if (application != null) {
+            Set<Class<?>> clz = application.getClasses();
             if (clz != null) {
                 output.addAll(clz);
             }
-            Set<Object> singletons = app.getSingletons();
+            Set<Object> singletons = application.getSingletons();
             if (singletons != null) {
                 for (Object o : singletons) {
                     output.add(o.getClass());

modules/swagger-jaxrs2/src/main/java/io/swagger/jaxrs2/integration/JaxrsOpenApiContext.java

@@ -32,25 +32,28 @@ protected OpenApiReader buildReader(OpenApiConfiguration openApiConfiguration) t
         OpenApiReader reader;
         if (StringUtils.isNotBlank(openApiConfiguration.getReaderClass())) {
             Class cls = getClass().getClassLoader().loadClass(openApiConfiguration.getReaderClass());
-            // TODO instantiate with configuration
             reader = (OpenApiReader) cls.newInstance();
         } else {
             reader = new Reader(openApiConfiguration);
         }
+        reader.setConfiguration(openApiConfiguration);
         return reader;
     }
 
     @Override
     protected OpenApiScanner buildScanner(OpenApiConfiguration openApiConfiguration) throws Exception {
+
         OpenApiScanner scanner;
         if (StringUtils.isNotBlank(openApiConfiguration.getScannerClass())) {
             Class cls = getClass().getClassLoader().loadClass(openApiConfiguration.getScannerClass());
-            // TODO instantiate with configuration
             scanner = (OpenApiScanner) cls.newInstance();
         } else {
-            scanner = new JaxrsApplicationAndAnnotationScanner().application(app).openApiConfiguration(openApiConfiguration);
+            scanner = new JaxrsApplicationAndAnnotationScanner();
+        }
+        scanner.setConfiguration(openApiConfiguration);
+        if (scanner instanceof JaxrsOpenApiScanner) {
+            ((JaxrsOpenApiScanner)scanner).setApplication(app);
         }
         return scanner;
     }
-
 }