com.rusticisoftware.hostedengine.client.XmlUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of scormcloud-java-lib Show documentation
Client Library for SCORM Cloud API.
There is a newer version: 1.1.3
/* Software License Agreement (BSD License)
 * 
 * Copyright (c) 2010-2011, Rustici Software, LLC
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the  nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Rustici Software, LLC BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.rusticisoftware.hostedengine.client;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import java.io.ByteArrayInputStream;
import java.io.StringWriter;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.TimeZone;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.*;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

public class XmlUtils {

    public static String getXmlString(Node xmlNode) throws TransformerFactoryConfigurationError, TransformerException {
        Transformer transformer = TransformerFactory.newInstance().newTransformer();
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");

        //initialize StreamResult with File object to save to file
        StreamResult result = new StreamResult(new StringWriter());
        DOMSource source = new DOMSource(xmlNode);
        transformer.transform(source, result);

        return result.getWriter().toString();
    }


    public static Document parseXmlString(String xmlString) throws Exception {
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        DocumentBuilder docBuilder = dbf.newDocumentBuilder();
        return docBuilder.parse(new ByteArrayInputStream(xmlString.getBytes("UTF-8")));
    }

    public static String xmlSerialize(Date date) {
        if (date == null) {
            return null;
        }
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'.'SSSZ");
        sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
        return sdf.format(date);
    }

    public static Date parseXmlDate(String xmlDateStr) throws Exception {
        if (xmlDateStr == null || xmlDateStr.trim().length() < 1) {
            return null;
        }
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'.'SSSZ");
        sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
        return sdf.parse(xmlDateStr);
    }

    public static String xmlEncode(String str) {
        return str.replace("&", "&")
                   .replace("<", "<")
                   .replace("<", ">")
                   .replace("\"", """)
                   .replace("'", "'");
    }

    /// 
    /// Utility function to retrieve typed value of first elem with tag elementName, or defaultVal if not found
    /// 
    /// 
    /// 
    /// 
    public static Object getNamedElemValue(Element parent, String elementName, Class basicType, Object defaultVal) {
        String val = getNamedElemValue(parent, elementName);
        if (val == null) {
            return defaultVal;
        }

        try {
            if (Boolean.class.equals(basicType)) {
                return Boolean.parseBoolean(val);
            } else if (Integer.class.equals(basicType)) {
                return Integer.parseInt(val);
            } else if (Float.class.equals(basicType)) {
                return Float.parseFloat(val);
            } else if (Double.class.equals(basicType)) {
                return Double.parseDouble(val);
            } else {
                return val;
            }
        } catch (Exception e) {
            return defaultVal;
        }
    }

    /// 
    /// Utility function to retrieve inner text of first elem with tag elementName, or null if not found
    /// 
    /// 
    /// 
    /// 
    public static String getNamedElemValue(Element parent, String elementName) {
        String val = null;
        NodeList list = parent.getElementsByTagName(elementName);
        if (list.getLength() > 0) {
            val = list.item(0).getTextContent();
        }
        return val;
    }

    /// 
    /// Utility function to retrieve inner text of first elem with tag elementName, or null if not found
    /// 
    /// 
    /// 
    /// 
    public static String getNamedElemXml(Element parent, String elementName) throws Exception {
        String val = null;
        NodeList list = parent.getElementsByTagName(elementName);
        if (list.getLength() > 0) {
            val = getXmlString(list.item(0));
        }
        return val;
    }

    public static String getNamedTextElemXml(String tagName, String value) {
        if (value == null || value.trim().length() < 1) {
            return "<" + tagName + "/>";
        }
        return "<" + tagName + ">";
    }

    /// 
    /// Utility function to retrieve inner text of first elem with tag elementName, or null if not found
    /// 
    /// 
    /// 
    /// 
    public static String getChildElemText(Element parent, String tagName) {
        String val = null;
        Element childElem = getFirstChildByTagName(parent, tagName);
        if (childElem != null) {
            val = childElem.getTextContent();
        }
        return val;
    }

    public static Element getFirstChildByTagName(Node parent, String tagName) {
        List children = getChildrenByTagName(parent, tagName);
        return (children.size() == 0) ? null : children.get(0);
    }

    public static List getChildrenByTagName(Node parent, String tagName) {
        ArrayList elements = new ArrayList();
        NodeList children = parent.getChildNodes();
        for (int i = 0; i < children.getLength(); i++) {
            Node child = children.item(i);
            if (child instanceof Element) {
                Element elem = (Element) children.item(i);
                if (tagName.equals(elem.getTagName())) {
                    elements.add(elem);
                }
            }
        }
        return elements;
    }
}