Merge pull request #39 from com-pas/support-multi-versions-scl

Support multi versions SCL

Author: Rob Tjalma

.reuse/dep5

@@ -10,3 +10,11 @@ License: Apache-2.0
 Files: .mvn/wrapper/*
 Copyright: 2021 Alliander N.V.
 License: Apache-2.0
+
+Files: doc/images/*
+Copyright: 2021 Alliander N.V.
+License: Apache-2.0
+
+Files: doc/drawio/*
+Copyright: 2021 Alliander N.V.
+License: Apache-2.0

README.md

@@ -11,8 +11,11 @@ SPDX-License-Identifier: Apache-2.0
 
 Service to store and retrieve the SCL XML to a database.
 
-This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please
-visit its website: https://quarkus.io/ .
+In the standard configuration this component is using Quarkus to run and create a native image from it. The different
+parts of this repository can also be used separately in your own component to manage SCL XML Files in a database. The
+Service Layer can be used as Java component to manage them.
+
+For more information about the architecture take a look at [documentation](doc/compas-scl-data-service.md)
 
 ## Application depends on a running BaseX instance
 

app/pom.xml

@@ -155,5 +155,25 @@ SPDX-License-Identifier: Apache-2.0
                 </plugins>
             </build>
         </profile>
+
+        <profile>
+            <id>sonar</id>
+
+            <properties>
+                <sonar.coverage.jacoco.xmlReportPaths>target/jacoco-report/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
+            </properties>
+
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <configuration>
+                            <skip>true</skip>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
     </profiles>
 </project>

app/src/main/java/org/lfenergy/compas/scl/data/rest/CompasJAXBContextResolver.java

@@ -5,33 +5,21 @@
 package org.lfenergy.compas.scl.data.rest.model;
 
 import org.eclipse.microprofile.openapi.annotations.media.Schema;
-import org.lfenergy.compas.scl.model.SCL;
+import org.w3c.dom.Element;
 
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.*;
 
-import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
-import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
 
-@XmlRootElement(name = "CreateRequest", namespace = SDS_NAMESPACE)
+@XmlRootElement(name = "CreateRequest", namespace = SCL_DATA_SERVICE_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class CreateRequest {
-    @Schema(example = "SCL XML...")
-    @XmlElement(name = "SCL", namespace = SCL_NAMESPACE, required = true)
-    private SCL scl;
     @Schema(example = "STATION-0012312")
-    @XmlElement(name = "Name", namespace = SDS_NAMESPACE, required = true)
+    @XmlElement(name = "Name", namespace = SCL_DATA_SERVICE_NS_URI, required = true)
     private String name;
-
-    public SCL getScl() {
-        return scl;
-    }
-
-    public void setScl(SCL scl) {
-        this.scl = scl;
-    }
+    @Schema(example = "SCL XML...")
+    @XmlAnyElement
+    protected Element scl;
 
     public String getName() {
         return name;
@@ -40,4 +28,13 @@ public String getName() {
     public void setName(String name) {
         this.name = name;
     }
+
+    public Element getScl() {
+        return scl;
+    }
+
+    public void setScl(Element scl) {
+        this.scl = scl;
+    }
 }
+

app/src/main/java/org/lfenergy/compas/scl/data/rest/CompasSclDataConfiguration.java

@@ -10,12 +10,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.UUID;
 
-import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
 
-@XmlRootElement(name = "CreateResponse", namespace = SDS_NAMESPACE)
+@XmlRootElement(name = "CreateResponse", namespace = SCL_DATA_SERVICE_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class CreateResponse {
-    @XmlElement(name = "Id", namespace = SDS_NAMESPACE, required = true)
+    @XmlElement(name = "Id", namespace = SCL_DATA_SERVICE_NS_URI, required = true)
     private UUID id;
 
     public UUID getId() {

app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateRequest.java

@@ -5,28 +5,27 @@
 package org.lfenergy.compas.scl.data.rest.model;
 
 import org.eclipse.microprofile.openapi.annotations.media.Schema;
-import org.lfenergy.compas.scl.model.SCL;
+import org.w3c.dom.Element;
 
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlAnyElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
-import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
 
-@XmlRootElement(name = "GetResponse", namespace = SDS_NAMESPACE)
+@XmlRootElement(name = "GetResponse", namespace = SCL_DATA_SERVICE_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class GetResponse {
     @Schema(example = "SCL XML...")
-    @XmlElement(name = "SCL", namespace = SCL_NAMESPACE, required = true)
-    private SCL scl;
+    @XmlAnyElement
+    protected Element scl;
 
-    public SCL getScl() {
+    public Element getScl() {
         return scl;
     }
 
-    public void setScl(SCL scl) {
+    public void setScl(Element scl) {
         this.scl = scl;
     }
 }

app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateResponse.java

@@ -11,12 +11,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.List;
 
-import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
 
-@XmlRootElement(name = "ListResponse", namespace = SDS_NAMESPACE)
+@XmlRootElement(name = "ListResponse", namespace = SCL_DATA_SERVICE_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class ListResponse {
-    @XmlElement(name = "Item", namespace = SDS_NAMESPACE)
+    @XmlElement(name = "Item", namespace = SCL_DATA_SERVICE_NS_URI)
     private List<Item> items;
 
     public List<Item> getItems() {