net.bpelunit.framework.control.util.BPELUnitUtil.java Source code

Introduction

Here is the source code for net.bpelunit.framework.control.util.BPELUnitUtil.java

Source

/**
 * This file belongs to the BPELUnit utility and Eclipse plugin set. See enclosed
 * license file for more information.
 * 
 */
package net.bpelunit.framework.control.util;

import java.io.ByteArrayOutputStream;

import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.soap.Detail;
import javax.xml.soap.DetailEntry;
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPBody;
import javax.xml.soap.SOAPFault;
import javax.xml.soap.SOAPMessage;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.apache.commons.lang.StringUtils;
import org.apache.xmlbeans.XmlOptions;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * Utilities for use in the BPELUnit framework.
 * 
 * @version $Id$
 * @author Philip Mayer, Antonio Garcia-Dominguez (changed serialization method)
 * 
 */
public final class BPELUnitUtil {

    private static final int INDENTION_SIZE = 4;

    private BPELUnitUtil() {
    }

    public static final String DUMMY_ELEMENT_NAME = "literalData";

    /**
     * The document builder to use.
     */
    private static DocumentBuilder fgDocumentBuilder;

    /**
     * Initializes the parser component. This is necessary to be able to deal with severe CLASSPATH
     * problems (i.e. no parser in CLASSPATH) in a predictable manner.
     * 
     * @throws ParserConfigurationException
     */
    public static void initializeParsing() throws ParserConfigurationException {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        factory.setNamespaceAware(true);
        BPELUnitUtil.fgDocumentBuilder = factory.newDocumentBuilder();
    }

    /**
     * Creates a new document with a dummy root node, intended to store literal data for a receive
     * or send.
     * 
     * CAUTION: This method depends on initialization which is done by calling
     * {@link initializeParsing}. Not initializing this class will cause uncaught NPEs.
     * 
     * @return
     */
    public static Element generateDummyElementNode() {
        Document document = fgDocumentBuilder.newDocument();
        Element root = document.createElement(DUMMY_ELEMENT_NAME);
        document.appendChild(root);
        return root;
    }

    /**
     * Creates a new, generic SOAP fault to be used when something goes wrong in a partner track and
     * other tracks must be notified.
     * 
     * @return
     */
    public static SOAPMessage generateGenericSOAPFault() {

        try {
            MessageFactory mFactory = MessageFactory.newInstance();
            SOAPMessage message = mFactory.createMessage();
            SOAPBody body = message.getSOAPBody();
            SOAPFault fault = body.addFault(BPELUnitConstants.SOAP_FAULT_CODE_CLIENT,
                    BPELUnitConstants.SOAP_FAULT_DESCRIPTION);

            Detail detail = fault.addDetail();
            DetailEntry entry = detail
                    .addDetailEntry(new QName("http://www.bpelunit.org/framework/error", "BPELUnitFault"));
            entry.addTextNode(
                    "The BPELUnit test framework has detected a test failure or error. This test case is aborted.");

            return message;

        } catch (Exception e) {
            return null;
        }
    }

    /**
     * Removes line breaks from a string
     * 
     * @param string
     * @return
     */
    public static String removeSpaceLineBreaks(String string) {
        if (string == null) {
            return "";
        }

        String v = string.trim();
        v = StringUtils.remove(v, '\n');
        v = StringUtils.remove(v, '\r');
        v = StringUtils.remove(v, '\t');
        return v;
    }

    /**
     * XPath exception causes tend to be deeply nested. The first meaningful exception (with an
     * error message) is some way down. Find it.
     * 
     * @param e
     * @return
     */
    public static Throwable findRootThrowable(Exception e) {
        Throwable f = e;
        while (f.getMessage() == null && f.getCause() != null) {
            f = f.getCause();
        }
        return f;
    }

    /**
     * Outputs a DOM Document node to a string with identation.
     * 
     * @param element
     * @return
     */
    public static String toFormattedString(Document element) {
        try {
            return serializeXML(element);
        } catch (TransformerException e) {
            return "(no data)";
        }
    }

    private static String serializeXML(Node node) throws TransformerException {
        TransformerFactory tf = TransformerFactory.newInstance();
        Transformer t = tf.newTransformer();
        t.setOutputProperty(OutputKeys.INDENT, "yes");
        t.setOutputProperty(OutputKeys.METHOD, "xml");
        ByteArrayOutputStream bOS = new ByteArrayOutputStream();
        t.transform(new DOMSource(node), new StreamResult(bOS));
        return bOS.toString();
    }

    /**
     * Returns default output options for outputting XmlObjects from XBeans.
     * 
     * @return
     */
    public static XmlOptions getDefaultXMLOptions() {
        XmlOptions opts = new XmlOptions();
        opts.setSavePrettyPrint();
        opts.setSavePrettyPrintIndent(INDENTION_SIZE);
        return opts;
    }

}