Merge pull request #35 from com-pas/namespace-prefix-fix

Rob Tjalma · web-flow · commit c16d93cffad7 · 2021-06-30T12:09:24.000+02:00
Namespace prefix fix
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/Constants.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/Constants.java
@@ -7,8 +7,6 @@ public final class Constants {
     private Constants() {
     }
 
-    public static final String SCL_NAMESPACE = "http://www.iec.ch/61850/2003/SCL";
-
     public static final String TYPE_PATH_PARAM = "type";
     public static final String ID_PATH_PARAM = "id";
     public static final String VERSION_PATH_PARAM = "version";
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateRequest.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateRequest.java
@@ -12,16 +12,17 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import static org.lfenergy.compas.scl.data.rest.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
 
-@XmlRootElement(name = "CreateRequest")
+@XmlRootElement(name = "CreateRequest", namespace = SDS_NAMESPACE)
 @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", required = true)
+    @XmlElement(name = "Name", namespace = SDS_NAMESPACE, required = true)
     private String name;
 
     public SCL getScl() {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/CreateResponse.java
@@ -10,10 +10,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.UUID;
 
-@XmlRootElement(name = "CreateResponse")
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
+@XmlRootElement(name = "CreateResponse", namespace = SDS_NAMESPACE)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class CreateResponse {
-    @XmlElement(name = "Id", required = true)
+    @XmlElement(name = "Id", namespace = SDS_NAMESPACE, required = true)
     private UUID id;
 
     public UUID getId() {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/GetResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/GetResponse.java
@@ -12,9 +12,10 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import static org.lfenergy.compas.scl.data.rest.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
 
-@XmlRootElement(name = "GetResponse")
+@XmlRootElement(name = "GetResponse", namespace = SDS_NAMESPACE)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class GetResponse {
     @Schema(example = "SCL XML...")
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/ListResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/ListResponse.java
@@ -11,10 +11,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.List;
 
-@XmlRootElement(name = "ListResponse")
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
+@XmlRootElement(name = "ListResponse", namespace = SDS_NAMESPACE)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class ListResponse {
-    @XmlElement(name = "Item")
+    @XmlElement(name = "Item", namespace = SDS_NAMESPACE)
     private List<Item> items;
 
     public List<Item> getItems() {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/Type.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/Type.java
@@ -7,11 +7,13 @@
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
 
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
 @XmlAccessorType(XmlAccessType.FIELD)
 public class Type {
-    @XmlElement(name = "Code")
+    @XmlElement(name = "Code", namespace = SDS_NAMESPACE)
     private String code;
-    @XmlElement(name = "Description")
+    @XmlElement(name = "Description", namespace = SDS_NAMESPACE)
     private String description;
 
     public Type(String code, String description) {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/TypeListResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/TypeListResponse.java
@@ -10,10 +10,12 @@
 import java.util.ArrayList;
 import java.util.List;
 
-@XmlRootElement(name = "TypeListResponse")
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
+@XmlRootElement(name = "TypeListResponse", namespace = SDS_NAMESPACE)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class TypeListResponse {
-    @XmlElement(name = "Type")
+    @XmlElement(name = "Type", namespace = SDS_NAMESPACE)
     private List<Type> types = new ArrayList<>();
 
     public void setTypes(List<Type> types) {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/UpdateRequest.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/UpdateRequest.java
@@ -13,7 +13,8 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import static org.lfenergy.compas.scl.data.rest.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
 
 @XmlRootElement(name = "UpdateRequest")
 @XmlAccessorType(XmlAccessType.FIELD)
@@ -22,7 +23,7 @@ public class UpdateRequest {
     @XmlElement(name = "SCL", namespace = SCL_NAMESPACE, required = true)
     private SCL scl;
     @Schema(example = "MAJOR")
-    @XmlElement(name = "ChangeSet", required = true)
+    @XmlElement(name = "ChangeSet", namespace = SDS_NAMESPACE, required = true)
     private ChangeSetType changeSetType;
 
     public SCL getScl() {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/VersionsResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/VersionsResponse.java
@@ -11,10 +11,12 @@
 import javax.xml.bind.annotation.XmlRootElement;
 import java.util.List;
 
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
 @XmlRootElement(name = "VersionsResponse")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class VersionsResponse {
-    @XmlElement(name = "Item")
+    @XmlElement(name = "Item", namespace = SDS_NAMESPACE)
     private List<Item> items;
 
     public List<Item> getItems() {
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/package-info.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/model/package-info.java
@@ -2,13 +2,15 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 @XmlSchema(
-        namespace = "https://www.lfenergy.org/compas/SclDataService",
+        namespace = SDS_NAMESPACE,
         xmlns = {
                 @XmlNs(prefix = "scl", namespaceURI = "http://www.iec.ch/61850/2003/SCL"),
                 @XmlNs(prefix = "compas", namespaceURI = "https://www.lfenergy.org/compas/v1"),
-                @XmlNs(prefix = "sds", namespaceURI = "https://www.lfenergy.org/compas/SclDataService")
+                @XmlNs(prefix = "sds", namespaceURI = SDS_NAMESPACE)
         })
 package org.lfenergy.compas.scl.data.rest.model;
 
 import javax.xml.bind.annotation.XmlNs;
-import javax.xml.bind.annotation.XmlSchema;
+import javax.xml.bind.annotation.XmlSchema;
+
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
diff --git a/app/src/test/java/org/lfenergy/compas/scl/data/rest/v1/CompasSclDataResourceTest.java b/app/src/test/java/org/lfenergy/compas/scl/data/rest/v1/CompasSclDataResourceTest.java
@@ -24,6 +24,7 @@
 import static io.restassured.RestAssured.given;
 import static io.restassured.path.xml.config.XmlPathConfig.xmlPathConfig;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.lfenergy.compas.scl.data.model.Constants.SCL_NAMESPACE;
 import static org.lfenergy.compas.scl.data.rest.Constants.*;
 import static org.mockito.Mockito.*;
 
diff --git a/repository-basex/src/main/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepository.java b/repository-basex/src/main/java/org/lfenergy/compas/scl/data/repository/CompasSclDataBaseXRepository.java
@@ -27,6 +27,7 @@
 
 import static java.lang.String.format;
 import static org.lfenergy.compas.commons.CommonConstants.XML_DEFAULT_NS_URI;
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
 import static org.lfenergy.compas.scl.extensions.common.CompasExtensionsConstants.COMPAS_EXTENSION_NS;
 import static org.lfenergy.compas.scl.extensions.common.CompasExtensionsConstants.COMPAS_SCL_EXTENSION_TYPE;
 import static org.lfenergy.compas.scl.extensions.common.CompasExtensionsField.SCL_NAME_EXTENSION;
@@ -87,7 +88,7 @@ public List<Item> list(SclType type) {
                         "   let $latestScl := local:latest-version($db, $id)\n" +
                         "   let $version := $latestScl//scl:SCL/scl:Header/@version\n" +
                         "   let $name := $latestScl//scl:SCL/scl:Private[@type='" + COMPAS_SCL_EXTENSION_TYPE + "']/compas:" + SCL_NAME_EXTENSION.getFieldName() + "\n" +
-                        "   return '<Item><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>'",
+                        "   return '<Item xmlns=\"" + SDS_NAMESPACE + "\"><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>'",
                 sclDataMarshaller::unmarshal
         );
     }
@@ -107,7 +108,7 @@ public List<Item> listVersionsByUUID(SclType type, UUID id) {
                         "   let $minorVersion := xs:int($parts[2])\n" +
                         "   let $patchVersion := xs:int($parts[3])\n" +
                         "   order by $majorVersion, $minorVersion, $patchVersion\n" +
-                        "   return '<Item><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>' ",
+                        "   return '<Item xmlns=\"" + SDS_NAMESPACE + "\"><Id>' || $id || '</Id><Name>' || $name || '</Name><Version>' || $version || '</Version></Item>' ",
                 sclDataMarshaller::unmarshal
         );
     }
diff --git a/repository/src/main/java/org/lfenergy/compas/scl/data/model/Constants.java b/repository/src/main/java/org/lfenergy/compas/scl/data/model/Constants.java
@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.data.model;
+
+public class Constants {
+    private Constants() {
+    }
+
+    public static final String SCL_NAMESPACE = "http://www.iec.ch/61850/2003/SCL";
+    public static final String SDS_NAMESPACE = "https://www.lfenergy.org/compas/SclDataService";
+}
diff --git a/repository/src/main/java/org/lfenergy/compas/scl/data/model/Item.java b/repository/src/main/java/org/lfenergy/compas/scl/data/model/Item.java
@@ -6,23 +6,26 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlRootElement;
 
-@XmlRootElement(name = "Item")
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
+
 @XmlAccessorType(XmlAccessType.FIELD)
 public class Item {
     @XmlElement(
             name = "Id",
+            namespace = SDS_NAMESPACE,
             required = true
     )
     private String id;
     @XmlElement(
             name = "Name",
+            namespace = SDS_NAMESPACE,
             required = true
     )
     private String name;
     @XmlElement(
             name = "Version",
+            namespace = SDS_NAMESPACE,
             required = true
     )
     private String version;
diff --git a/repository/src/test/java/org/lfenergy/compas/scl/data/util/JaxbMarshallerTest.java b/repository/src/test/java/org/lfenergy/compas/scl/data/util/JaxbMarshallerTest.java
@@ -10,14 +10,15 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.lfenergy.compas.scl.data.model.Constants.SDS_NAMESPACE;
 
 class JaxbMarshallerTest {
     @Test
     void unmarshal_WhenItemXMLPassed_ThenItemObjectReturned() throws JAXBException {
         var id = "ID";
         var name = "NAME";
         var version = "VERSION";
-        var xml = "<Item><Id>" + id + "</Id><Name>" + name + "</Name><Version>" + version + "</Version></Item>";
+        var xml = "<Item xmlns=\"" + SDS_NAMESPACE + "\"><Id>" + id + "</Id><Name>" + name + "</Name><Version>" + version + "</Version></Item>";
 
         JaxbMarshaller marshaller = new JaxbMarshaller();
         Item item = marshaller.unmarshal(xml);

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@ public final class Constants {`
`7`	`7`	`private Constants() {`
`8`	`8`	`}`
`9`	`9`
`10`		`- public static final String SCL_NAMESPACE = "http://www.iec.ch/61850/2003/SCL";`
`11`		`-`
`12`	`10`	`public static final String TYPE_PATH_PARAM = "type";`
`13`	`11`	`public static final String ID_PATH_PARAM = "id";`
`14`	`12`	`public static final String VERSION_PATH_PARAM = "version";`