XmlTools.java

package net.sourceforge.seqware.common.util.xmltools;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import javax.xml.bind.JAXBException;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.restlet.data.MediaType;
import org.restlet.data.Status;
import org.restlet.ext.xml.DomRepresentation;
import org.restlet.resource.ResourceException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

/**
 * <p>
 * XmlTools class.
 * </p>
 * 
 * @author boconnor
 * @version $Id: $Id
 */
public class XmlTools {

    private static Document getDocument(String string) throws ParserConfigurationException, IOException, SAXException {
        Document document;
        if (string == null) {
            Logger logger = LoggerFactory.getLogger(XmlTools.class);
            logger.debug("String is :" + string);
            return null;
        }
        // UTF-8 Encoded strings occasionally have silly byte-order marks
        // Solution from http://mark.koli.ch/2009/02/resolving-orgxmlsaxsaxparseexception-content-is-not-allowed-in-prolog.html
        string = string.trim().replaceFirst("^([\\W]+)<", "<");

        document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new ByteArrayInputStream(string.getBytes()));
        return document;
    }

    /**
     * <p>
     * getRepresentation.
     * </p>
     * 
     * @param document
     *            a {@link org.w3c.dom.Document} object.
     * @return a {@link org.restlet.ext.xml.DomRepresentation} object.
     */
    public static DomRepresentation getRepresentation(Document document) {
        return new DomRepresentation(MediaType.APPLICATION_XML, document);
    }

    /**
     * <p>
     * marshalToDocument.
     * </p>
     * 
     * @param jaxbTool
     *            a {@link net.sourceforge.seqware.common.util.xmltools.JaxbObject} object.
     * @param o
     *            a {@link java.lang.Object} object.
     * @return a {@link org.w3c.dom.Document} object.
     */
    public static Document marshalToDocument(JaxbObject jaxbTool, Object o) {
        Document doc = null;
        try {
            doc = jaxbTool.marshalToDocument(o);
        } catch (JAXBException e) {
            Logger logger = LoggerFactory.getLogger(XmlTools.class);
            logger.error("Error mashalling XML document", e);
        }
        return doc;
    }

    // public static String marshal(JaxbObject jaxbTool, Object o) {
    // StringBuilder builder = new StringBuilder();
    // try {
    // String line = jaxbTool.marshal(o);
    // builder.append(line);
    // } catch (JAXBException e) {
    // builder.append(o.toString());
    // builder.append(" could not be converted to XML");
    // e.printStackTrace();
    // }
    // String xml = builder.toString();
    // builder = null;
    // return xml;
    // }

    /**
     * <p>
     * unMarshal.
     * </p>
     * 
     * @param jaxbTool
     *            a {@link net.sourceforge.seqware.common.util.xmltools.JaxbObject} object.
     * @param expectedType
     *            a {@link java.lang.Object} object.
     * @param string
     *            a {@link java.lang.String} object.
     * @return a {@link java.lang.Object} object.
     * @throws org.xml.sax.SAXException
     *             if any.
     */
    public static Object unMarshal(JaxbObject jaxbTool, Object expectedType, String string) throws SAXException {
        Object o = null;
        try {
            // SEQWARE-1549
            if (string == null) {
                throw new ResourceException(Status.CLIENT_ERROR_BAD_REQUEST);
            }
            Document document = XmlTools.getDocument(string);
            o = jaxbTool.unMarshal(document, expectedType);

        } catch (ParserConfigurationException | IOException ex) {
            Logger logger = LoggerFactory.getLogger(XmlTools.class);
            logger.error(string, ex);
            throw new ResourceException(Status.SERVER_ERROR_INTERNAL);
        } catch (JAXBException e) {
            Logger logger = LoggerFactory.getLogger(XmlTools.class);
            logger.error(string, e);
            throw new ResourceException(Status.CLIENT_ERROR_NOT_ACCEPTABLE);
        }
        return o;
    }
}