How to marshal a DataHandler annotated as @XmlAttachmentRef with JAXB?

Question

I'm trying to marshal an object which has a DataHandler field with JAXB (2.1.12). For streaming support, the DataHandler is annotated with @XmlAttachmentRef. Serialization and streaming over web services (Metro on JBoss) work fine, but plain marshalling with JAXB doesn't.

Here is a stripped down example:

public class DataHandlerAttachmentSerialization {

    @XmlRootElement
    static class RootObject {
        @XmlElement
        @XmlAttachmentRef // Works without this, but required for streaming 
        DataHandler dataHandler = new DataHandler(
                new com.sun.xml.ws.util.ByteArrayDataSource(
                " ".getBytes(), "application/octet-stream"));
    }

    @Test
    public void test() throws JAXBException {
        JAXBContext context = JAXBContext.newInstance(RootObject.class);
        Marshaller marshaller = context.createMarshaller();
        StringWriter writer = new StringWriter();
        marshaller.marshal(new RootObject(), writer);
        Assert.assertNotNull(writer.toString());
    }
}

Running this test yields the following stack trace:

javax.xml.bind.MarshalException
 - with linked exception:
[com.sun.xml.bind.api.AccessorException: java.lang.NullPointerException]
    at com.sun.xml.bind.v2.runtime.MarshallerImpl.write(MarshallerImpl.java:318)
    at com.sun.xml.bind.v2.runtime.MarshallerImpl.marshal(MarshallerImpl.java:244)
    at javax.xml.bind.helpers.AbstractMarshallerImpl.marshal(AbstractMarshallerImpl.java:96)
    ...
Caused by: com.sun.xml.bind.api.AccessorException: java.lang.NullPointerException
    at com.sun.xml.bind.v2.runtime.XMLSerializer.reportError(XMLSerializer.java:246)
    at com.sun.xml.bind.v2.runtime.XMLSerializer.reportError(XMLSerializer.java:261)
    at com.sun.xml.bind.v2.runtime.ClassBeanInfoImpl.serializeBody(ClassBeanInfoImpl.java:335)
    at com.sun.xml.bind.v2.runtime.XMLSerializer.childAsSoleContent(XMLSerializer.java:593)
    at com.sun.xml.bind.v2.runtime.ClassBeanInfoImpl.serializeRoot(ClassBeanInfoImpl.java:320)
    at com.sun.xml.bind.v2.runtime.XMLSerializer.childAsRoot(XMLSerializer.java:494)
    at com.sun.xml.bind.v2.runtime.MarshallerImpl.write(MarshallerImpl.java:315)
    ... 25 more
Caused by: com.sun.xml.bind.api.AccessorException: java.lang.NullPointerException
    at com.sun.xml.bind.v2.runtime.reflect.AdaptedAccessor.get(AdaptedAccessor.java:74)
    at com.sun.xml.bind.v2.runtime.reflect.TransducedAccessor$CompositeTransducedAccessorImpl.writeLeafElement(TransducedAccessor.java:250)
    at com.sun.xml.bind.v2.runtime.property.SingleElementLeafProperty.serializeBody(SingleElementLeafProperty.java:98)
    at com.sun.xml.bind.v2.runtime.ClassBeanInfoImpl.serializeBody(ClassBeanInfoImpl.java:332)
    ... 29 more
Caused by: java.lang.NullPointerException
    at com.sun.xml.bind.v2.runtime.SwaRefAdapter.marshal(SwaRefAdapter.java:80)
    at com.sun.xml.bind.v2.runtime.SwaRefAdapter.marshal(SwaRefAdapter.java:65)
    at com.sun.xml.bind.v2.runtime.reflect.AdaptedAccessor.get(AdaptedAccessor.java:72)
    ... 32 more

Line 80 in SwaRefAdapter is return am.addSwaRefAttachment(data); and am was assigned with AttachmentMarshaller am = XMLSerializer.getInstance().attachmentMarshaller; so it seems attachmentMarshaller is null at this point if the @XmlAttachmentRef is present.

Do I need to set up something differently, or use the JAXB API in a different way to handle attachments?

Answer 1

When using JAXB outside of a JAX-WS environment a JAXB implementation should be default inline the binary content in the XML document as base64Binary.

This appears to be a bug in the Metro implmentation of JAXB (the RI included in the JDK/JRE). If you use another JAXB implementation such as EclipseLink JAXB (MOXy), this will work correctly. To use EclipseLink MOXy add the eclipselink.jar (available here) to your class path and add a jaxb.properties file in with your model classes when the following content:

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

JAX-WS registers AttachmentMarshallers & AttachmentUnmarshallers to handle binary content in JAXB models. You could specify your own when using JAXB standalone if you wanted.

http://download.oracle.com/docs/cd/E17409_01/javase/6/docs/api/javax/xml/bind/attachment/AttachmentMarshaller.html