Package com.thingworx.common.utils

Class XMLUtilities

java.lang.Object

com.thingworx.common.utils.XMLUtilities

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class XMLUtilities
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ENABLE_XXE

Constructor Summary

Constructors

Constructor	Description
XMLUtilities()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
static Document	createDocument()
static Document	createDocument(String contentStr)	Currently used for service requests
static DocumentBuilderFactory	createDocumentBuilderFactory()
static Document	createDocumentFromStream(InputStream is)	Used for importing Entity from file and attachments
static Element	getChildElementByTagName(Element node, String element)
static ArrayList<Element>	getChildElements(Element node)
static ArrayList<Element>	getChildElementsByTagName(Element node, String element)
static String	getChildElementValueByTagName(Element node, String element)
static String	getChildElementValueByTagNameWithNull(Element node, String element)
static Document	getDocument(InputStream in)	Currently used for importing default entities for High Availability (HA) and getDocument(File).
static Document	getDocument(Reader in)	Currently used for converting to Primitive and storing data.
static Element	getElementByTagName(Element node, String element)
static String	getElementValueByTagName(Element node, String element)
static String	getNodeValue(Node node)	Will return the String value of the given node.
static String	getTextContent(Node node)
static String	outputXMLDoc(Document doc)	Used for XML POST and PUT
static void	outputXMLDoc(Document doc, OutputStream output)	Used for generating unformatted XML.
static void	outputXMLDoc(Document doc, Writer output)	Used for generating unformatted XML.
static String	outputXMLDocFormatted(Document doc)
static void	outputXMLDocFormatted(Document doc, OutputStream output)	Used for exporting source as zip
static void	outputXMLDocFormatted(Document doc, OutputStream output, Integer indent)	Deprecated. indent is no longer supported
static void	outputXMLDocFormatted(Document doc, Writer output)	Used for generating formatted XML for Source Export operations.
static String	outputXMLDocFormatted(Document doc, Integer indent)	Deprecated. indent is no longer supported
static void	outputXMLDocFormatted(Document outdoc, String filepath)	Used for exporting source control entities
static void	setNodeValue(Node nodeTarget, String value)

Methods inherited from class java.lang.Object

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

Field Details

ENABLE_XXE

public static boolean ENABLE_XXE

Constructor Details

XMLUtilities

public XMLUtilities()

Initializes this instace with default values.

Method Details

createDocumentBuilderFactory

@ThingworxExtensionApiMethod(since={6,6})
public static DocumentBuilderFactory createDocumentBuilderFactory()
                                                           throws ParserConfigurationException

Throws:

ParserConfigurationException

createDocumentFromStream

@ThingworxExtensionApiMethod(since={6,6})
public static Document createDocumentFromStream(InputStream is)
                                         throws Exception

Used for importing Entity from file and attachments

Throws:

Exception

createDocument

@ThingworxExtensionApiMethod(since={6,6})
public static Document createDocument()

createDocument

@ThingworxExtensionApiMethod(since={6,6})
public static Document createDocument(String contentStr)
                               throws Exception

Currently used for service requests

Throws:

Exception

getDocument

@ThingworxExtensionApiMethod(since={6,6})
public static Document getDocument(InputStream in)
                            throws Exception

Currently used for importing default entities for High Availability (HA) and getDocument(File).

Throws:

Exception

getDocument

@ThingworxExtensionApiMethod(since={6,6})
public static Document getDocument(Reader in)
                            throws Exception

Currently used for converting to Primitive and storing data.

Throws:

Exception

outputXMLDoc

@ThingworxExtensionApiMethod(since={6,6})
public static void outputXMLDoc(Document doc,
 OutputStream output)
                         throws Exception

Used for generating unformatted XML.

Throws:

Exception

outputXMLDoc

@ThingworxExtensionApiMethod(since={6,6})
public static void outputXMLDoc(Document doc,
 Writer output)
                         throws Exception

Used for generating unformatted XML.

Throws:

Exception

outputXMLDoc

@ThingworxExtensionApiMethod(since={6,6})
public static String outputXMLDoc(Document doc)

Used for XML POST and PUT

outputXMLDocFormatted

@ThingworxExtensionApiMethod(since={8,1})
public static void outputXMLDocFormatted(Document doc,
 Writer output)
                                  throws Exception

Used for generating formatted XML for Source Export operations. The XML will be indented using four spaces, line feed for new line, expand empty elements, add new lines for element attributes, format CDATA.

Throws:

Exception

outputXMLDocFormatted

@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={8,1})
@Deprecated
public static void outputXMLDocFormatted(Document doc,
 OutputStream output,
 Integer indent)
                                  throws Exception

Deprecated.

indent is no longer supported

Throws:

Exception

See Also:

• outputXMLDocFormatted(Document, OutputStream)

outputXMLDocFormatted

@ThingworxExtensionApiMethod(since={8,1})
public static void outputXMLDocFormatted(Document doc,
 OutputStream output)
                                  throws Exception

Used for exporting source as zip

Throws:

Exception

See Also:

• outputXMLDocFormatted(Document, Writer)

outputXMLDocFormatted

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={8,1})
public static String outputXMLDocFormatted(Document doc,
 Integer indent)

Deprecated.

indent is no longer supported

See Also:

• outputXMLDocFormatted(Document)

outputXMLDocFormatted

@ThingworxExtensionApiMethod(since={8,1})
public static String outputXMLDocFormatted(Document doc)

See Also:

• outputXMLDocFormatted(Document, Writer)

outputXMLDocFormatted

@ThingworxExtensionApiMethod(since={8,1})
public static void outputXMLDocFormatted(Document outdoc,
 String filepath)
                                  throws Exception

Used for exporting source control entities

Throws:

Exception

See Also:

• outputXMLDocFormatted(Document, Writer)

getTextContent

@ThingworxExtensionApiMethod(since={6,6})
public static String getTextContent(Node node)

getElementValueByTagName

@ThingworxExtensionApiMethod(since={6,6})
public static String getElementValueByTagName(Element node,
 String element)

getChildElementByTagName

@ThingworxExtensionApiMethod(since={6,6})
public static Element getChildElementByTagName(Element node,
 String element)

getChildElements

@ThingworxExtensionApiMethod(since={6,6})
public static ArrayList<Element> getChildElements(Element node)

getChildElementsByTagName

@ThingworxExtensionApiMethod(since={6,6})
public static ArrayList<Element> getChildElementsByTagName(Element node,
 String element)

getChildElementValueByTagNameWithNull

@ThingworxExtensionApiMethod(since={6,6})
public static String getChildElementValueByTagNameWithNull(Element node,
 String element)

getChildElementValueByTagName

@ThingworxExtensionApiMethod(since={6,6})
public static String getChildElementValueByTagName(Element node,
 String element)

getElementByTagName

@ThingworxExtensionApiMethod(since={6,6})
public static Element getElementByTagName(Element node,
 String element)

getNodeValue

@ThingworxExtensionApiMethod(since={6,6})
public static String getNodeValue(Node node)

Will return the String value of the given node. This method accepts Node's of type Node.ELEMENT_NODE, Node.ATTRIBUTE_NODE, Node.TEXT_NODE and Node.CDATA_SECTION_NODE. All other Node types will return an empty string.

Note: As of 7.2.0, if an Node.ELEMENT_NODE node has child Node.TEXT_NODE nodes containing only whitespace characters (like newlines or tabs) the node will be treated as an empty string. For example, if Node.TEXT_NODE node only contains "\n\t\t\t", the value will be "".

Parameters:

node - The DOM node that you want to retrieve the text value from

Returns:

The value of the given DOM node

setNodeValue

@ThingworxExtensionApiMethod(since={6,6})
public static void setNodeValue(Node nodeTarget,
 String value)