SORMAS-Foundation#3372 create new external resource config, move external resources to separate package

Author: [email protected]

sormas-rest/src/main/java/de/symeda/sormas/rest/RestConfig.java

@@ -17,6 +17,14 @@
  *******************************************************************************/
 package de.symeda.sormas.rest;
 
+import com.google.common.collect.Sets;
+import de.symeda.sormas.rest.external.ExternalVisitsResource;
+import io.swagger.v3.jaxrs2.integration.resources.OpenApiResource;
+import io.swagger.v3.oas.integration.SwaggerConfiguration;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
 import org.glassfish.jersey.jackson.JacksonFeature;
 import org.glassfish.jersey.server.ResourceConfig;
 import org.glassfish.jersey.server.filter.RolesAllowedDynamicFeature;

sormas-rest/src/main/java/de/symeda/sormas/rest/external/ExternalRestResourceConfig.java

@@ -0,0 +1,62 @@
+package de.symeda.sormas.rest.external;
+
+import javax.servlet.ServletConfig;
+import javax.ws.rs.ApplicationPath;
+import javax.ws.rs.core.Context;
+
+import io.swagger.v3.jaxrs2.Reader;
+import io.swagger.v3.jaxrs2.integration.JaxrsOpenApiContextBuilder;
+import io.swagger.v3.oas.integration.OpenApiConfigurationException;
+import org.glassfish.jersey.jackson.JacksonFeature;
+import org.glassfish.jersey.server.ResourceConfig;
+import org.glassfish.jersey.server.filter.RolesAllowedDynamicFeature;
+
+import com.google.common.collect.Sets;
+
+import de.symeda.sormas.rest.swagger.SwaggerConfig;
+import io.swagger.v3.jaxrs2.integration.resources.OpenApiResource;
+import io.swagger.v3.oas.integration.SwaggerConfiguration;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+
+/**
+ * Resource configuration used only for external resources i.e. for external systems which communicate with SORMAS
+ * Separate from the other resource configuration in order to limit create the swagger documentation only for resources in this package
+ */
+@ApplicationPath("/")
+public class ExternalRestResourceConfig extends ResourceConfig {
+
+	@Context
+	private ServletConfig servletConfig;
+
+	public ExternalRestResourceConfig() {
+
+		super(ExternalRestResourceConfig.class);
+
+		packages(getClass().getPackage().getName());
+		register(RolesAllowedDynamicFeature.class);
+		register(JacksonFeature.class);
+
+		SwaggerConfig.init();
+
+		Info info = new Info().title("SORMAS external symptom journal API")
+			.description(
+				"The purpose of this API is to enable communication between SORMAS and other symptom journals. "
+					+ "Only users with the role ``REST_EXTERNAL_VISITS_USER`` are authorized to use the endpoints. "
+					+ "If you would like to receive access, please contact the team to have a user set up. "
+					+ "Authentication is done using basic auth, with the user and password.")
+			.contact(new Contact().url("https://gitter.im/SORMAS-Project/dev-support"))
+			.license(new License().name("GNU General Public License").url("https://www.gnu.org/licenses/"));
+
+		Reader reader = new Reader(new OpenAPI().info(info));
+		OpenAPI openAPI = reader.read(ExternalVisitsResource.class);
+		SwaggerConfiguration openAPIConfiguration = new SwaggerConfiguration().prettyPrint(true)
+			.openAPI(openAPI)
+			.resourceClasses(Sets.newHashSet(ExternalVisitsResource.class.getSimpleName()));
+		OpenApiResource openApiResource = new OpenApiResource();
+		openApiResource.setOpenApiConfiguration(openAPIConfiguration);
+		register(openApiResource);
+	}
+}

…/sormas/rest/ExternalVisitsResource.java …est/external/ExternalVisitsResource.javasormas-rest/src/main/java/de/symeda/sormas/rest/ExternalVisitsResource.java renamed to sormas-rest/src/main/java/de/symeda/sormas/rest/external/ExternalVisitsResource.java sormas-rest/src/main/java/de/symeda/sormas/rest/ExternalVisitsResource.java renamed to sormas-rest/src/main/java/de/symeda/sormas/rest/external/ExternalVisitsResource.java

@@ -1,33 +1,30 @@
-package de.symeda.sormas.rest;
+package de.symeda.sormas.rest.external;
+
+import java.util.Date;
+import java.util.List;
+
+import javax.annotation.security.RolesAllowed;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
 
 import de.symeda.sormas.api.FacadeProvider;
 import de.symeda.sormas.api.PushResult;
 import de.symeda.sormas.api.person.JournalPersonDto;
 import de.symeda.sormas.api.person.PersonFollowUpEndDto;
-import de.symeda.sormas.api.person.PersonDto;
-import de.symeda.sormas.api.person.PersonQuarantineEndDto;
 import de.symeda.sormas.api.person.PersonSymptomJournalStatusDto;
 import de.symeda.sormas.api.visit.ExternalVisitDto;
+import de.symeda.sormas.rest.EntityDtoResource;
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 
-import javax.annotation.security.RolesAllowed;
-import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
-import javax.ws.rs.POST;
-import javax.ws.rs.Path;
-import javax.ws.rs.PathParam;
-import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
-import javax.ws.rs.core.MediaType;
-import java.util.Date;
-import java.util.List;
-
 @Path("/visits-external")
 @Produces(MediaType.APPLICATION_JSON + "; charset=UTF-8")
 @Consumes(MediaType.APPLICATION_JSON + "; charset=UTF-8")