Add xml annotation introspector for default namespace

Author: Daespen

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/XmlDataformatAnnotationIntrospector.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.adminshell.aas.v3.dataformat.xml;
+
+import com.fasterxml.jackson.databind.introspect.Annotated;
+import com.fasterxml.jackson.dataformat.xml.JacksonXmlAnnotationIntrospector;
+
+/**
+ * This class helps to dynamically decide how to de-/serialize classes and
+ * properties defined in the AAS model library. It will automatically add a default namespace
+ * to property names.
+ */
+public class XmlDataformatAnnotationIntrospector extends JacksonXmlAnnotationIntrospector {
+    private static final long serialVersionUID = 1L;
+
+    protected String myDefaultNamespace = "";
+
+    public XmlDataformatAnnotationIntrospector() {
+        super();
+        myDefaultNamespace = AasXmlNamespaceContext.AAS_URI;
+    }
+
+    @Override
+    public String findNamespace(Annotated ann) {
+        String ns = super.findNamespace(ann);
+        if (ns == null) {
+            return myDefaultNamespace;
+        } else {
+            return ns;
+        }
+    }
+}

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/XmlDeserializer.java

@@ -51,6 +51,7 @@ protected void buildMapper() {
         mapper = XmlMapper.builder().enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY)
                 .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
                 .serializationInclusion(JsonInclude.Include.NON_NULL)
+                .annotationIntrospector(new XmlDataformatAnnotationIntrospector())
                 .addModule(buildImplementationModule())
                 .addModule(buildCustomDeserializerModule())
                 .addModule(buildEnumModule())

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/XmlSerializer.java

@@ -55,9 +55,11 @@ public XmlSerializer(Map<String, String> namespacePrefixes) {
     }
 
     protected void buildMapper() {
-        mapper = XmlMapper.builder().enable(SerializationFeature.INDENT_OUTPUT)
+        mapper = XmlMapper.builder()
+                .enable(SerializationFeature.INDENT_OUTPUT)
                 .enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY)
                 .serializationInclusion(JsonInclude.Include.NON_EMPTY)
+                .annotationIntrospector(new XmlDataformatAnnotationIntrospector())
                 .defaultUseWrapper(false)
                 .addModule(buildEnumModule())
                 .addModule(buildCustomSerializerModule())

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AccessControlMixin.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
+* Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,15 +17,16 @@
 
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
+import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 import io.adminshell.aas.v3.model.AccessPermissionRule;
 
 public interface AccessControlMixin {
-    @JsonProperty("accessPermissionRule")
+    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.ABAC_PREFERRED_PREFIX, localName = "accessPermissionRule")
     public List<AccessPermissionRule> getAccessPermissionRules();
 
-    @JsonProperty("accessPermissionRule")
+    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.ABAC_PREFERRED_PREFIX, localName = "accessPermissionRule")
     public void setAccessPermissionRules(List<AccessPermissionRule> accessPermissionRules);
 
 }

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AdministrativeInformationMixin.java

@@ -19,20 +19,11 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
-import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 import io.adminshell.aas.v3.model.Reference;
 
 @JsonPropertyOrder({"revision", "version"})
 public interface AdministrativeInformationMixin {
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "revision")
-    public String getRevision();
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "version")
-    public String getVersion();
-
     @JsonIgnore
     public List<Reference> getDataSpecifications();
 }

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AnnotatedRelationshipElementMixin.java

@@ -20,18 +20,14 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
-import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 import io.adminshell.aas.v3.dataformat.xml.deserialization.DataElementsDeserializer;
 import io.adminshell.aas.v3.dataformat.xml.serialization.DataElementsSerializer;
 import io.adminshell.aas.v3.model.DataElement;
 
 @JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "kind", "semanticId",
     "qualifiers", "dataSpecifications", "first", "second", "annotations"})
 public interface AnnotatedRelationshipElementMixin {
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "annotations")
     @JsonSerialize(using = DataElementsSerializer.class)
     @JsonDeserialize(using = DataElementsDeserializer.class)
     public List<DataElement> getAnnotations();

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AssetAdministrationShellMixin.java

@@ -22,25 +22,17 @@
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
 import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
-import io.adminshell.aas.v3.model.AssetInformation;
 import io.adminshell.aas.v3.model.Reference;
 import io.adminshell.aas.v3.model.View;
 
 @JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "administration",
     "identification", "dataSpecifications", "security", "derivedFrom", "submodels", "assetInformation", "views"})
 public interface AssetAdministrationShellMixin {
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "derivedFrom")
-    public Reference getDerivedFrom();
-
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "submodelRef")
     @JacksonXmlElementWrapper(namespace = AasXmlNamespaceContext.AAS_URI, localName = "submodelRefs")
     public List<Reference> getSubmodels();
 
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "view")
     @JacksonXmlElementWrapper(namespace = AasXmlNamespaceContext.AAS_URI, localName = "views")
     public List<View> getViews();
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "assetInformation")
-    public AssetInformation getAssetInformation();
 }

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/AssetInformationMixin.java

@@ -22,26 +22,13 @@
 import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 
 import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
-import io.adminshell.aas.v3.model.AssetKind;
 import io.adminshell.aas.v3.model.File;
 import io.adminshell.aas.v3.model.IdentifierKeyValuePair;
 import io.adminshell.aas.v3.model.Reference;
 
 @JsonPropertyOrder({"defaultThumbnail", "globalAssetId", "assetKind", "billOfMaterials", "specificAssetIds"})
 public interface AssetInformationMixin {
 
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "assetKind")
-    public AssetKind getAssetKind();
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "assetKind")
-    public void setAssetKind(AssetKind assetKind);
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "globalAssetId")
-    public Reference getGlobalAssetId();
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "globalAssetId")
-    public void setGlobalAssetId(Reference globalAssetId);
-
     @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "specificAssetId")
     @JacksonXmlElementWrapper(namespace = AasXmlNamespaceContext.AAS_URI, localName = "specificAssetIds")
     public List<IdentifierKeyValuePair> getSpecificAssetIds();

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/BasicEventMixin.java

@@ -16,15 +16,8 @@
 package io.adminshell.aas.v3.dataformat.xml.mixins;
 
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
-
-import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
-import io.adminshell.aas.v3.model.Reference;
 
 @JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "kind",
     "semanticId", "qualifiers", "dataSpecifications", "observed"})
 public interface BasicEventMixin {
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "observed")
-    public Reference getObserved();
 }

dataformat-xml/src/main/java/io/adminshell/aas/v3/dataformat/xml/mixins/BlobMixin.java

@@ -16,18 +16,8 @@
 package io.adminshell.aas.v3.dataformat.xml.mixins;
 
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
-
-import io.adminshell.aas.v3.dataformat.xml.AasXmlNamespaceContext;
 
 @JsonPropertyOrder({"extensions", "idShort", "displayNames", "category", "descriptions", "kind", "semanticId",
     "qualifiers", "dataSpecifications", "value", "mimeType"})
 public interface BlobMixin {
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "mimeType")
-    public String getMimeType();
-
-    @JacksonXmlProperty(namespace = AasXmlNamespaceContext.AAS_URI, localName = "value")
-    public byte[] getValue();
-
 }