How do I serialize / deserialize a class in XML with Woodstox StAX 2

Question

I'm pretty much trying to archive, what has been done in how-to-serialize-deserialize-simple-classes-to-xml-and-back (C#) in Java. If possible, I would like to avoid writing a serialize / deserialize methods for each class.

For example, part of serialize:

    XMLOutputFactory xof = null;
    XMLStreamWriter2 writer = null;

    try {
        resp.setContentType("text/plain");
        xof = XMLOutputFactory.newInstance();
        writer = (XMLStreamWriter2) //
        xof.createXMLStreamWriter(resp.getOutputStream());

        writer.writeStartDocument("1.0");
        writer.writeStartElement("data");
        // 
        // Magic happens here.
        //
        writer.writeEndElement();
        writer.writeEndDocument();
    } catch (XMLStreamException e) {
        e.printStackTrace();
        resp.sendError(1, "Problem 1 occured.");
    } finally {
        try {
            writer.flush();
            writer.close();
        } catch (XMLStreamException e) {
            e.printStackTrace();
            resp.sendError(2, "Problem 2 occured.");
        }
    }

Not part of this question, as I'm trying to tackle problems 1 by 1, but might give you a sense of what I'm trying to do. When I deserialize, I would also like to check if the input is valid. Eventually I want to use XSLT transforms with serialized form.

score 4 · Accepted Answer · edited May 23 '17 at 11:52

4

JAXB is how you serialize Java objects to XML. The following will help you get started:

http://wiki.eclipse.org/EclipseLink/Examples/MOXy/GettingStarted

JAXB Implementations

There are several implementations of this standard:

EclipseLink MOXy (I'm the tech lead)
Metro (the reference implementation, included in Java SE 6)
JaxMe

Woodstox StAX 2

JAXB accepts many input/output formats including StAX.

Validation

XML is converted to objects using an Unmarshaller, and objects are converted to XML with a Marshaller. You can set an instance of javax.xml.validation.Schema to validate the input during these operations.

You can also use the javax.xml.validation APIs directly with JAXB, check out the following for an example:

Checking a java value with an xml schema

XSLT

The javax.xml.transform libraries are used in Java to perform XSLT transforms. JAXB is designed to work with these libraries using JAXBSource and JAXBResult.

For More Information

Check out my blog:

http://bdoughan.blogspot.com

edited May 23 '17 at 11:52

Community

1
1

answered Nov 18 '10 at 10:00

bdoughan

147,609
23
300
400

1

You have a impressive set of knowledge in the subject. – Margus Nov 19 '10 at 14:11
2

Thanks Margus, I have lead an XML binding solution for quite a few years now (EclipseLink MOXy). I'm also an active member in the two Java related standards: JAXB (http://jcp.org/en/jsr/detail?id=222) and SDO (http://jcp.org/en/jsr/detail?id=235). I highly recommend you go with a standard solution in Java since it integrates better with the rest of the enterprise Java stack. For example JAXB is the standard binding layer for both JAX-WS (XML web services) and JAX-RS (RESTful web services). Please let me know if you require additional information. – bdoughan Nov 19 '10 at 14:26
@BlaiseDoughan As you have mentioned, how do you set the Schema instance to validate a whole xml against a DTD while using JAXB unmarshalling without involving 2 steps of creating a validator to validate and then parse? Any pointers on this would be helpful – Ajay Aug 21 '13 at 07:37

score 0 · Answer 2 · answered Jan 05 '11 at 22:02

In addition to the comprehensive accepted answer, it's worth noting that Woodstox (or any Stax2 implementation) can actually validate both input and output; see this blog entry for sample code. One benefit is that you can also validate against Relax NG (not supported AFAIK by JAXP parser that JAXB uses by default) or DTD.

Also: there is a new project called Jackson-xml-databinder (a spin-off of Jackson JSON processor) that implements "mini-JAXB" (subset of full JAXB functionality) using a Stax2 parser (like Woodstox or Aalto). Main benefits are bit more powerful data binding part and even better performance than JAXB implementations; downside that it is not as mature, and does not support all XML specific aspects. It is probably most useful in cases where both JSON and XML formats are to be supported.

How do I serialize / deserialize a class in XML with Woodstox StAX 2

2 Answers2