Fix #270

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -4,6 +4,11 @@ Project: jackson-dataformat-xml
 = Releases
 ------------------------------------------------------------------------
 
+2.9.8 (not yet released)
+
+#270: Add support for `writeBinary()` with `InputStream` to `ToXMLGenerator`
+ (requested by csbxvs@github; contributed by marc-christian-schulze@github)
+
 2.9.7 (19-Sep-2018)
 
 No changes since 2.9.6

src/main/java/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.java

@@ -840,6 +840,69 @@ public void writeBinary(Base64Variant b64variant,
         }
     }
 
+    @Override
+    public int writeBinary(Base64Variant b64variant, InputStream data, int dataLength) throws IOException
+    {
+        if (data == null) {
+            writeNull();
+            return 0;
+        }
+        _verifyValueWrite("write Binary value");
+        if (_nextName == null) {
+            handleMissingName();
+        }
+        try {
+            if (_nextIsAttribute) {
+                // Stax2 API only has 'full buffer' write method:
+                byte[] fullBuffer = toFullBuffer(data, dataLength);
+                _xmlWriter.writeBinaryAttribute("", _nextName.getNamespaceURI(), _nextName.getLocalPart(), fullBuffer);
+            } else if (checkNextIsUnwrapped()) {
+              // should we consider pretty-printing or not?
+                writeStreamAsBinary(data, dataLength);
+
+            } else {
+                if (_xmlPrettyPrinter != null) {
+                    _xmlPrettyPrinter.writeLeafElement(_xmlWriter,
+                            _nextName.getNamespaceURI(), _nextName.getLocalPart(),
+                            toFullBuffer(data, dataLength), 0, dataLength);
+                } else {
+                    _xmlWriter.writeStartElement(_nextName.getNamespaceURI(), _nextName.getLocalPart());
+                    writeStreamAsBinary(data, dataLength);
+                    _xmlWriter.writeEndElement();
+                }
+            }
+        } catch (XMLStreamException e) {
+            StaxUtil.throwAsGenerationException(e, this);
+        }
+
+        return dataLength;
+    }
+
+    private void writeStreamAsBinary(InputStream data, int len) throws IOException, XMLStreamException 
+    {
+        // base64 encodes up to 3 bytes into a 4 bytes string
+        byte[] tmp = new byte[3];
+        int offset = 0;
+        int read;
+        while((read = data.read(tmp, offset, Math.min(3 - offset, len))) != -1) {
+            offset += read;
+            len -= read;
+            if(offset == 3) {
+                offset = 0;
+                _xmlWriter.writeBinary(tmp, 0, 3);
+            }
+            if (len == 0) {
+                break;
+            }
+        }
+
+        // we still have < 3 bytes in the buffer
+        if(offset > 0) {
+            _xmlWriter.writeBinary(tmp, 0, offset);
+        }
+    }
+
+    
     private byte[] toFullBuffer(byte[] data, int offset, int len)
     {
         // might already be ok:
@@ -852,7 +915,22 @@ private byte[] toFullBuffer(byte[] data, int offset, int len)
         }
         return result;
     }
-    
+
+    private byte[] toFullBuffer(InputStream data, final int len) throws IOException 
+    {
+        byte[] result = new byte[len];
+        int offset = 0;
+
+        for (; offset < len; ) {
+            int count = data.read(result, offset, len - offset);
+            if (count < 0) {
+                _reportError("Too few bytes available: missing "+(len - offset)+" bytes (out of "+len+")");
+            }
+            offset += count;
+        }
+        return result;
+    }
+
     /*
     /**********************************************************
     /* Output method implementations, primitive

src/test/java/com/fasterxml/jackson/dataformat/xml/deser/builder/BuilderSimpleTest.java

@@ -1,7 +1,5 @@
 package com.fasterxml.jackson.dataformat.xml.deser.builder;
 
-import java.util.*;
-
 import com.fasterxml.jackson.annotation.*;
 
 import com.fasterxml.jackson.core.Version;

src/test/java/com/fasterxml/jackson/dataformat/xml/failing/ListDeser294Test.java

@@ -2,7 +2,6 @@
 
 import java.util.*;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.dataformat.xml.XmlMapper;
 import com.fasterxml.jackson.dataformat.xml.XmlTestBase;

src/test/java/com/fasterxml/jackson/dataformat/xml/ser/TestBinaryStreamToXMLSerialization.java

@@ -0,0 +1,61 @@
+package com.fasterxml.jackson.dataformat.xml.ser;
+
+import java.nio.*;
+
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
+import com.fasterxml.jackson.dataformat.xml.XmlTestBase;
+
+/**
+ * See <a href="https://github.com/FasterXML/jackson-dataformat-xml/issues/270">issue #270</a>
+ * for details
+ */
+public class TestBinaryStreamToXMLSerialization extends XmlTestBase
+{
+    private final XmlMapper MAPPER = new XmlMapper();
+
+    public void testWith0Bytes() throws Exception 
+    {
+        String xml = MAPPER.writeValueAsString(createPojo());
+        assertEquals("<TestPojo><field/></TestPojo>", xml);
+    }
+
+    public void testWith1Byte() throws Exception 
+    {
+        String xml = MAPPER.writeValueAsString(createPojo( 'A' ));
+        assertEquals("<TestPojo><field>QQ==</field></TestPojo>", xml);
+    }
+
+    public void testWith2Bytes() throws Exception 
+    {
+        String xml = MAPPER.writeValueAsString(createPojo( 'A', 'B' ));
+        assertEquals("<TestPojo><field>QUI=</field></TestPojo>", xml);
+    }
+
+    public void testWith3Bytes() throws Exception 
+    {
+        String xml = MAPPER.writeValueAsString(createPojo( 'A', 'B', 'C' ));
+        assertEquals("<TestPojo><field>QUJD</field></TestPojo>", xml);
+    }
+
+    public void testWith4Bytes() throws Exception 
+    {
+        String xml = MAPPER.writeValueAsString(createPojo( 'A', 'B', 'C', 'D' ));
+        assertEquals("<TestPojo><field>QUJDRA==</field></TestPojo>", xml);
+    }
+
+    private TestPojo createPojo(char... content) {
+        TestPojo obj = new TestPojo();
+        // DirectByteBuffer does not have an underlying array
+        // so the ByteArraySerializer has to fallback to stream writing
+        obj.field = ByteBuffer.allocateDirect(content.length);
+        for(char b : content) {
+            obj.field.put((byte) b);
+        }
+        obj.field.position(0);
+        return obj;
+    }
+
+    public static class TestPojo {
+        public ByteBuffer field;
+    }
+}