Merge pull request #55 from com-pas/develop

Develop -> Master (Release)

Author: Dennis Labordus

app/pom.xml

@@ -37,15 +37,22 @@ SPDX-License-Identifier: Apache-2.0
         <dependency>
             <groupId>org.lfenergy.compas.scl.data</groupId>
             <artifactId>service</artifactId>
-            <version>${project.version}</version>
         </dependency>
         <dependency>
             <groupId>org.lfenergy.compas.scl.data</groupId>
             <artifactId>repository-basex</artifactId>
-            <version>${project.version}</version>
             <scope>runtime</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.lfenergy.compas.core</groupId>
+            <artifactId>commons</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.lfenergy.compas.core</groupId>
+            <artifactId>rest-commons</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc</artifactId>
@@ -70,6 +77,10 @@ SPDX-License-Identifier: Apache-2.0
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-container-image-docker</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-hibernate-validator</artifactId>
+        </dependency>
 
         <!-- Test Dependencies -->
         <dependency>

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

@@ -0,0 +1,30 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.data.rest;
+
+import org.lfenergy.compas.core.commons.ElementConverter;
+import org.lfenergy.compas.scl.data.util.SclDataModelMarshaller;
+import org.lfenergy.compas.scl.data.util.SclElementProcessor;
+
+import javax.enterprise.inject.Produces;
+
+/**
+ * Create Beans from other dependencies that are used in the application.
+ */
+public class CompasSclDataServiceConfiguration {
+    @Produces
+    public ElementConverter createElementConverter() {
+        return new ElementConverter();
+    }
+
+    @Produces
+    public SclElementProcessor creatSclElementProcessor() {
+        return new SclElementProcessor();
+    }
+
+    @Produces
+    public SclDataModelMarshaller createSclDataModelMarshaller() {
+        return new SclDataModelMarshaller();
+    }
+}

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

@@ -4,8 +4,8 @@
 package org.lfenergy.compas.scl.data.rest.v1;
 
 import org.lfenergy.compas.scl.data.model.SclType;
-import org.lfenergy.compas.scl.data.rest.model.Type;
-import org.lfenergy.compas.scl.data.rest.model.TypeListResponse;
+import org.lfenergy.compas.scl.data.rest.v1.model.Type;
+import org.lfenergy.compas.scl.data.rest.v1.model.TypeListResponse;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;

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

@@ -3,13 +3,14 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.data.rest.v1;
 
+import org.lfenergy.compas.core.commons.ElementConverter;
 import org.lfenergy.compas.scl.data.model.SclType;
 import org.lfenergy.compas.scl.data.model.Version;
-import org.lfenergy.compas.scl.data.rest.model.*;
+import org.lfenergy.compas.scl.data.rest.v1.model.*;
 import org.lfenergy.compas.scl.data.service.CompasSclDataService;
-import org.lfenergy.compas.scl.data.util.SclElementConverter;
 
 import javax.inject.Inject;
+import javax.validation.Valid;
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
 import java.util.UUID;
@@ -20,7 +21,7 @@
 public class CompasSclDataResource {
     private CompasSclDataService compasSclDataService;
 
-    private SclElementConverter converter = new SclElementConverter();
+    private ElementConverter converter = new ElementConverter();
 
     @Inject
     public CompasSclDataResource(CompasSclDataService compasSclDataService) {
@@ -31,9 +32,9 @@ public CompasSclDataResource(CompasSclDataService compasSclDataService) {
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
     public CreateResponse create(@PathParam(TYPE_PATH_PARAM) SclType type,
-                                 CreateRequest request) {
+                                 @Valid CreateRequest request) {
         var response = new CreateResponse();
-        response.setId(compasSclDataService.create(type, request.getName(), request.getScl()));
+        response.setId(compasSclDataService.create(type, request.getName(), request.getElements().get(0)));
         return response;
     }
 
@@ -102,8 +103,8 @@ public String findRawSCLByUUIDAndVersion(@PathParam(TYPE_PATH_PARAM) SclType typ
     @Produces(MediaType.APPLICATION_XML)
     public void update(@PathParam(TYPE_PATH_PARAM) SclType type,
                        @PathParam(ID_PATH_PARAM) UUID id,
-                       UpdateRequest request) {
-        compasSclDataService.update(type, id, request.getChangeSetType(), request.getScl());
+                       @Valid UpdateRequest request) {
+        compasSclDataService.update(type, id, request.getChangeSetType(), request.getElements().get(0));
     }
 
     @DELETE

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

@@ -0,0 +1,51 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.scl.data.rest.v1.model;
+
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+import org.lfenergy.compas.core.commons.constraint.FilenameValid;
+import org.lfenergy.compas.core.commons.constraint.XmlAnyElementValid;
+import org.w3c.dom.Element;
+
+import javax.validation.constraints.Size;
+import javax.xml.bind.annotation.*;
+import java.util.List;
+
+import static org.lfenergy.compas.scl.data.SclDataServiceConstants.SCL_DATA_SERVICE_V1_NS_URI;
+import static org.lfenergy.compas.scl.data.SclDataServiceConstants.SCL_NS_URI;
+
+@Schema(description = "A request to create a new entry in the database containing the SCL Element content.")
+@XmlRootElement(name = "CreateRequest", namespace = SCL_DATA_SERVICE_V1_NS_URI)
+@XmlAccessorType(XmlAccessType.FIELD)
+public class CreateRequest {
+    @FilenameValid
+    @Schema(description = "The name that will be stored as Private Element and can later be used to determine the filename.",
+            example = "STATION-0012312")
+    @XmlElement(name = "Name", namespace = SCL_DATA_SERVICE_V1_NS_URI, required = true)
+    private String name;
+
+    @Size(min = 1, max = 1, message = "{org.lfenergy.compas.XmlAnyElementValid.moreElements.message}")
+    @XmlAnyElementValid(elementName = "SCL", elementNamespace = SCL_NS_URI)
+    @Schema(description = "Can contain one element, named 'SCL', containing a SCL XML Definition")
+    @XmlAnyElement
+    private List<Element> elements;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public List<Element> getElements() {
+        return elements;
+    }
+
+    public void setElements(List<Element> elements) {
+        this.elements = elements;
+    }
+}
+

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

@@ -2,20 +2,20 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-package org.lfenergy.compas.scl.data.rest.model;
+package org.lfenergy.compas.scl.data.rest.v1.model;
 
 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 java.util.UUID;
 
-import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
+import static org.lfenergy.compas.scl.data.SclDataServiceConstants.SCL_DATA_SERVICE_V1_NS_URI;
 
-@XmlRootElement(name = "CreateResponse", namespace = SCL_DATA_SERVICE_NS_URI)
+@XmlRootElement(name = "CreateResponse", namespace = SCL_DATA_SERVICE_V1_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class CreateResponse {
-    @XmlElement(name = "Id", namespace = SCL_DATA_SERVICE_NS_URI, required = true)
+    @XmlElement(name = "Id", namespace = SCL_DATA_SERVICE_V1_NS_URI, required = true)
     private UUID id;
 
     public UUID getId() {

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

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-package org.lfenergy.compas.scl.data.rest.model;
+package org.lfenergy.compas.scl.data.rest.v1.model;
 
 import org.eclipse.microprofile.openapi.annotations.media.Schema;
 import org.w3c.dom.Element;
@@ -12,9 +12,9 @@
 import javax.xml.bind.annotation.XmlAnyElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
+import static org.lfenergy.compas.scl.data.SclDataServiceConstants.SCL_DATA_SERVICE_V1_NS_URI;
 
-@XmlRootElement(name = "GetResponse", namespace = SCL_DATA_SERVICE_NS_URI)
+@XmlRootElement(name = "GetResponse", namespace = SCL_DATA_SERVICE_V1_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class GetResponse {
     @Schema(example = "SCL XML...")

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

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2021 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.data.rest.model;
+package org.lfenergy.compas.scl.data.rest.v1.model;
 
 import org.lfenergy.compas.scl.data.model.Item;
 
@@ -11,12 +11,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.List;
 
-import static org.lfenergy.compas.scl.data.Constants.SCL_DATA_SERVICE_NS_URI;
+import static org.lfenergy.compas.scl.data.SclDataServiceConstants.SCL_DATA_SERVICE_V1_NS_URI;
 
-@XmlRootElement(name = "ListResponse", namespace = SCL_DATA_SERVICE_NS_URI)
+@XmlRootElement(name = "ListResponse", namespace = SCL_DATA_SERVICE_V1_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class ListResponse {
-    @XmlElement(name = "Item", namespace = SCL_DATA_SERVICE_NS_URI)
+    @XmlElement(name = "Item", namespace = SCL_DATA_SERVICE_V1_NS_URI)
     private List<Item> items;
 
     public List<Item> getItems() {