Package org.apache.xml.security.utils

Class XMLUtils

  • public class XMLUtils
extends java.lang.Object
    DOM and XML accessibility and comfort functions.
    Author:
    Christian Geuer-Pollmann

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addReturnToElement​(org.w3c.dom.Element e)
      Method addReturnToElement
      static void circumventBug2650​(org.w3c.dom.Document doc)
      This method spreads all namespace attributes in a DOM document to their children.
      static java.util.Set convertNodelistToSet​(org.w3c.dom.NodeList xpathNodeSet)
      Method convertNodelistToSet
      static org.w3c.dom.Element createDSctx​(org.w3c.dom.Document doc, java.lang.String prefix, java.lang.String namespace)
      Method createDSctx
      static org.w3c.dom.Element createElementInSignatureSpace​(org.w3c.dom.Document doc, java.lang.String elementName)
      Creates an Element in the XML Signature specification namespace.
      static boolean elementIsInEncryptionSpace​(org.w3c.dom.Element element, java.lang.String localName)
      Returns true if the element is in XML Encryption namespace and the local name equals the supplied one.
      static boolean elementIsInSignatureSpace​(org.w3c.dom.Element element, java.lang.String localName)
      Returns true if the element is in XML Signature namespace and the local name equals the supplied one.
      static java.util.Set excludeNodeFromSet​(org.w3c.dom.Node signatureElement, java.util.Set inputSet)  
      static java.lang.String getFullTextChildrenFromElement​(org.w3c.dom.Element element)
      Method getFullTextChildrenFromElement
      static org.w3c.dom.Document getOwnerDocument​(java.util.Set xpathNodeSet)
      This method returns the first non-null owner document of the Node's in this Set.
      static org.w3c.dom.Document getOwnerDocument​(org.w3c.dom.Node node)
      This method returns the owner document of a particular node.
      static void getSet​(org.w3c.dom.Node rootNode, java.util.Set result, org.w3c.dom.Node exclude, boolean com)  
      static boolean isDescendantOrSelf​(org.w3c.dom.Node ctx, org.w3c.dom.Node descendantOrSelf)
      Returns true if the descendantOrSelf is on the descendant-or-self axis of the context node.
      static void outputDOM​(org.w3c.dom.Node contextNode, java.io.OutputStream os)
      Outputs a DOM tree to an OutputStream.
      static void outputDOM​(org.w3c.dom.Node contextNode, java.io.OutputStream os, boolean addPreamble)
      Outputs a DOM tree to an OutputStream.
      static void outputDOMc14nWithComments​(org.w3c.dom.Node contextNode, java.io.OutputStream os)
      Serializes the contextNode into the OutputStream, but supresses all Exceptions.
      static org.w3c.dom.Element selectDsNode​(org.w3c.dom.Node sibling, java.lang.String nodeName, int number)  
      static org.w3c.dom.Element[] selectDsNodes​(org.w3c.dom.Node sibling, java.lang.String nodeName)  
      static org.w3c.dom.Text selectDsNodeText​(org.w3c.dom.Node sibling, java.lang.String nodeName, int number)  
      static org.w3c.dom.Element selectNode​(org.w3c.dom.Node sibling, java.lang.String uri, java.lang.String nodeName, int number)  
      static org.w3c.dom.Element[] selectNodes​(org.w3c.dom.Node sibling, java.lang.String uri, java.lang.String nodeName)  
      static org.w3c.dom.Text selectNodeText​(org.w3c.dom.Node sibling, java.lang.String uri, java.lang.String nodeName, int number)  
      static org.w3c.dom.Element selectXencNode​(org.w3c.dom.Node sibling, java.lang.String nodeName, int number)  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getSet

        public static void getSet​(org.w3c.dom.Node rootNode,
                          java.util.Set result,
                          org.w3c.dom.Node exclude,
                          boolean com)
        Parameters:
        rootNode -
        result -
        exclude -
        com - wheather comments or not

      • outputDOM

        public static void outputDOM​(org.w3c.dom.Node contextNode,
                             java.io.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​(org.w3c.dom.Node contextNode,
                             java.io.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​(org.w3c.dom.Node contextNode,
                                             java.io.OutputStream os)
        Serializes the contextNode into the OutputStream, but supresses 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 -

      • getFullTextChildrenFromElement

        public static java.lang.String getFullTextChildrenFromElement​(org.w3c.dom.Element element)
        Method getFullTextChildrenFromElement
        Parameters:
        element -
        Returns:
        the string of chi;ds

      • createElementInSignatureSpace

        public static org.w3c.dom.Element createElementInSignatureSpace​(org.w3c.dom.Document doc,
                                                                java.lang.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

      • elementIsInSignatureSpace

        public static boolean elementIsInSignatureSpace​(org.w3c.dom.Element element,
                                                java.lang.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

      • elementIsInEncryptionSpace

        public static boolean elementIsInEncryptionSpace​(org.w3c.dom.Element element,
                                                 java.lang.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

      • getOwnerDocument

        public static org.w3c.dom.Document getOwnerDocument​(org.w3c.dom.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 org.w3c.dom.Document getOwnerDocument​(java.util.Set xpathNodeSet)
        This method returns the first non-null owner document of the Node's 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

      • createDSctx

        public static org.w3c.dom.Element createDSctx​(org.w3c.dom.Document doc,
                                              java.lang.String prefix,
                                              java.lang.String namespace)
        Method createDSctx
        Parameters:
        doc -
        prefix -
        namespace -
        Returns:
        the element.

      • addReturnToElement

        public static void addReturnToElement​(org.w3c.dom.Element e)
        Method addReturnToElement
        Parameters:
        e -

      • convertNodelistToSet

        public static java.util.Set convertNodelistToSet​(org.w3c.dom.NodeList xpathNodeSet)
        Method convertNodelistToSet
        Parameters:
        xpathNodeSet -
        Returns:
        the set with the nodelist

      • circumventBug2650

        public static void circumventBug2650​(org.w3c.dom.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 org.w3c.dom.Element selectDsNode​(org.w3c.dom.Node sibling,
                                               java.lang.String nodeName,
                                               int number)
        Parameters:
        sibling -
        nodeName -
        number -
        Returns:
        nodes with the constrain

      • selectXencNode

        public static org.w3c.dom.Element selectXencNode​(org.w3c.dom.Node sibling,
                                                 java.lang.String nodeName,
                                                 int number)
        Parameters:
        sibling -
        nodeName -
        number -
        Returns:
        nodes with the constrain

      • selectDsNodeText

        public static org.w3c.dom.Text selectDsNodeText​(org.w3c.dom.Node sibling,
                                                java.lang.String nodeName,
                                                int number)
        Parameters:
        sibling -
        nodeName -
        number -
        Returns:
        nodes with the constrain

      • selectNodeText

        public static org.w3c.dom.Text selectNodeText​(org.w3c.dom.Node sibling,
                                              java.lang.String uri,
                                              java.lang.String nodeName,
                                              int number)
        Parameters:
        sibling -
        uri -
        nodeName -
        number -
        Returns:
        nodes with the constrain

      • selectNode

        public static org.w3c.dom.Element selectNode​(org.w3c.dom.Node sibling,
                                             java.lang.String uri,
                                             java.lang.String nodeName,
                                             int number)
        Parameters:
        sibling -
        uri -
        nodeName -
        number -
        Returns:
        nodes with the constrain

      • selectDsNodes

        public static org.w3c.dom.Element[] selectDsNodes​(org.w3c.dom.Node sibling,
                                                  java.lang.String nodeName)
        Parameters:
        sibling -
        nodeName -
        Returns:
        nodes with the constrain

      • selectNodes

        public static org.w3c.dom.Element[] selectNodes​(org.w3c.dom.Node sibling,
                                                java.lang.String uri,
                                                java.lang.String nodeName)
        Parameters:
        sibling -
        uri -
        nodeName -
        Returns:
        nodes with the constrain

      • excludeNodeFromSet

        public static java.util.Set excludeNodeFromSet​(org.w3c.dom.Node signatureElement,
                                               java.util.Set inputSet)
        Parameters:
        signatureElement -
        inputSet -
        Returns:
        nodes with the constrain

      • isDescendantOrSelf

        public static boolean isDescendantOrSelf​(org.w3c.dom.Node ctx,
                                         org.w3c.dom.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