org.apache.xml.security.c14n.implementations
Class Canonicalizer20010315Excl

java.lang.Object
  |
  +--org.apache.xml.security.c14n.CanonicalizerSpi
        |
        +--org.apache.xml.security.c14n.implementations.Canonicalizer20010315Excl
Direct Known Subclasses:
Canonicalizer20010315ExclOmitComments, Canonicalizer20010315ExclWithComments

public abstract class Canonicalizer20010315Excl
extends CanonicalizerSpi

Implements "Exclusive XML Canonicalization, Version 1.0", Rev 1.58.
Credits: During restructuring of the Canonicalizer framework, René Kollmorgen from Software AG submitted an implementation of ExclC14n which fitted into the old architecture and which based heavily on my old (and slow) implementation of "Canonical XML". A big "thank you" to René for this.
THIS implementation is a complete rewrite of the algorithm.

Version:
$Revision: 1.5 $
Author:
$Author: geuerp $
See Also:
"Exclusive XML Canonicalization, Version 1.0", Rev 1.58.

Constructor Summary
Canonicalizer20010315Excl(boolean includeComments)
          Constructor Canonicalizer20010315Excl
 
Method Summary
 byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode)
          Method engineCanonicalizeSubTree
 byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces)
          Method engineCanonicalizeSubTree
 byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet)
          Method engineCanonicalizeXPathNodeSet
 byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet, java.lang.String inclusiveNamespaces)
          Method engineCanonicalizeXPathNodeSet
 boolean utilizedOrIncluded(org.w3c.dom.Element element, java.lang.String namespace)
          Returns true is the namespace is either utilized by the given element or included by the includedNamespaces parameter.
 java.util.Set visiblyUtilized(org.w3c.dom.Element element)
          Method visiblyUtilized
 
Methods inherited from class org.apache.xml.security.c14n.CanonicalizerSpi
engineCanonicalize, engineCanonicalizeXPathNodeSet, engineCanonicalizeXPathNodeSet, engineGetIncludeComments, engineGetURI
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Canonicalizer20010315Excl

public Canonicalizer20010315Excl(boolean includeComments)
Constructor Canonicalizer20010315Excl

Parameters:
includeComments -
Method Detail

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode)
                                 throws CanonicalizationException
Method engineCanonicalizeSubTree

Specified by:
engineCanonicalizeSubTree in class CanonicalizerSpi
Parameters:
rootNode -
Returns:
Throws:
CanonicalizationException

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode,
                                        java.lang.String inclusiveNamespaces)
                                 throws CanonicalizationException
Method engineCanonicalizeSubTree

Specified by:
engineCanonicalizeSubTree in class CanonicalizerSpi
Parameters:
rootNode -
inclusiveNamespaces -
Returns:
Throws:
CanonicalizationException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet)
                                      throws CanonicalizationException
Method engineCanonicalizeXPathNodeSet

Specified by:
engineCanonicalizeXPathNodeSet in class CanonicalizerSpi
Parameters:
xpathNodeSet -
Returns:
Throws:
CanonicalizationException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet,
                                             java.lang.String inclusiveNamespaces)
                                      throws CanonicalizationException
Method engineCanonicalizeXPathNodeSet

Specified by:
engineCanonicalizeXPathNodeSet in class CanonicalizerSpi
Parameters:
xpathNodeSet -
inclusiveNamespaces -
Returns:
Throws:
CanonicalizationException

utilizedOrIncluded

public boolean utilizedOrIncluded(org.w3c.dom.Element element,
                                  java.lang.String namespace)
Returns true is the namespace is either utilized by the given element or included by the includedNamespaces parameter.

Parameters:
element -
namespace -
Returns:

visiblyUtilized

public java.util.Set visiblyUtilized(org.w3c.dom.Element element)
Method visiblyUtilized

Parameters:
element -
Returns: