org.codice.ddf.platform.util

Class XMLUtils

java.lang.Object

org.codice.ddf.platform.util.XMLUtils

public class XMLUtils
extends Object

Utility for handling XML

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLUtils.ResultHolder<T> This class is used with the processElements method.

Field Summary

Fields

Modifier and Type	Field and Description
protected XMLInputFactory	xmlInputFactory

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
String	format(Node nodeXml, TransformerProperties transformerProperties)
String	format(Source sourceXml, TransformerProperties transformProperties) Formats XML into a String
static XMLUtils	getInstance()
String	getRootNamespace(String xml)
DocumentBuilder	getSecureDocumentBuilder(boolean namespaceAware)
DocumentBuilderFactory	getSecureDocumentBuilderFactory()
DocumentBuilderFactory	getSecureDocumentBuilderFactory(String className, ClassLoader classLoader)
SAXParser	getSecureSAXParser(boolean namespaceAware)
SAXParserFactory	getSecureSAXParserFactory()
SAXParserFactory	getSecureSAXParserFactory(String className, ClassLoader classLoader)
XMLInputFactory	getSecureXmlInputFactory()
XMLReader	getSecureXmlParser()
XMLReader	getSecureXmlParser(String className)
TransformerFactory	getSecureXmlTransformerFactory()
TransformerFactory	getSecureXmlTransformerFactory(String className, ClassLoader classLoader)
Transformer	getXmlTransformer(boolean omitXml)
Document	parseDocument(InputStream inputStream, boolean namespaceAware)
String	prettyFormat(Node nodeXml) Nicely formats XML into a String
String	prettyFormat(Source sourceXml) Nicely formats XML into a String
<T> T	processElements(String xml, BiFunction<XMLUtils.ResultHolder<T>,XMLStreamReader,Boolean> processElementFunction) Iterate through the elements of an XML document.
Result	transform(Node nodeXml, TransformerProperties transformerProperties, Result result)
Result	transform(Source sourceXml, TransformerProperties transformProperties, Result result) Transforms XML into a Result

Methods inherited from class java.lang.Object

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

Field Detail

xmlInputFactory

protected XMLInputFactory xmlInputFactory

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

getInstance

public static XMLUtils getInstance()

format

public String format(Source sourceXml,
                     TransformerProperties transformProperties)

Formats XML into a String

Parameters:

sourceXml - to transform a given Source

transformProperties - settings for transformer

Returns:

XML string

format

public String format(Node nodeXml,
                     TransformerProperties transformerProperties)

Parameters:

nodeXml - to transform a given Node

transformerProperties - settings for transformer

Returns:

XML String

prettyFormat

public String prettyFormat(Source sourceXml)

Nicely formats XML into a String

Parameters:

sourceXml - to transform a given Source

Returns:

XML string

prettyFormat

public String prettyFormat(Node nodeXml)

Nicely formats XML into a String

Parameters:

nodeXml - to transform a given Node

Returns:

XML string

transform

public Result transform(Source sourceXml,
                        TransformerProperties transformProperties,
                        Result result)

Transforms XML into a Result

Parameters:

sourceXml - to transform a given Source

transformProperties - settings for transformer

result - Result to transform into

Returns:

XML Result

transform

public Result transform(Node nodeXml,
                        TransformerProperties transformerProperties,
                        Result result)

Parameters:

nodeXml - to transform a given Node

transformerProperties - settings for transformer

result - Result to transform into

Returns:

XML Result

getRootNamespace

public String getRootNamespace(String xml)

Parameters:

xml - The XML whose root namespace you want

Returns:

Root Namespace

processElements

public <T> T processElements(String xml,
                             BiFunction<XMLUtils.ResultHolder<T>,XMLStreamReader,Boolean> processElementFunction)

Iterate through the elements of an XML document. The processor calls the processElementFunction for each element. Call result.set() to change the value that will be returned.

If the function returns true, processing continues to the next element. When the last element in the document is processed, the value in the result is returned.

If the lambda function returns false, processing stops. The value of the result is returned.

If the function encounters a processing exception, processing stops and null is returned.

Parameters:

xml - The XML to process

processElementFunction - Function that accepts an instance of XMLStreamReader and result holder. The function must return a boolean.

Returns:

The result of the processing

getSecureXmlInputFactory

public XMLInputFactory getSecureXmlInputFactory()

getSecureDocumentBuilderFactory

public DocumentBuilderFactory getSecureDocumentBuilderFactory(String className,
                                                              ClassLoader classLoader)

getSecureDocumentBuilderFactory

public DocumentBuilderFactory getSecureDocumentBuilderFactory()

getSecureDocumentBuilder

public DocumentBuilder getSecureDocumentBuilder(boolean namespaceAware)
                                         throws ParserConfigurationException

Throws:

ParserConfigurationException

parseDocument

public Document parseDocument(InputStream inputStream,
                              boolean namespaceAware)
                       throws ParserConfigurationException,
                              IOException,
                              SAXException

Throws:

ParserConfigurationException

IOException

SAXException

getSecureXmlTransformerFactory

public TransformerFactory getSecureXmlTransformerFactory(String className,
                                                         ClassLoader classLoader)

getSecureXmlTransformerFactory

public TransformerFactory getSecureXmlTransformerFactory()

getXmlTransformer

public Transformer getXmlTransformer(boolean omitXml)
                              throws TransformerException

Throws:

TransformerException

getSecureSAXParserFactory

public SAXParserFactory getSecureSAXParserFactory(String className,
                                                  ClassLoader classLoader)

getSecureSAXParserFactory

public SAXParserFactory getSecureSAXParserFactory()

getSecureSAXParser

public SAXParser getSecureSAXParser(boolean namespaceAware)
                             throws ParserConfigurationException,
                                    SAXException

Throws:

ParserConfigurationException

SAXException

getSecureXmlParser

public XMLReader getSecureXmlParser(String className)
                             throws SAXException

Throws:

SAXException

getSecureXmlParser

public XMLReader getSecureXmlParser()
                             throws SAXException

Throws:

SAXException