connector.common

Class XmlUtil

java.lang.Object

connector.common.XmlUtil

public class XmlUtil
extends java.lang.Object

Utilities for creating and parsing XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlUtil.SailPointEntityResolver Custom entity resolver that handles different locations.
static class	XmlUtil.SailPointErrorHandler Custom error handler that just throws exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
static char	DOUBLE_QUOTE
static char	SINGLE_QUOTE

Constructor Summary

Constructors

Constructor and Description
XmlUtil()

Method Summary

Modifier and Type	Method and Description
static void	addAttribute(java.lang.StringBuilder b, java.lang.String name, java.lang.String value) Adds an attribute name and value to a string buffer.
static void	addContent(java.lang.StringBuilder b, java.lang.Object o) Replaces special characters in a string with XML character entities.
static java.lang.String	DocumentToString(org.w3c.dom.Document doc) Converts (@code Document) to XML string
static java.lang.String	escapeAttribute(java.lang.String s) Escape the given attribute.
static void	escapeAttribute(java.lang.StringBuilder b, java.lang.String s) Escape the given attribute and store it in the given StringBuffer.
static void	escapeAttribute(java.io.Writer f, java.lang.String s) Variant for Writers.
static java.lang.String	escapeContent(java.lang.String s) Escape the given element content.
static void	escapeContent(java.lang.StringBuilder b, java.lang.String s) Differs from escapeAttribute in that we don't escape quotes.
static void	escapeContent(java.io.Writer f, java.lang.String s) Escape the given element content and stream it to a Writer.
static java.lang.Object	evaluateXpath(org.w3c.dom.Node xmlDocument, java.lang.String xpath, java.util.Map<java.lang.String,java.lang.String> namespaceMappings, javax.xml.namespace.QName qname)
static java.lang.Object	evaluateXpath(org.w3c.dom.Node xmlDocument, java.lang.String xpath, java.util.Map<java.lang.String,java.lang.String> namespaceMappings, javax.xml.namespace.QName qname, boolean isOptionalNameSpacePrefix)
static java.util.Map<java.lang.String,java.lang.String>	extractNamespaces(java.lang.String xmlContent) Extracts and prepares namespace prefix to namespace URI mappings
static java.util.List<java.lang.String>	extractNodes(java.lang.String rawResponse, java.lang.String rootPath, java.util.Map<java.lang.String,java.lang.String> namespaceMappings) Extracts all the child nodes of a given rooth path and prepares the child node list
static org.w3c.dom.Text	findText(org.w3c.dom.Node node, boolean ignoreEmpty) Search for the first Text node beneath a node.
static java.lang.String	getAttribute(org.w3c.dom.Element e, java.lang.String name) Get an attribute, collapsing empty strings to null.
static org.w3c.dom.Element	getChildElement(org.w3c.dom.Node node) Dig out the first child element under a node.
static org.w3c.dom.Element	getChildElement(org.w3c.dom.Node node, java.lang.String elementName) Dig out the child element with the given name under a node.
static java.lang.String	getContent(org.w3c.dom.Element e) Return the content of an element as a string.
static org.w3c.dom.Document	getDocument(java.lang.String xml) Prepares a Document object using the supplied XML string.
static org.w3c.dom.Document	getDocument(java.lang.String xml, boolean isNamespaceAware) Prepares a Document object using the supplied XML string.
static org.w3c.dom.Element	getNextElement(org.w3c.dom.Node node) Get the next right sibling that is an element.
static javax.xml.xpath.XPath	getXpath(java.util.Map<java.lang.String,java.lang.String> namespaceMappings) Creates a XPath object using the supplied map containing namespace mappings.
static javax.xml.xpath.XPath	getXpath(java.util.Map<java.lang.String,java.lang.String> namespaceMappings, boolean isOptionalNameSpacePrefix) Creates a XPath object using the supplied map containing namespace mappings.
static javax.xml.xpath.XPathExpression	getXpathExpression(java.lang.String xpathExpr, java.util.Map<java.lang.String,java.lang.String> namespaceMappings) Prepares an XPathExpression object using the supplied XPath expression and the namespace mappings.
static javax.xml.xpath.XPathExpression	getXpathExpression(java.lang.String xpathExpr, java.util.Map<java.lang.String,java.lang.String> namespaceMappings, boolean isOptionalNameSpacePrefix) Prepares an XPathExpression object using the supplied XPath expression and the namespace mappings.
static boolean	isXmlChar(char ch) Return whether the given character is an XML char.
static org.w3c.dom.Element	parseOld(java.lang.String xml, java.lang.String dtd, boolean validating) Parse an XML string and return the document element.
static void	println(java.lang.Object o) exclude
static void	serialize(java.lang.StringBuilder b, org.w3c.dom.Node node) Serialize the given Node into the given StringBuilder.
static java.lang.String	unescapeAttribute(java.lang.String s) Unescape an XML attribute - this is the inverse of escapeAttribute().

Methods inherited from class java.lang.Object

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

Field Detail

DOUBLE_QUOTE

public static final char DOUBLE_QUOTE

See Also:

Constant Field Values

SINGLE_QUOTE

public static final char SINGLE_QUOTE

See Also:

Constant Field Values

Constructor Detail

XmlUtil

public XmlUtil()

Method Detail

println

public static void println(java.lang.Object o)

exclude

getDocument

public static org.w3c.dom.Document getDocument(java.lang.String xml)
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException

Prepares a Document object using the supplied XML string.

Parameters:

xml - string value of XML content

Returns:

a Document object

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getDocument

public static org.w3c.dom.Document getDocument(java.lang.String xml,
                                               boolean isNamespaceAware)
                                        throws org.xml.sax.SAXException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException

Prepares a Document object using the supplied XML string.

Parameters:

xml - string value of XML content

isNamespaceAware - boolean value to indicate whether the generated Document is namespace aware

Returns:

a Document object

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getXpathExpression

public static javax.xml.xpath.XPathExpression getXpathExpression(java.lang.String xpathExpr,
                                                                 java.util.Map<java.lang.String,java.lang.String> namespaceMappings)
                                                          throws javax.xml.xpath.XPathExpressionException

Prepares an XPathExpression object using the supplied XPath expression and the namespace mappings.

namespaceMappings should contain all non-standard XML namespaces which may exist in the XML for correct parsing using XPath.

Parameters:

xpathExpr - string representation of XPath expression

namespaceMappings - namespace mappings, if any, can be null

Returns:

an XPathExpression object

Throws:

javax.xml.xpath.XPathExpressionException

getXpathExpression

public static javax.xml.xpath.XPathExpression getXpathExpression(java.lang.String xpathExpr,
                                                                 java.util.Map<java.lang.String,java.lang.String> namespaceMappings,
                                                                 boolean isOptionalNameSpacePrefix)
                                                          throws javax.xml.xpath.XPathExpressionException

Prepares an XPathExpression object using the supplied XPath expression and the namespace mappings.

namespaceMappings should contain all non-standard XML namespaces which may exist in the XML for correct parsing using XPath.

Parameters:

xpathExpr - string representation of XPath expression

namespaceMappings - namespace mappings, if any, can be null

isOptionalNameSpacePrefix - boolean value to determine that namespace prefix is optional or not for XPATH evaluation

Returns:

an XPathExpression object

Throws:

javax.xml.xpath.XPathExpressionException

getXpath

public static javax.xml.xpath.XPath getXpath(java.util.Map<java.lang.String,java.lang.String> namespaceMappings)

Creates a XPath object using the supplied map containing namespace mappings.

namespaceMappings should contain all non-standard XML namespaces which may exist in the XML for correct parsing using XPath.

Parameters:

namespaceMappings - namespace mappings, if any, can be null

Returns:

an XPath object

getXpath

public static javax.xml.xpath.XPath getXpath(java.util.Map<java.lang.String,java.lang.String> namespaceMappings,
                                             boolean isOptionalNameSpacePrefix)

Creates a XPath object using the supplied map containing namespace mappings.

namespaceMappings should contain all non-standard XML namespaces which may exist in the XML for correct parsing using XPath.

Parameters:

namespaceMappings - namespace mappings, if any, can be null

isOptionalNameSpacePrefix - boolean value to determine that namespace prefix * is optional or not for XPATH evaluation

Returns:

an XPath object

evaluateXpath

public static java.lang.Object evaluateXpath(org.w3c.dom.Node xmlDocument,
                                             java.lang.String xpath,
                                             java.util.Map<java.lang.String,java.lang.String> namespaceMappings,
                                             javax.xml.namespace.QName qname)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             javax.xml.parsers.ParserConfigurationException,
                                             javax.xml.xpath.XPathExpressionException

Parameters:

xmlDocument -

xpath -

namespaceMappings -

qname -

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.xml.xpath.XPathExpressionException

evaluateXpath

public static java.lang.Object evaluateXpath(org.w3c.dom.Node xmlDocument,
                                             java.lang.String xpath,
                                             java.util.Map<java.lang.String,java.lang.String> namespaceMappings,
                                             javax.xml.namespace.QName qname,
                                             boolean isOptionalNameSpacePrefix)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             javax.xml.parsers.ParserConfigurationException,
                                             javax.xml.xpath.XPathExpressionException

Parameters:

xmlDocument -

xpath -

namespaceMappings -

qname -

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.xml.xpath.XPathExpressionException

parseOld

public static org.w3c.dom.Element parseOld(java.lang.String xml,
                                           java.lang.String dtd,
                                           boolean validating)

Parse an XML string and return the document element. The new parse() in sailpoint.tools.XmlUtil uses pool XML parsers - sailpoint.tools.XmlParser

getAttribute

public static java.lang.String getAttribute(org.w3c.dom.Element e,
                                            java.lang.String name)

Get an attribute, collapsing empty strings to null.

getChildElement

public static org.w3c.dom.Element getChildElement(org.w3c.dom.Node node)

Dig out the first child element under a node. This is typically the first one, but there can be comments, processing instructions, and pcdata in the way.

getChildElement

public static org.w3c.dom.Element getChildElement(org.w3c.dom.Node node,
                                                  java.lang.String elementName)

Dig out the child element with the given name under a node.

getNextElement

public static org.w3c.dom.Element getNextElement(org.w3c.dom.Node node)

Get the next right sibling that is an element.

findText

public static org.w3c.dom.Text findText(org.w3c.dom.Node node,
                                        boolean ignoreEmpty)

Search for the first Text node beneath a node.

getContent

public static java.lang.String getContent(org.w3c.dom.Element e)

Return the content of an element as a string.

escapeAttribute

public static java.lang.String escapeAttribute(java.lang.String s)

Escape the given attribute.

escapeAttribute

public static void escapeAttribute(java.lang.StringBuilder b,
                                   java.lang.String s)

Escape the given attribute and store it in the given StringBuffer. ignore - !! TODO: need to pass in the delimiter being used so we know which one to escape and which to preserve.

escapeAttribute

public static void escapeAttribute(java.io.Writer f,
                                   java.lang.String s)
                            throws java.io.IOException

Variant for Writers.

ignore - As always happens, some zealous refactorer is going to look at this someday, declare "it sucks" and launch off into an over-engineered blowout that lets us stream XML into anything with a hole. Just remember that this is an "inner loop" utility, we should not be generating garbage in here. Due to the inconsistent java.io classes, this makes it almost impossible to do without duplication. If we do anything we define our own stream interface with implementations built on various shards of java.io.

Throws:

java.io.IOException

unescapeAttribute

public static java.lang.String unescapeAttribute(java.lang.String s)

Unescape an XML attribute - this is the inverse of escapeAttribute().

escapeContent

public static void escapeContent(java.lang.StringBuilder b,
                                 java.lang.String s)

Differs from escapeAttribute in that we don't escape quotes. Also handles the ]]> CDATA ending sequence. Technically we should be doing that for attributes but we never try to store escaped XML in attribute content.

ignore - NOTE: Originally we escaped newlines, returns, and tabs, but this made it impossible to edit Rule source because all formatting was lost. These characters are all valid in element content so I'm not sure why we escaped them. If you think you need to put the escaping back, discuss with the team, we may need a way for XMLProperty to declare ecaping style.

escapeContent

public static java.lang.String escapeContent(java.lang.String s)

Escape the given element content.

escapeContent

public static void escapeContent(java.io.Writer f,
                                 java.lang.String s)
                          throws java.io.IOException

Escape the given element content and stream it to a Writer.

ignore - A variant that streams to a file. It's too bad that we have to duplicate this but it seems silly to create wrapper garbage around StringBuilder just so we can share the guts.

As always happens, some zealous refactorer is going to look at this someday, declare "it sucks" and launch off into an over-engineered blowout that lets us stream XML into anything with a hole. Just remember that this is an "inner loop" utility, we should not be generating garbage in here. Due to the inconsistent java.io classes, this makes it almost impossible to do without duplication. If we do anything we define our own stream interface with implementations built on various shards of java.io.

See escapeContent(StringBuilder, String) for more information about what we need to escape.

Throws:

java.io.IOException

isXmlChar

public static boolean isXmlChar(char ch)

Return whether the given character is an XML char.

serialize

public static void serialize(java.lang.StringBuilder b,
                             org.w3c.dom.Node node)

Serialize the given Node into the given StringBuilder.

addContent

public static void addContent(java.lang.StringBuilder b,
                              java.lang.Object o)

Replaces special characters in a string with XML character entities. The characters replaced are '&' and '<'. This should be when building strings intended to be the values of XML attributes or XML element content.

addAttribute

public static void addAttribute(java.lang.StringBuilder b,
                                java.lang.String name,
                                java.lang.String value)

Adds an attribute name and value to a string buffer.

Performs any necessary escaping on the value. This should be used when you're building the XML for something, and its possible for an attribute value to have any of the characters &, ', or "

extractNamespaces

public static java.util.Map<java.lang.String,java.lang.String> extractNamespaces(java.lang.String xmlContent)

Extracts and prepares namespace prefix to namespace URI mappings

Parameters:

xmlContent - XML content to extract namespace information from

Returns:

Map containing keys as namespace prefix and namespace URI as corresponding values

extractNodes

public static java.util.List<java.lang.String> extractNodes(java.lang.String rawResponse,
                                                            java.lang.String rootPath,
                                                            java.util.Map<java.lang.String,java.lang.String> namespaceMappings)
                                                     throws javax.xml.xpath.XPathExpressionException,
                                                            org.xml.sax.SAXException,
                                                            java.io.IOException,
                                                            javax.xml.parsers.ParserConfigurationException

Extracts all the child nodes of a given rooth path and prepares the child node list

Parameters:

rawResponse - XML Response

rootPath - string representation of XPath expression

namespaceMappings - namespace mappings, if any

Returns:

List containing list of nodes in String format

Throws:

javax.xml.xpath.XPathExpressionException

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

DocumentToString

public static java.lang.String DocumentToString(org.w3c.dom.Document doc)
                                         throws java.io.IOException

Converts (@code Document) to XML string

Parameters:

doc - Document object

Returns:

String converted XML string

Throws:

java.io.IOException