Class Canonicalizer


  • public final class Canonicalizer
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Canonicalizer​(java.lang.String algorithmURI)
      Constructor Canonicalizer
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void canonicalize​(byte[] inputBytes, java.io.OutputStream writer, boolean secureValidation)
      This method tries to canonicalize the given bytes.
      void canonicalizeSubtree​(org.w3c.dom.Node node, java.io.OutputStream writer)
      Canonicalizes the subtree rooted by node.
      void canonicalizeSubtree​(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, boolean propagateDefaultNamespace, java.io.OutputStream writer)
      Canonicalizes the subtree rooted by node.
      void canonicalizeSubtree​(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)
      Canonicalizes the subtree rooted by node.
      void canonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.io.OutputStream writer)
      Canonicalizes an XPath node set.
      void canonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)
      Canonicalizes an XPath node set.
      static Canonicalizer getInstance​(java.lang.String algorithmURI)
      Method getInstance
      static void register​(java.lang.String algorithmURI, java.lang.Class<? extends CanonicalizerSpi> implementingClass)
      Method register
      static void register​(java.lang.String algorithmURI, java.lang.String implementingClass)
      Method register
      static void registerDefaultAlgorithms()
      This method registers the default algorithms.
      • Methods inherited from class java.lang.Object

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

      • ENCODING

        public static final java.lang.String ENCODING
        The output encoding of canonicalized data
      • XPATH_C14N_WITH_COMMENTS_SINGLE_NODE

        public static final java.lang.String XPATH_C14N_WITH_COMMENTS_SINGLE_NODE
        XPath Expression for selecting every node and continuous comments joined in only one node
        See Also:
        Constant Field Values
      • ALGO_ID_C14N_OMIT_COMMENTS

        public static final java.lang.String ALGO_ID_C14N_OMIT_COMMENTS
        The URL defined in XML-SEC Rec for inclusive c14n without comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N_WITH_COMMENTS

        public static final java.lang.String ALGO_ID_C14N_WITH_COMMENTS
        The URL defined in XML-SEC Rec for inclusive c14n with comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N_EXCL_OMIT_COMMENTS

        public static final java.lang.String ALGO_ID_C14N_EXCL_OMIT_COMMENTS
        The URL defined in XML-SEC Rec for exclusive c14n without comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N_EXCL_WITH_COMMENTS

        public static final java.lang.String ALGO_ID_C14N_EXCL_WITH_COMMENTS
        The URL defined in XML-SEC Rec for exclusive c14n with comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N11_OMIT_COMMENTS

        public static final java.lang.String ALGO_ID_C14N11_OMIT_COMMENTS
        The URI for inclusive c14n 1.1 without comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N11_WITH_COMMENTS

        public static final java.lang.String ALGO_ID_C14N11_WITH_COMMENTS
        The URI for inclusive c14n 1.1 with comments.
        See Also:
        Constant Field Values
      • ALGO_ID_C14N_PHYSICAL

        public static final java.lang.String ALGO_ID_C14N_PHYSICAL
        Non-standard algorithm to serialize the physical representation for XML Encryption
        See Also:
        Constant Field Values
      • canonicalizerHash

        private static java.util.Map<java.lang.String,​java.lang.Class<? extends CanonicalizerSpi>> canonicalizerHash
    • Method Detail

      • register

        public static void register​(java.lang.String algorithmURI,
                                    java.lang.String implementingClass)
                             throws AlgorithmAlreadyRegisteredException,
                                    java.lang.ClassNotFoundException
        Method register
        Parameters:
        algorithmURI -
        implementingClass -
        Throws:
        AlgorithmAlreadyRegisteredException
        java.lang.SecurityException - if a security manager is installed and the caller does not have permission to register the canonicalizer
        java.lang.ClassNotFoundException
      • register

        public static void register​(java.lang.String algorithmURI,
                                    java.lang.Class<? extends CanonicalizerSpi> implementingClass)
                             throws AlgorithmAlreadyRegisteredException,
                                    java.lang.ClassNotFoundException
        Method register
        Parameters:
        algorithmURI -
        implementingClass -
        Throws:
        AlgorithmAlreadyRegisteredException
        java.lang.SecurityException - if a security manager is installed and the caller does not have permission to register the canonicalizer
        java.lang.ClassNotFoundException
      • registerDefaultAlgorithms

        public static void registerDefaultAlgorithms()
        This method registers the default algorithms.
      • canonicalize

        public void canonicalize​(byte[] inputBytes,
                                 java.io.OutputStream writer,
                                 boolean secureValidation)
                          throws XMLParserException,
                                 java.io.IOException,
                                 CanonicalizationException
        This method tries to canonicalize the given bytes. It's possible to even canonicalize non-wellformed sequences if they are well-formed after being wrapped with a >a<...>/a<.
        Parameters:
        inputBytes -
        writer - OutputStream to write the canonicalization result
        secureValidation - Whether secure validation is enabled
        Throws:
        CanonicalizationException
        java.io.IOException
        XMLParserException
      • canonicalizeSubtree

        public void canonicalizeSubtree​(org.w3c.dom.Node node,
                                        java.io.OutputStream writer)
                                 throws CanonicalizationException
        Canonicalizes the subtree rooted by node.
        Parameters:
        node - The node to canonicalize
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • canonicalizeSubtree

        public void canonicalizeSubtree​(org.w3c.dom.Node node,
                                        java.lang.String inclusiveNamespaces,
                                        java.io.OutputStream writer)
                                 throws CanonicalizationException
        Canonicalizes the subtree rooted by node.
        Parameters:
        node -
        inclusiveNamespaces -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • canonicalizeSubtree

        public void canonicalizeSubtree​(org.w3c.dom.Node node,
                                        java.lang.String inclusiveNamespaces,
                                        boolean propagateDefaultNamespace,
                                        java.io.OutputStream writer)
                                 throws CanonicalizationException
        Canonicalizes the subtree rooted by node.
        Parameters:
        node -
        inclusiveNamespaces -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • canonicalizeXPathNodeSet

        public void canonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
                                             java.io.OutputStream writer)
                                      throws CanonicalizationException
        Canonicalizes an XPath node set.
        Parameters:
        xpathNodeSet -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException
      • canonicalizeXPathNodeSet

        public void canonicalizeXPathNodeSet​(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
                                             java.lang.String inclusiveNamespaces,
                                             java.io.OutputStream writer)
                                      throws CanonicalizationException
        Canonicalizes an XPath node set.
        Parameters:
        xpathNodeSet -
        inclusiveNamespaces -
        writer - OutputStream to write the canonicalization result
        Throws:
        CanonicalizationException