From 9f0fe65a9f7298902e56a000d483bc04c4aedf5a Mon Sep 17 00:00:00 2001
From: Fabio Sinibaldi <fabio.sinibaldi@isti.cnr.it>
Date: Mon, 2 May 2022 16:39:50 +0200
Subject: [PATCH] Enunciate integration

---
 .../common/model/useCaseDescriptor/Field.java | 10 +--
 geoportal-service/enunciate.xml               | 41 ++++++++++
 geoportal-service/pom.xml                     | 77 ++++++++++++++++++-
 .../geoportal/service/rest/DocsGenerator.java | 41 ++++++++++
 .../src/main/webapp/WEB-INF/gcube-app.xml     |  3 +
 5 files changed, 166 insertions(+), 6 deletions(-)
 create mode 100644 geoportal-service/enunciate.xml
 create mode 100644 geoportal-service/src/main/java/org/gcube/application/geoportal/service/rest/DocsGenerator.java

diff --git a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/useCaseDescriptor/Field.java b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/useCaseDescriptor/Field.java
index 580b83e..c994d8a 100644
--- a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/useCaseDescriptor/Field.java
+++ b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/useCaseDescriptor/Field.java
@@ -10,11 +10,11 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-@XmlRootElement
-@AllArgsConstructor
-@Getter
-@Setter
-@ToString(callSuper = true)
+//@XmlRootElement
+//@AllArgsConstructor
+//@Getter
+//@Setter
+//@ToString(callSuper = true)
 public class Field extends Document {
 
     public static final String TYPE="_type";
diff --git a/geoportal-service/enunciate.xml b/geoportal-service/enunciate.xml
new file mode 100644
index 0000000..08d43a3
--- /dev/null
+++ b/geoportal-service/enunciate.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<enunciate
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="http://enunciate.webcohesion.com/schemas/enunciate-2.14.0.xsd">
+    <api-classes>
+        <exclude
+                pattern="org.gcube.application.geoportal.service.rest.DocsGenerator" />
+
+        <!--        Exclude legacy method-->
+        <exclude pattern="org.gcube.application.geoportal.common.model.legacy.**"/>
+        <exclude
+                pattern="org.gcube.application.geoportal.service.rest.ConcessioniOverMongo"/>
+
+        <!--        Issue with lombok?-->
+        <exclude pattern="org.gcube.application.geoportal.common.model.useCaseDescriptor.Field"/>
+
+
+        <include
+                pattern="org.gcube.application.geoportal.common.model.**"/>
+        <include
+                pattern="org.gcube.application.geoportal.common.rest.**"/>
+
+        <include
+                pattern="org.bson.**"/>
+
+    </api-classes>
+    <modules>
+        <gwt-json-overlay disabled="true" />
+        <php-json-client disabled="true" />
+        <ruby-json-client disabled="true" />
+        <java-json-client disabled="true" />
+        <javascript-client disabled="true" />
+        <docs docsDir="${project.build.directory}" docsSubdir="docs" freemarkerTemplate="${project.basedir}/src/main/resources/META-INF/enunciate/d4science_docs.fmt">
+            <additional-css file="css/d4science_enunciate_custom.css" />
+        </docs>
+
+        <!-- REPLACE THE ${project.artifactId} WITH YOUR APPLICATION NAME. E.g. /gcat, /uri-resolver. if the ${project.artifactId} is not matching your APPLICATION Name /> -->
+        <swagger basePath="/${project.artifactId}" />
+
+    </modules>
+</enunciate>
diff --git a/geoportal-service/pom.xml b/geoportal-service/pom.xml
index 9910686..7b22bb2 100644
--- a/geoportal-service/pom.xml
+++ b/geoportal-service/pom.xml
@@ -17,7 +17,7 @@
 	<properties>
 		<gitBaseUrl>https://code-repo.d4science.org/gCubeSystem</gitBaseUrl>
 		<sis.version>1.0</sis.version>
-
+		<enunciate.version>2.14.0</enunciate.version>
 	</properties>
 
 
@@ -114,6 +114,25 @@
 			</exclusions>
 		</dependency>
 
+		<!-- enunciate deps -->
+		<dependency>
+			<groupId>com.webcohesion.enunciate</groupId>
+			<artifactId>enunciate-core-annotations</artifactId>
+			<version>${enunciate.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<dependency>
+			<groupId>com.webcohesion.enunciate</groupId>
+			<artifactId>enunciate-rt-util</artifactId>
+			<version>${enunciate.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>javax.servlet-api</artifactId>
+			<version>3.1.0</version>
+			<scope>provided</scope>
+		</dependency>
 
 		<!-- DEPRECATED LEGACY LOGIC SUPPORT -->
 
@@ -169,4 +188,60 @@
 		</dependency>
 
 	</dependencies>
+
+	<build>
+		<plugins>
+			<!-- Enunciate Maven plugin -->
+			<plugin>
+				<groupId>com.webcohesion.enunciate</groupId>
+				<artifactId>enunciate-maven-plugin</artifactId>
+				<version>${enunciate.version}</version>
+				<configuration>
+					<sourcepath-includes>
+						<sourcepath-include>
+							<!-- Include the "com.external:external" artifact on the sourcepath. -->
+							<groupId>org.gcube.application</groupId>
+							<artifactId>geoportal-client</artifactId>
+						</sourcepath-include>
+					</sourcepath-includes>
+				</configuration>
+				<executions>
+					<execution>
+						<id>assemble</id>
+						<goals>
+							<goal>assemble</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+
+			<!-- Copy Enunciate Documentation from your-application/docs to your-application.war -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-resources-plugin</artifactId>
+				<version>2.5</version>
+				<executions>
+					<execution>
+						<id>copy-enunciate-docs</id>
+						<phase>process-resources</phase>
+						<goals>
+							<goal>copy-resources</goal>
+						</goals>
+						<configuration>
+							<outputDirectory>target</outputDirectory>
+							<resources>
+								<resource>
+									<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/docs</targetPath>
+									<directory>${project.build.directory}/docs</directory>
+									<filtering>true</filtering>
+								</resource>
+							</resources>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+
+		</plugins>
+	</build>
+
 </project>
\ No newline at end of file
diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/rest/DocsGenerator.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/rest/DocsGenerator.java
new file mode 100644
index 0000000..f9b4d13
--- /dev/null
+++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/rest/DocsGenerator.java
@@ -0,0 +1,41 @@
+package org.gcube.application.geoportal.service.rest;
+import lombok.extern.slf4j.Slf4j;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.Response;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+
+@Path("docs")
+@Slf4j
+public class DocsGenerator {
+
+    @GET
+    @Path("/{any: .*}")
+    public InputStream toDoc(@Context HttpServletRequest req) throws WebApplicationException {
+        log.info(DocsGenerator.class.getSimpleName() + " toDoc called");
+
+        String pathInfo = req.getPathInfo();
+        log.debug("pathInfo {}", pathInfo);
+        try {
+
+            if (pathInfo.endsWith("/docs/")) {
+                pathInfo += "index.html";
+            }
+
+            log.info("going to {}", pathInfo);
+
+            String realPath = req.getServletContext().getRealPath(pathInfo);
+            return new FileInputStream(new File(realPath));
+
+        } catch (Exception e) {
+            log.error("Exception while Docs. Request was {}",req,e);
+            throw new WebApplicationException("Doc Exception ",e, Response.Status.INTERNAL_SERVER_ERROR);
+        }
+    }
+}
diff --git a/geoportal-service/src/main/webapp/WEB-INF/gcube-app.xml b/geoportal-service/src/main/webapp/WEB-INF/gcube-app.xml
index ced0697..cee5117 100644
--- a/geoportal-service/src/main/webapp/WEB-INF/gcube-app.xml
+++ b/geoportal-service/src/main/webapp/WEB-INF/gcube-app.xml
@@ -4,5 +4,8 @@
 		<version>1.0.0</version>
 		<description>REST service for GeoPortal</description>		
 		<local-persistence location='target' />
+
+<!--	Enunciate? -->
+<!--	<exclude>/docs/*</exclude>-->
 </application>