XMLUtils (Apache XML Security for Java 2.2.0 API)

java.lang.Object
- org.apache.xml.security.utils.XMLUtils

```
public final class XMLUtils
extends Object
```
DOM and XML accessibility and comfort functions.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addReturnBeforeChild(Element e, Node child)`
`static void`	`addReturnToElement(Document doc, HelperNodeList nl)`
`static void`	`addReturnToElement(Element e)` Method addReturnToElement
`static void`	`circumventBug2650(Document doc)` This method spreads all namespace attributes in a DOM document to their children.
`static Set<Node>`	`convertNodelistToSet(NodeList xpathNodeSet)` Method convertNodelistToSet
`static Element`	`createElementInEncryption11Space(Document doc, String elementName)` Creates an Element in the XML Encryption 1.1 specification namespace.
`static Element`	`createElementInEncryptionSpace(Document doc, String elementName)` Creates an Element in the XML Encryption specification namespace.
`static Element`	`createElementInSignature11Space(Document doc, String elementName)` Creates an Element in the XML Signature 1.1 specification namespace.
`static Element`	`createElementInSignatureSpace(Document doc, String elementName)` Creates an Element in the XML Signature specification namespace.
`static byte[]`	`decode(byte[] encodedBytes)`
`static byte[]`	`decode(String encodedString)`
`static boolean`	`elementIsInEncryption11Space(Element element, String localName)` Returns true if the element is in XML Encryption 1.1 namespace and the local name equals the supplied one.
`static boolean`	`elementIsInEncryptionSpace(Element element, String localName)` Returns true if the element is in XML Encryption namespace and the local name equals the supplied one.
`static boolean`	`elementIsInSignature11Space(Element element, String localName)` Returns true if the element is in XML Signature 1.1 namespace and the local name equals the supplied one.
`static boolean`	`elementIsInSignatureSpace(Element element, String localName)` Returns true if the element is in XML Signature namespace and the local name equals the supplied one.
`static String`	`encodeToString(byte[] bytes)`
`static Set<Node>`	`excludeNodeFromSet(Node signatureElement, Set<Node> inputSet)`
`static byte[]`	`getBytes(BigInteger big, int bitlen)` Returns a byte-array representation of a `BigInteger`.
`static String`	`getFullTextChildrenFromNode(Node node)` Method getFullTextChildrenFromNode
`static Element`	`getNextElement(Node el)`
`static Document`	`getOwnerDocument(Node node)` This method returns the owner document of a particular node.
`static Document`	`getOwnerDocument(Set<Node> xpathNodeSet)` This method returns the first non-null owner document of the Nodes in this Set.
`static void`	`getSet(Node rootNode, Set<Node> result, Node exclude, boolean com)`
`static String`	`getStrFromNode(Node xpathnode)` Method getStrFromNode
`static boolean`	`ignoreLineBreaks()`
`static boolean`	`isDescendantOrSelf(Node ctx, Node descendantOrSelf)` Returns true if the descendantOrSelf is on the descendant-or-self axis of the context node.
`static boolean`	`isIgnoreLineBreaks()`
`static void`	`outputDOM(Node contextNode, OutputStream os)` Outputs a DOM tree to an `OutputStream`.
`static void`	`outputDOM(Node contextNode, OutputStream os, boolean addPreamble)` Outputs a DOM tree to an `OutputStream`.
`static void`	`outputDOMc14nWithComments(Node contextNode, OutputStream os)` Serializes the `contextNode` into the OutputStream, but suppresses all Exceptions.
`static boolean`	`protectAgainstWrappingAttack(Node startNode, Element knownElement, String value)` This method is a tree-search to help prevent against wrapping attacks.
`static boolean`	`protectAgainstWrappingAttack(Node startNode, String value)` This method is a tree-search to help prevent against wrapping attacks.
`static Document`	`read(InputStream inputStream, boolean disallowDocTypeDeclarations)`
`static Element`	`selectDs11Node(Node sibling, String nodeName, int number)`
`static Element[]`	`selectDs11Nodes(Node sibling, String nodeName)`
`static Element`	`selectDsNode(Node sibling, String nodeName, int number)`
`static Element[]`	`selectDsNodes(Node sibling, String nodeName)`
`static Element`	`selectNode(Node sibling, String uri, String nodeName, int number)`
`static Element[]`	`selectNodes(Node sibling, String uri, String nodeName)`
`static Element`	`selectXencNode(Node sibling, String nodeName, int number)`
`static void`	`setDs11Prefix(String prefix)` Set the prefix for the digital signature 1.1 namespace
`static void`	`setDsPrefix(String prefix)` Set the prefix for the digital signature namespace
`static void`	`setXenc11Prefix(String prefix)` Set the prefix for the encryption namespace 1.1
`static void`	`setXencPrefix(String prefix)` Set the prefix for the encryption namespace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setDsPrefix
```
public static void setDsPrefix(String prefix)
```
    Set the prefix for the digital signature namespace
    
    Parameters:
    
    prefix - the new prefix for the digital signature namespace
    
    Throws:
    
    SecurityException - if a security manager is installed and the caller does not have permission to set the prefix
  - setDs11Prefix
```
public static void setDs11Prefix(String prefix)
```
    Set the prefix for the digital signature 1.1 namespace
    
    Parameters:
    
    prefix - the new prefix for the digital signature 1.1 namespace
    
    Throws:
    
    SecurityException - if a security manager is installed and the caller does not have permission to set the prefix
  - setXencPrefix
```
public static void setXencPrefix(String prefix)
```
    Set the prefix for the encryption namespace
    
    Parameters:
    
    prefix - the new prefix for the encryption namespace
    
    Throws:
    
    SecurityException - if a security manager is installed and the caller does not have permission to set the prefix
  - setXenc11Prefix
```
public static void setXenc11Prefix(String prefix)
```
    Set the prefix for the encryption namespace 1.1
    
    Parameters:
    
    prefix - the new prefix for the encryption namespace 1.1
    
    Throws:
    
    SecurityException - if a security manager is installed and the caller does not have permission to set the prefix
  - getNextElement
```
public static Element getNextElement(Node el)
```
  - getSet
```
public static void getSet(Node rootNode,
                          Set<Node> result,
                          Node exclude,
                          boolean com)
```
    Parameters:
    
    rootNode -
    
    result -
    
    exclude -
    
    com - whether comments or not
  - outputDOM
```
public static void outputDOM(Node contextNode,
                             OutputStream os)
```
    Outputs a DOM tree to an OutputStream.
    
    Parameters:
    
    contextNode - root node of the DOM tree
    
    os - the OutputStream
  - outputDOM
```
public static void outputDOM(Node contextNode,
                             OutputStream os,
                             boolean addPreamble)
```
    Outputs a DOM tree to an OutputStream. If an Exception is thrown during execution, it's StackTrace is output to System.out, but the Exception is not re-thrown.
    
    Parameters:
    
    contextNode - root node of the DOM tree
    
    os - the OutputStream
    
    addPreamble -
  - outputDOMc14nWithComments
```
public static void outputDOMc14nWithComments(Node contextNode,
                                             OutputStream os)
```
    Serializes the contextNode into the OutputStream, but suppresses all Exceptions.
    NOTE: This should only be used for debugging purposes, NOT in a production environment; this method ignores all exceptions, so you won't notice if something goes wrong. If you're asking what is to be used in a production environment, simply use the code inside the try{} statement, but handle the Exceptions appropriately.
    
    Parameters:
    
    contextNode -
    
    os -
  - getFullTextChildrenFromNode
```
public static String getFullTextChildrenFromNode(Node node)
```
    Method getFullTextChildrenFromNode
    
    Parameters:
    
    node -
    
    Returns:
    
    the string of children
  - createElementInSignatureSpace
```
public static Element createElementInSignatureSpace(Document doc,
                                                    String elementName)
```
    Creates an Element in the XML Signature specification namespace.
    
    Parameters:
    
    doc - the factory Document
    
    elementName - the local name of the Element
    
    Returns:
    
    the Element
  - createElementInSignature11Space
```
public static Element createElementInSignature11Space(Document doc,
                                                      String elementName)
```
    Creates an Element in the XML Signature 1.1 specification namespace.
    
    Parameters:
    
    doc - the factory Document
    
    elementName - the local name of the Element
    
    Returns:
    
    the Element
  - createElementInEncryptionSpace
```
public static Element createElementInEncryptionSpace(Document doc,
                                                     String elementName)
```
    Creates an Element in the XML Encryption specification namespace.
    
    Parameters:
    
    doc - the factory Document
    
    elementName - the local name of the Element
    
    Returns:
    
    the Element
  - createElementInEncryption11Space
```
public static Element createElementInEncryption11Space(Document doc,
                                                       String elementName)
```
    Creates an Element in the XML Encryption 1.1 specification namespace.
    
    Parameters:
    
    doc - the factory Document
    
    elementName - the local name of the Element
    
    Returns:
    
    the Element
  - elementIsInSignatureSpace
```
public static boolean elementIsInSignatureSpace(Element element,
                                                String localName)
```
    Returns true if the element is in XML Signature namespace and the local name equals the supplied one.
    
    Parameters:
    
    element -
    
    localName -
    
    Returns:
    
    true if the element is in XML Signature namespace and the local name equals the supplied one
  - elementIsInSignature11Space
```
public static boolean elementIsInSignature11Space(Element element,
                                                  String localName)
```
    Returns true if the element is in XML Signature 1.1 namespace and the local name equals the supplied one.
    
    Parameters:
    
    element -
    
    localName -
    
    Returns:
    
    true if the element is in XML Signature namespace and the local name equals the supplied one
  - elementIsInEncryptionSpace
```
public static boolean elementIsInEncryptionSpace(Element element,
                                                 String localName)
```
    Returns true if the element is in XML Encryption namespace and the local name equals the supplied one.
    
    Parameters:
    
    element -
    
    localName -
    
    Returns:
    
    true if the element is in XML Encryption namespace and the local name equals the supplied one
  - elementIsInEncryption11Space
```
public static boolean elementIsInEncryption11Space(Element element,
                                                   String localName)
```
    Returns true if the element is in XML Encryption 1.1 namespace and the local name equals the supplied one.
    
    Parameters:
    
    element -
    
    localName -
    
    Returns:
    
    true if the element is in XML Encryption 1.1 namespace and the local name equals the supplied one
  - getOwnerDocument
```
public static Document getOwnerDocument(Node node)
```
    This method returns the owner document of a particular node. This method is necessary because it always returns a Document. Node.getOwnerDocument() returns null if the Node is a Document.
    
    Parameters:
    
    node -
    
    Returns:
    
    the owner document of the node
  - getOwnerDocument
```
public static Document getOwnerDocument(Set<Node> xpathNodeSet)
```
    This method returns the first non-null owner document of the Nodes in this Set. This method is necessary because it always returns a Document. Node.getOwnerDocument() returns null if the Node is a Document.
    
    Parameters:
    
    xpathNodeSet -
    
    Returns:
    
    the owner document
  - addReturnToElement
```
public static void addReturnToElement(Element e)
```
    Method addReturnToElement
    
    Parameters:
    
    e -
  - addReturnToElement
```
public static void addReturnToElement(Document doc,
                                      HelperNodeList nl)
```
  - addReturnBeforeChild
```
public static void addReturnBeforeChild(Element e,
                                        Node child)
```
  - encodeToString
```
public static String encodeToString(byte[] bytes)
```
  - decode
```
public static byte[] decode(String encodedString)
```
  - decode
```
public static byte[] decode(byte[] encodedBytes)
```
  - isIgnoreLineBreaks
```
public static boolean isIgnoreLineBreaks()
```
  - convertNodelistToSet
```
public static Set<Node> convertNodelistToSet(NodeList xpathNodeSet)
```
    Method convertNodelistToSet
    
    Parameters:
    
    xpathNodeSet -
    
    Returns:
    
    the set with the nodelist
  - circumventBug2650
```
public static void circumventBug2650(Document doc)
```
    This method spreads all namespace attributes in a DOM document to their children. This is needed because the XML Signature XPath transform must evaluate the XPath against all nodes in the input, even against XPath namespace nodes. Through a bug in XalanJ2, the namespace nodes are not fully visible in the Xalan XPath model, so we have to do this by hand in DOM spaces so that the nodes become visible in XPath space.
    
    Parameters:
    
    doc -
    
    See Also:
    
    Namespace axis resolution is not XPath compliant
  - selectDsNode
```
public static Element selectDsNode(Node sibling,
                                   String nodeName,
                                   int number)
```
    Parameters:
    
    sibling -
    
    nodeName -
    
    number -
    
    Returns:
    
    nodes with the constraint
  - selectDs11Node
```
public static Element selectDs11Node(Node sibling,
                                     String nodeName,
                                     int number)
```
    Parameters:
    
    sibling -
    
    nodeName -
    
    number -
    
    Returns:
    
    nodes with the constraint
  - selectXencNode
```
public static Element selectXencNode(Node sibling,
                                     String nodeName,
                                     int number)
```
    Parameters:
    
    sibling -
    
    nodeName -
    
    number -
    
    Returns:
    
    nodes with the constrain
  - selectNode
```
public static Element selectNode(Node sibling,
                                 String uri,
                                 String nodeName,
                                 int number)
```
    Parameters:
    
    sibling -
    
    uri -
    
    nodeName -
    
    number -
    
    Returns:
    
    nodes with the constrain
  - selectDsNodes
```
public static Element[] selectDsNodes(Node sibling,
                                      String nodeName)
```
    Parameters:
    
    sibling -
    
    nodeName -
    
    Returns:
    
    nodes with the constrain
  - selectDs11Nodes
```
public static Element[] selectDs11Nodes(Node sibling,
                                        String nodeName)
```
    Parameters:
    
    sibling -
    
    nodeName -
    
    Returns:
    
    nodes with the constrain
  - selectNodes
```
public static Element[] selectNodes(Node sibling,
                                    String uri,
                                    String nodeName)
```
    Parameters:
    
    sibling -
    
    uri -
    
    nodeName -
    
    Returns:
    
    nodes with the constraint
  - excludeNodeFromSet
```
public static Set<Node> excludeNodeFromSet(Node signatureElement,
                                           Set<Node> inputSet)
```
    Parameters:
    
    signatureElement -
    
    inputSet -
    
    Returns:
    
    nodes with the constrain
  - getStrFromNode
```
public static String getStrFromNode(Node xpathnode)
```
    Method getStrFromNode
    
    Parameters:
    
    xpathnode -
    
    Returns:
    
    the string for the node.
  - isDescendantOrSelf
```
public static boolean isDescendantOrSelf(Node ctx,
                                         Node descendantOrSelf)
```
    Returns true if the descendantOrSelf is on the descendant-or-self axis of the context node.
    
    Parameters:
    
    ctx -
    
    descendantOrSelf -
    
    Returns:
    
    true if the node is descendant
  - ignoreLineBreaks
```
public static boolean ignoreLineBreaks()
```
  - protectAgainstWrappingAttack
```
public static boolean protectAgainstWrappingAttack(Node startNode,
                                                   String value)
```
    This method is a tree-search to help prevent against wrapping attacks. It checks that no two Elements have ID Attributes that match the "value" argument, if this is the case then "false" is returned. Note that a return value of "true" does not necessarily mean that a matching Element has been found, just that no wrapping attack has been detected.
  - protectAgainstWrappingAttack
```
public static boolean protectAgainstWrappingAttack(Node startNode,
                                                   Element knownElement,
                                                   String value)
```
    This method is a tree-search to help prevent against wrapping attacks. It checks that no other Element than the given "knownElement" argument has an ID attribute that matches the "value" argument, which is the ID value of "knownElement". If this is the case then "false" is returned.
  - read
```
public static Document read(InputStream inputStream,
                            boolean disallowDocTypeDeclarations)
                     throws XMLParserException
```
    Throws:
    
    XMLParserException
  - getBytes
```
public static byte[] getBytes(BigInteger big,
                              int bitlen)
```
    Returns a byte-array representation of a BigInteger. No sign-bit is output. N.B.: BigInteger's toByteArray returns eventually longer arrays because of the leading sign-bit.
    
    Parameters:
    
    big - BigInteger to be converted
    
    bitlen - int the desired length in bits of the representation
    
    Returns:
    
    a byte array with bitlen bits of big

Class XMLUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setDsPrefix

setDs11Prefix

setXencPrefix

setXenc11Prefix

getNextElement

getSet

outputDOM

outputDOM

outputDOMc14nWithComments

getFullTextChildrenFromNode

createElementInSignatureSpace

createElementInSignature11Space

createElementInEncryptionSpace

createElementInEncryption11Space

elementIsInSignatureSpace

elementIsInSignature11Space

elementIsInEncryptionSpace

elementIsInEncryption11Space

getOwnerDocument

getOwnerDocument

addReturnToElement

addReturnToElement

addReturnBeforeChild

encodeToString

decode

decode

isIgnoreLineBreaks

convertNodelistToSet

circumventBug2650

selectDsNode

selectDs11Node

selectXencNode

selectNode

selectDsNodes

selectDs11Nodes

selectNodes

excludeNodeFromSet

getStrFromNode

isDescendantOrSelf

ignoreLineBreaks

protectAgainstWrappingAttack

protectAgainstWrappingAttack

read

getBytes