Class CanonicalizerSpi

  • Direct Known Subclasses:
    CanonicalizerBase

    public abstract class CanonicalizerSpi
    extends java.lang.Object
    Base class which all Canonicalization algorithms extend.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void engineCanonicalize​(byte[] inputBytes, java.io.OutputStream writer, boolean secureValidation)
      Method canonicalize
      abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode, java.io.OutputStream writer)
      C14n a node tree.
      abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces, boolean propagateDefaultNamespace, java.io.OutputStream writer)
      C14n a node tree.
      abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)
      C14n a node tree.
      abstract void engineCanonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.io.OutputStream writer)
      C14n a nodeset
      abstract void engineCanonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)
      C14n a nodeset
      abstract java.lang.String engineGetURI()
      Returns the URI of this engine.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CanonicalizerSpi

        public CanonicalizerSpi()
    • Method Detail

      • engineCanonicalize

        public void engineCanonicalize​(byte[] inputBytes,
                                       java.io.OutputStream writer,
                                       boolean secureValidation)
                                throws XMLParserException,
                                       java.io.IOException,
                                       CanonicalizationException
        Method canonicalize
        Parameters:
        inputBytes -
        writer - OutputStream to write the canonicalization result
        secureValidation - Whether secure validation is enabled
        Throws:
        XMLParserException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException
        CanonicalizationException
      • engineGetURI

        public abstract java.lang.String engineGetURI()
        Returns the URI of this engine.
        Returns:
        the URI
      • engineCanonicalizeXPathNodeSet

        public abstract void engineCanonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
                                                            java.io.OutputStream writer)
                                                     throws CanonicalizationException
        C14n a nodeset
        Parameters:
        xpathNodeSet -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • engineCanonicalizeXPathNodeSet

        public abstract void engineCanonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
                                                            java.lang.String inclusiveNamespaces,
                                                            java.io.OutputStream writer)
                                                     throws CanonicalizationException
        C14n a nodeset
        Parameters:
        xpathNodeSet -
        inclusiveNamespaces -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • engineCanonicalizeSubTree

        public abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode,
                                                       java.io.OutputStream writer)
                                                throws CanonicalizationException
        C14n a node tree.
        Parameters:
        rootNode -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • engineCanonicalizeSubTree

        public abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode,
                                                       java.lang.String inclusiveNamespaces,
                                                       java.io.OutputStream writer)
                                                throws CanonicalizationException
        C14n a node tree.
        Parameters:
        rootNode -
        inclusiveNamespaces -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • engineCanonicalizeSubTree

        public abstract void engineCanonicalizeSubTree​(org.w3c.dom.Node rootNode,
                                                       java.lang.String inclusiveNamespaces,
                                                       boolean propagateDefaultNamespace,
                                                       java.io.OutputStream writer)
                                                throws CanonicalizationException
        C14n a node tree.
        Parameters:
        rootNode -
        inclusiveNamespaces -
        propagateDefaultNamespace - If true the default namespace will be propagated to the c14n-ized root element
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException