Package org.apache.xml.security.utils

Class XMLUtils

java.lang.Object
org.apache.xml.security.utils.XMLUtils
public class XMLUtils extends Object
DOM and XML accessibility and comfort functions.
Author:
Christian Geuer-Pollmann

  • Method Details

    • getSet

      public static void getSet(Node rootNode, Set result, Node exclude, boolean com)
      Parameters:
      rootNode -
      result -
      exclude -
      com - wheather 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 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 String getFullTextChildrenFromElement(Element element)
      Method getFullTextChildrenFromElement
      Parameters:
      element -
      Returns:
      the string of chi;ds

    • 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

    • 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

    • 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

    • 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 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 Element createDSctx(Document doc, String prefix, String namespace)
      Method createDSctx
      Parameters:
      doc -
      prefix -
      namespace -
      Returns:
      the element.

    • addReturnToElement

      public static void addReturnToElement(Element e)
      Method addReturnToElement
      Parameters:
      e -

    • convertNodelistToSet

      public static Set 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:

    • selectDsNode

      public static Element selectDsNode(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constrain

    • selectXencNode

      public static Element selectXencNode(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constrain

    • selectDsNodeText

      public static Text selectDsNodeText(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constrain

    • selectNodeText

      public static Text selectNodeText(Node sibling, String uri, String nodeName, int number)
      Parameters:
      sibling -
      uri -
      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

    • selectNodes

      public static Element[] selectNodes(Node sibling, String uri, String nodeName)
      Parameters:
      sibling -
      uri -
      nodeName -
      Returns:
      nodes with the constrain

    • excludeNodeFromSet

      public static Set excludeNodeFromSet(Node signatureElement, Set inputSet)
      Parameters:
      signatureElement -
      inputSet -
      Returns:
      nodes with the constrain

    • 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