Use namespace map property for marshalling if using certain JAXB vendors

Author: SugaryLump

dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/out/metadata/SIARDDK128MetadataExportStrategy.java

@@ -2,6 +2,8 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.util.HashMap;
+import java.util.Map;
 
 import com.databasepreservation.model.exception.ModuleException;
 import com.databasepreservation.model.structure.DatabaseStructure;
@@ -28,6 +30,10 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
     // TO-DO: Refactor this into one method in class that can be used by
     // SIARDDKDatabaseExportModule also
 
+    // Making the SIARD DK XML namespace default in case needed
+    Map<String, String> namespaceMap = new HashMap<>();
+    namespaceMap.put("http://www.sa.dk/xmlns/diark/1.0", "");
+
     // Generate tableIndex.xml
 
     try {
@@ -38,7 +44,7 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
       siardMarshaller.marshal("com.databasepreservation.modules.siard.bindings.siard_dk_128",
         metadataPathStrategy.getXsdResourcePath(SIARDDKConstants.TABLE_INDEX),
         "http://www.sa.dk/xmlns/diark/1.0 ../Schemas/standard/tableIndex.xsd", writer,
-        tableIndexFileStrategy.generateXML(dbStructure));
+        tableIndexFileStrategy.generateXML(dbStructure), namespaceMap);
 
       writer.close();
 
@@ -93,7 +99,7 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
 
         siardMarshaller.marshal(DocIndexType.class, metadataPathStrategy.getXsdResourcePath(SIARDDKConstants.DOC_INDEX),
           "http://www.sa.dk/xmlns/diark/1.0 ../Schemas/standard/docIndex.xsd", writer,
-          SIARDDKDocIndexFileStrategy.generateXML(dbStructure));
+          SIARDDKDocIndexFileStrategy.generateXML(dbStructure), namespaceMap);
 
         writer.close();
 

dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/out/metadata/SIARDDKMetadataExportStrategy.java

@@ -13,6 +13,7 @@
 import java.io.OutputStream;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.commons.io.IOUtils;
@@ -66,6 +67,10 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
 
     // Generate tableIndex.xml
 
+    // Making the SIARD DK XML namespace default in case needed
+    Map<String, String> namespaceMap = new HashMap<>();
+    namespaceMap.put("http://www.sa.dk/xmlns/diark/1.0", "");
+
     try {
       IndexFileStrategy tableIndexFileStrategy = new SIARDDKTableIndexFileStrategy(lobsTracker, siarddkAdapter);
       String path = metadataPathStrategy.getXmlFilePath(SIARDDKConstants.TABLE_INDEX);
@@ -74,7 +79,7 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
       siardMarshaller.marshal(SIARDDKConstants.JAXB_CONTEXT_TABLEINDEX,
         metadataPathStrategy.getXsdResourcePath(SIARDDKConstants.TABLE_INDEX),
         "http://www.sa.dk/xmlns/diark/1.0 ../Schemas/standard/tableIndex.xsd", writer,
-        tableIndexFileStrategy.generateXML(dbStructure));
+        tableIndexFileStrategy.generateXML(dbStructure), namespaceMap);
 
       writer.close();
 
@@ -130,7 +135,7 @@ public void writeMetadataXML(DatabaseStructure dbStructure, SIARDArchiveContaine
         siardMarshaller.marshal(SIARDDKConstants.JAXB_CONTEXT_DOCINDEX,
           metadataPathStrategy.getXsdResourcePath(SIARDDKConstants.DOC_INDEX),
           "http://www.sa.dk/xmlns/diark/1.0 ../Schemas/standard/docIndex.xsd", writer,
-          SIARDDKDocIndexFileStrategy.generateXML(dbStructure));
+          SIARDDKDocIndexFileStrategy.generateXML(dbStructure), namespaceMap);
 
         writer.close();
 

dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/out/metadata/SIARDMarshaller.java

@@ -2,12 +2,13 @@
  * The contents of this file are subject to the license and copyright
  * detailed in the LICENSE file at the root of the source
  * tree and available online at
- *
+ * <p>
  * https://github.com/keeps/db-preservation-toolkit
  */
 package com.databasepreservation.modules.siard.out.metadata;
 
 import java.io.OutputStream;
+import java.util.Map;
 
 import com.databasepreservation.model.exception.ModuleException;
 
@@ -19,7 +20,7 @@ public interface SIARDMarshaller {
 
   /**
    * Generate JAXB Marshaller for writing XML object to the archive.
-   * 
+   *
    * @param context
    *          Parameter to give to JAXBContext.newInstance()
    * @param localeSchemaLocation
@@ -30,9 +31,11 @@ public interface SIARDMarshaller {
    *          The OutputStream to write to.
    * @param jaxbElement
    *          The JAXB element to marshal.
+   * @param namespaceMap
+   *          The namespace map to use for marshaling. Ignored if null.
    */
   public void marshal(String context, String localeSchemaLocation, String JAXBSchemaLocation, OutputStream writer,
-    Object jaxbElement) throws ModuleException;
+    Object jaxbElement, Map<String, String> namespaceMap) throws ModuleException;
 
   /**
    * Generate JAXB Marshaller for writing XML object to the archive.
@@ -47,7 +50,10 @@ public void marshal(String context, String localeSchemaLocation, String JAXBSche
    *          The OutputStream to write to.
    * @param jaxbElement
    *          The JAXB element to marshal.
+   * @param namespaceMap
+   *          The namespace map to use for marshaling. Ignored if null.
+   *
    */
   public void marshal(Class<?> archiveClass, String localeSchemaLocation, String JAXBSchemaLocation,
-    OutputStream writer, Object jaxbElement) throws ModuleException;
+    OutputStream writer, Object jaxbElement, Map<String, String> namespaceMap) throws ModuleException;
 }

dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/out/metadata/StandardSIARDMarshaller.java

@@ -10,6 +10,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.util.Map;
 
 import javax.xml.XMLConstants;
 import javax.xml.transform.stream.StreamSource;
@@ -27,15 +28,15 @@
 import jakarta.xml.bind.JAXBException;
 import jakarta.xml.bind.Marshaller;
 
-public class StandardSIARDMarshaller implements SIARDMarshaller {
+public class  StandardSIARDMarshaller implements SIARDMarshaller {
 
   private static final String ENCODING = "UTF-8";
 
   private static final Logger LOGGER = LoggerFactory.getLogger(StandardSIARDMarshaller.class);
 
   @Override
   public void marshal(String contextStr, String localeSchemaLocation, String JAXBSchemaLocation, OutputStream writer,
-    Object jaxbElement) throws ModuleException {
+    Object jaxbElement, Map<String, String> namespaceMap) throws ModuleException {
 
     // Set up JAXB marshaller
 
@@ -82,7 +83,7 @@ public void marshal(String contextStr, String localeSchemaLocation, String JAXBS
 
   @Override
   public void marshal(Class<?> archiveClass, String localeSchemaLocation, String JAXBSchemaLocation,
-    OutputStream writer, Object jaxbElement) throws ModuleException {
+    OutputStream writer, Object jaxbElement, Map<String, String> namespaceMap) throws ModuleException {
 
     // Set up JAXB marshaller
 
@@ -115,6 +116,11 @@ public void marshal(Class<?> archiveClass, String localeSchemaLocation, String J
       m.setProperty(Marshaller.JAXB_ENCODING, ENCODING);
       m.setProperty(Marshaller.JAXB_SCHEMA_LOCATION, JAXBSchemaLocation);
 
+      if (m.getClass().getName().contains("eclipse") && namespaceMap != null) {
+        // vendor requires explicit mapping
+        m.setProperty("eclipse.namespace-prefix-mapper", namespaceMap);
+      }
+
       m.setSchema(xsdSchema);
 
       m.marshal(jaxbElement, writer);

dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/out/output/SIARDDKDatabaseExportModule.java

@@ -15,6 +15,7 @@
 import java.nio.file.Path;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.BlockingQueue;
@@ -216,10 +217,14 @@ public void finishDatabase() throws ModuleException {
       OutputStream writer = SIARDDKFileIndexFileStrategy.getWriter(siarddkExportModule.getMainContainer(), path,
         siarddkExportModule.getWriteStrategy());
 
+      // Making the SIARD DK XML namespace default in case needed
+      Map<String, String> namespaceMap = new HashMap<>();
+      namespaceMap.put("http://www.sa.dk/xmlns/diark/1.0", "");
+
       siardMarshaller.marshal(getJAXBContextClass(),
         metadataPathStrategy.getXsdResourcePath(SIARDDKConstants.FILE_INDEX),
         "http://www.sa.dk/xmlns/diark/1.0 ../Schemas/standard/fileIndex.xsd", writer,
-        SIARDDKFileIndexFileStrategy.generateXML(null));
+        SIARDDKFileIndexFileStrategy.generateXML(null), namespaceMap);
 
       writer.close();
     } catch (IOException e) {