ezvcard.util

Class XmlUtils

java.lang.Object

ezvcard.util.XmlUtils

public final class XmlUtils
extends Object

Generic XML utility methods.

Author:

Michael Angstadt

Method Summary

Modifier and Type	Method and Description
static void	applyXXEProtection(DocumentBuilderFactory factory) Configures a DocumentBuilderFactory to protect it against XML External Entity attacks.
static void	applyXXEProtection(TransformerFactory factory) Configures a TransformerFactory to protect it against XML External Entity attacks.
static void	assignOutputProperties(Transformer transformer, Map<String,String> outputProperties) Assigns the given output properties to the given transformer, ignoring invalid output properties.
static Document	createDocument() Creates a new XML document.
static Element	getFirstChildElement(Element parent) Gets the first child element of an element.
static boolean	hasQName(Node node, QName qname) Determines if a node has a particular qualified name.
static Document	toDocument(File file) Parses an XML document from a file.
static Document	toDocument(InputStream in) Parses an XML document from an input stream.
static Document	toDocument(Reader reader) Parses an XML document from a reader.
static Document	toDocument(String xml) Parses an XML string into a DOM.
static List<Element>	toElementList(NodeList nodeList) Gets all the elements out of a NodeList.
static String	toString(Node node) Converts an XML node to a string.
static String	toString(Node node, Map<String,String> outputProperties) Converts an XML node to a string.
static void	toWriter(Node node, Writer writer) Writes an XML node to a writer.
static void	toWriter(Node node, Writer writer, Map<String,String> outputProperties) Writes an XML node to a writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDocument

public static Document createDocument()

Creates a new XML document.

Returns:

the XML document

toDocument

public static Document toDocument(String xml)
                           throws SAXException

Parses an XML string into a DOM.

Parameters:

xml - the XML string

Returns:

the parsed DOM

Throws:

SAXException - if the string is not valid XML

toDocument

public static Document toDocument(File file)
                           throws SAXException,
                                  IOException

Parses an XML document from a file.

Parameters:

file - the file

Returns:

the parsed DOM

Throws:

SAXException - if the XML is not valid

IOException - if there is a problem reading from the file

toDocument

public static Document toDocument(InputStream in)
                           throws SAXException,
                                  IOException

Parses an XML document from an input stream.

Parameters:

in - the input stream

Returns:

the parsed DOM

Throws:

SAXException - if the XML is not valid

IOException - if there is a problem reading from the input stream

toDocument

public static Document toDocument(Reader reader)
                           throws SAXException,
                                  IOException

Parses an XML document from a reader.

Note that use of this method is discouraged. It ignores the character encoding that is defined within the XML document itself, and should only be used if the encoding is undefined or if the encoding needs to be ignored for whatever reason. The toDocument(InputStream) method should be used instead, since it takes the XML document's character encoding into account when parsing.

Parameters:

reader - the reader

Returns:

the parsed DOM

Throws:

SAXException - if the XML is not valid

IOException - if there is a problem reading from the reader

See Also:

http://stackoverflow.com/q/3482494/13379

applyXXEProtection

public static void applyXXEProtection(DocumentBuilderFactory factory)

Configures a DocumentBuilderFactory to protect it against XML External Entity attacks.

Parameters:

factory - the factory

See Also:

XXE Cheat Sheet

applyXXEProtection

public static void applyXXEProtection(TransformerFactory factory)

Configures a TransformerFactory to protect it against XML External Entity attacks.

Parameters:

factory - the factory

See Also:

XXE Cheat Sheet

toString

public static String toString(Node node)

Converts an XML node to a string.

Parameters:

node - the XML node

Returns:

the string

toString

public static String toString(Node node,
                              Map<String,String> outputProperties)

Converts an XML node to a string.

Parameters:

node - the XML node

outputProperties - the output properties

Returns:

the string

toWriter

public static void toWriter(Node node,
                            Writer writer)
                     throws TransformerException

Writes an XML node to a writer.

Parameters:

node - the XML node

writer - the writer

Throws:

TransformerException - if there's a problem writing to the writer

toWriter

public static void toWriter(Node node,
                            Writer writer,
                            Map<String,String> outputProperties)
                     throws TransformerException

Writes an XML node to a writer.

Parameters:

node - the XML node

writer - the writer

outputProperties - the output properties

Throws:

TransformerException - if there's a problem writing to the writer

assignOutputProperties

public static void assignOutputProperties(Transformer transformer,
                                          Map<String,String> outputProperties)

Assigns the given output properties to the given transformer, ignoring invalid output properties.

Parameters:

transformer - the transformer

outputProperties - the output properties

toElementList

public static List<Element> toElementList(NodeList nodeList)

Gets all the elements out of a NodeList.

Parameters:

nodeList - the node list

Returns:

the elements

getFirstChildElement

public static Element getFirstChildElement(Element parent)

Gets the first child element of an element.

Parameters:

parent - the parent element

Returns:

the first child element or null if there are no child elements

hasQName

public static boolean hasQName(Node node,
                               QName qname)

Determines if a node has a particular qualified name.

Parameters:

node - the node

qname - the qualified name

Returns:

true if the node has the given qualified name, false if not