[feature] Allow an XQJ serialization of XQuery Items as the result of executing an XQuery in the XML:RPC API. Enabled by default in Elemental. To preserve XML:RPC compatibility with eXist-db, this has been implemented in such a manner that this feature will not be used when using the Elemental XML:DB Remote API to talk to eXist-db, or when using the eXist-db XML:DB Remote API to talk to Elemental. Re-enables support for all XDM Types in XML:RPC API after 14644d5 disabled them due to API compatibility issues. If 14644d5 is reverted in future, then this commit can also be reverted.

Author: adamretter

exist-core/pom.xml

@@ -758,6 +758,7 @@
                                 <include>src/main/java/org/exist/util/JREUtil.java</include>
                                 <include>src/main/java/org/exist/util/OSUtil.java</include>
                                 <include>src/main/java/org/exist/util/StringUtil.java</include>
+                                <include>src/main/java/org/exist/util/io/AbstractContentFile.java</include>
                                 <include>src/test/java/org/exist/util/serializer/SAXSerializerTest.java</include>
                                 <include>src/test/java/org/exist/xmldb/XMLDBExternalVariableTest.java</include>
                                 <include>src/main/java/org/exist/xmlrpc/ArrayWrapperParser.java</include>
@@ -996,6 +997,7 @@
                                 <include>src/test/java/org/exist/storage/io/VariableByteStreamTest.java</include>
                                 <include>src/main/java/org/exist/storage/lock/FileLock.java</include>
                                 <include>src/main/java/org/exist/storage/recovery/RecoveryManager.java</include>
+                                <include>src/main/java/org/exist/storage/serializers/EXistOutputKeys.java</include>
                                 <include>src/main/java/org/exist/storage/serializers/Serializer.java</include>
                                 <include>src/main/java/org/exist/storage/serializers/XIncludeFilter.java</include>
                                 <include>src/test/resources-filtered/org/exist/storage/statistics/conf.xml</include>
@@ -1021,8 +1023,14 @@
                                 <include>src/test/java/org/exist/util/LeasableTest.java</include>
                                 <include>src/main/java/org/exist/util/ParametersExtractor.java</include>
                                 <include>src/main/java/org/exist/util/crypto/digest/DigestType.java</include>
+                                <include>src/main/java/org/exist/util/io/ByteArrayContent.java</include>
+                                <include>src/test/java/org/exist/util/io/ByteArrayContentTest.java</include>
+                                <include>src/main/java/org/exist/util/io/ContentFile.java</include>
+                                <include>src/main/java/org/exist/util/io/ContentFilePoolObjectFactory.java</include>
                                 <include>src/test/java/org/exist/util/io/FilterInputStreamCacheMonitorTest.java</include>
                                 <include>src/test/java/org/exist/util/io/OverflowToDiskStreamTest.java</include>
+                                <include>src/main/java/org/exist/util/io/VirtualTempPath.java</include>
+                                <include>src/test/java/org/exist/util/io/VirtualTempPathTest.java</include>
                                 <include>src/test/java/org/exist/util/pool/NodePoolTest.java</include>
                                 <include>src/main/java/org/exist/util/serializer/AttrList.java</include>
                                 <include>src/main/java/org/exist/util/serializer/DOMSerializer.java</include>
@@ -1611,6 +1619,7 @@
                                 <exclude>src/main/java/org/exist/storage/lock/ManagedLockGroupDocumentLock.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/lock/ManagedSingleLockDocumentLock.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/recovery/RecoveryManager.java</exclude>
+                                <exclude>src/main/java/org/exist/storage/serializers/EXistOutputKeys.java</exclude>
                                 <exclude>src/test/java/org/exist/storage/serializers/NativeSerializerTest.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/serializers/Serializer.java</exclude>
                                 <exclude>src/main/java/org/exist/storage/serializers/XIncludeFilter.java</exclude>
@@ -1654,8 +1663,15 @@
                                 <exclude>src/main/java/org/exist/util/StringUtil.java</exclude>
                                 <exclude>src/main/java/org/exist/util/UTF8.java</exclude>
                                 <exclude>src/main/java/org/exist/util/crypto/digest/DigestType.java</exclude>
+                                <exclude>src/main/java/org/exist/util/io/AbstractContentFile.java</exclude>
+                                <exclude>src/main/java/org/exist/util/io/ByteArrayContent.java</exclude>
+                                <exclude>src/test/java/org/exist/util/io/ByteArrayContentTest.java</exclude>
+                                <exclude>src/main/java/org/exist/util/io/ContentFile.java</exclude>
+                                <exclude>src/main/java/org/exist/util/io/ContentFilePoolObjectFactory.java</exclude>
                                 <exclude>src/test/java/org/exist/util/io/FilterInputStreamCacheMonitorTest.java</exclude>
                                 <exclude>src/test/java/org/exist/util/io/OverflowToDiskStreamTest.java</exclude>
+                                <exclude>src/main/java/org/exist/util/io/VirtualTempPath.java</exclude>
+                                <exclude>src/test/java/org/exist/util/io/VirtualTempPathTest.java</exclude>
                                 <exclude>src/test/java/org/exist/util/pool/NodePoolTest.java</exclude>
                                 <exclude>src/main/java/org/exist/util/serializer/AttrList.java</exclude>
                                 <exclude>src/main/java/org/exist/util/serializer/DOMSerializer.java</exclude>

exist-core/src/main/java/org/exist/dom/memtree/MemTreeBuilder.java

@@ -53,7 +53,6 @@
 import org.exist.xquery.Expression;
 import org.exist.xquery.XQueryContext;
 import org.w3c.dom.DOMException;
-import org.w3c.dom.Document;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.xml.sax.Attributes;

exist-core/src/main/java/org/exist/storage/serializers/EXistOutputKeys.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -107,6 +131,17 @@ public class EXistOutputKeys {
      */
     public static final String XDM_SERIALIZATION = "xdm-serialization";
 
+    /**
+     * When serializing an XDM this should be used
+     * to enforce XQJ serialization rules.
+     *
+     * XQJ has different serialization rules
+     * compared to retrieving and serializing resources from the database.
+     *
+     * Set to "yes" to enable xqj-serialization rules, false otherwise.
+     */
+    public static final String XQJ_SERIALIZATION = "xqj-serialization";
+
     /**
      * Enforce newline at the end of JSON and XML documents.
      *

exist-core/src/main/java/org/exist/util/io/AbstractContentFile.java

@@ -0,0 +1,38 @@
+/*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.util.io;
+
+/**
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
+ */
+public abstract class AbstractContentFile implements ContentFile {
+
+    protected final ContentFileType type;
+
+    protected AbstractContentFile(final ContentFileType type) {
+        this.type = type;
+    }
+
+    @Override
+    public ContentFileType getType() {
+        return type;
+    }
+}

exist-core/src/main/java/org/exist/util/io/ByteArrayContent.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -26,20 +50,21 @@
 /**
  * @author <a href="mailto:[email protected]">Patrick Reinhart</a>
  */
-public final class ByteArrayContent implements ContentFile {
+public final class ByteArrayContent extends AbstractContentFile {
     private static final byte[] EMPTY_BUFFER = new byte[0];
 
     private byte[] data;
 
-    public static ByteArrayContent of(byte[] data) {
-        return new ByteArrayContent(data);
+    public static ByteArrayContent of(final ContentFileType type, final byte[] data) {
+        return new ByteArrayContent(type, data);
     }
 
-    public static ByteArrayContent of(String data) {
-        return new ByteArrayContent(data.getBytes(StandardCharsets.UTF_8));
+    public static ByteArrayContent of(final ContentFileType type, final String data) {
+        return of(type, data.getBytes(StandardCharsets.UTF_8));
     }
 
-    private ByteArrayContent(byte[] data) {
+    private ByteArrayContent(final ContentFileType type, final byte[] data) {
+        super(type);
         this.data = data;
     }
 

exist-core/src/main/java/org/exist/util/io/ContentFile.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -19,7 +43,6 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-
 package org.exist.util.io;
 
 import java.io.ByteArrayInputStream;
@@ -32,6 +55,30 @@
  */
 public interface ContentFile extends AutoCloseable {
 
+    enum ContentFileType {
+        /**
+         * The file contains content of which the format is unknown.
+         */
+        UNKNOWN,
+
+        /**
+         * The file contains content that has been serialized using the XDM method.
+         */
+        XDM_SERIALIZATION,
+
+        /**
+         * The file contains content that has been serialized using the XQJ method.
+         */
+        XQJ_SERIALIZATION;
+    }
+
+    /**
+     * Get the type of the Content File.
+     *
+     * @return the type of the Content File.
+     */
+    ContentFileType getType();
+
     @Override
     /**
      * Closes all resource held by the implementation as open files or off HEAP memory as example.

exist-core/src/main/java/org/exist/util/io/ContentFilePoolObjectFactory.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -19,15 +43,14 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-
 package org.exist.util.io;
 
 import org.apache.commons.pool2.BasePooledObjectFactory;
 import org.apache.commons.pool2.PooledObject;
 import org.apache.commons.pool2.impl.DefaultPooledObject;
 
 /**
- * Object factory responsible for creating {@link ContentFile} instances and wrap thos into pool objects.
+ * Object factory responsible for creating {@link ContentFile} instances and wrap those into pool objects.
  *
  * @author <a href="mailto:[email protected]">Patrick Reinhart</a>
  */
@@ -48,7 +71,7 @@ public ContentFilePoolObjectFactory(final TemporaryFileManager tempFileManager,
 
     @Override
     public ContentFile create() throws Exception {
-        return new VirtualTempPath(inMemorySize, tempFileManager);
+        return new VirtualTempPath(ContentFile.ContentFileType.UNKNOWN, inMemorySize, tempFileManager);
     }
 
     @Override

exist-core/src/main/java/org/exist/util/io/VirtualTempPath.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * [email protected]
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -19,7 +43,6 @@
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
-
 package org.exist.util.io;
 
 import java.io.*;
@@ -37,7 +60,7 @@
  * @author <a href="mailto:[email protected]">Patrick Reinhart</a>
  */
 @ThreadSafe
-public final class VirtualTempPath implements ContentFile {
+public final class VirtualTempPath extends AbstractContentFile {
     public static final int DEFAULT_IN_MEMORY_SIZE = 4 * 1024 * 1024; // 4 MB
 
     private static final byte[] EMPTY_BUFFER = new byte[0];
@@ -52,11 +75,12 @@ public final class VirtualTempPath implements ContentFile {
     @GuardedBy("lock")
     private Path contentFile;
 
-    public VirtualTempPath(TemporaryFileManager tempFileManager) {
-        this(DEFAULT_IN_MEMORY_SIZE, tempFileManager);
+    public VirtualTempPath(final ContentFileType type, final TemporaryFileManager tempFileManager) {
+        this(type, DEFAULT_IN_MEMORY_SIZE, tempFileManager);
     }
 
-    public VirtualTempPath(int inMemorySize, TemporaryFileManager tempFileManager) {
+    public VirtualTempPath(final ContentFileType type, final int inMemorySize, final TemporaryFileManager tempFileManager) {
+        super(type);
         this.inMemorySize = inMemorySize;
         this.lock = new StampedLock();
         this.tempFileManager = tempFileManager;