Module org.apache.santuario.xmlsec

Package org.apache.xml.security.c14n.implementations

Class Canonicalizer20010315Excl

java.lang.Object

org.apache.xml.security.c14n.CanonicalizerSpi

org.apache.xml.security.c14n.implementations.CanonicalizerBase

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

Direct Known Subclasses:

Canonicalizer20010315ExclOmitComments, Canonicalizer20010315ExclWithComments

public abstract class Canonicalizer20010315Excl
extends CanonicalizerBase

Implements " Exclusive XML Canonicalization, Version 1.0 "

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.

See Also:

• Exclusive XML Canonicalization, Version 1.0

Field Summary

Fields

Modifier and Type	Field	Description
private SortedSet<String>	inclusiveNSSet	This Set contains the names (Strings like "xmlns" or "xmlns:foo") of the inclusive namespaces.
private boolean	propagateDefaultNamespace

Fields inherited from class org.apache.xml.security.c14n.implementations.CanonicalizerBase

COMPARE, NODE_AFTER_DOCUMENT_ELEMENT, NODE_BEFORE_DOCUMENT_ELEMENT, NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT, XML, XML_LANG_URI, XMLNS, XMLNS_URI

Constructor Summary

Constructors

Constructor	Description
Canonicalizer20010315Excl(boolean includeComments)	Constructor Canonicalizer20010315Excl

Method Summary

Modifier and Type	Method	Description
protected void	circumventBugIfNeeded(XMLSignatureInput input)
void	engineCanonicalize(XMLSignatureInput rootNode, String inclusiveNamespaces, OutputStream writer, boolean secureValidation)
void	engineCanonicalizeSubTree(Node rootNode, OutputStream writer)	Method engineCanonicalizeSubTree Method engineCanonicalizeSubTree C14n a node tree.
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean propagateDefaultNamespace, OutputStream writer)	Method engineCanonicalizeSubTree C14n a node tree.
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream writer)	Method engineCanonicalizeSubTree C14n a node tree.
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, Node excl, OutputStream writer)	Method engineCanonicalizeSubTree
void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces, OutputStream writer)	Method engineCanonicalizeXPathNodeSet C14n a nodeset
protected void	outputAttributes(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the attributes for this node in XPathNodeSet c14n.
protected void	outputAttributesSubtree(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the attributes for this node in a Subtree c14n.

Methods inherited from class org.apache.xml.security.c14n.implementations.CanonicalizerBase

engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, getNullNode, handleParent, isVisible, isVisibleDO, isVisibleInt, outputAttrToWriter, outputCommentToWriter, outputPItoWriter

Methods inherited from class org.apache.xml.security.c14n.CanonicalizerSpi

engineCanonicalize, engineGetURI

Methods inherited from class java.lang.Object

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

Field Details

inclusiveNSSet

private SortedSet<String> inclusiveNSSet

This Set contains the names (Strings like "xmlns" or "xmlns:foo") of the inclusive namespaces.

propagateDefaultNamespace

private boolean propagateDefaultNamespace

Constructor Details

Canonicalizer20010315Excl

public Canonicalizer20010315Excl(boolean includeComments)

Constructor Canonicalizer20010315Excl

Parameters:

includeComments -

Method Details

engineCanonicalizeSubTree

public void engineCanonicalizeSubTree(Node rootNode,
 OutputStream writer)
                               throws CanonicalizationException

Method engineCanonicalizeSubTree Method engineCanonicalizeSubTree C14n a node tree.

Overrides:

engineCanonicalizeSubTree in class CanonicalizerBase

Parameters:

rootNode -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public void engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces,
 OutputStream writer)
                               throws CanonicalizationException

Method engineCanonicalizeSubTree C14n a node tree.

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

Parameters:

rootNode -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public void engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces,
 boolean propagateDefaultNamespace,
 OutputStream writer)
                               throws CanonicalizationException

Method engineCanonicalizeSubTree C14n a node tree.

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

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

engineCanonicalizeSubTree

public void engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces,
 Node excl,
 OutputStream writer)
                               throws CanonicalizationException

Method engineCanonicalizeSubTree

Parameters:

rootNode -

inclusiveNamespaces -

excl - A element to exclude from the c14n process.

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalize

public void engineCanonicalize(XMLSignatureInput rootNode,
 String inclusiveNamespaces,
 OutputStream writer,
 boolean secureValidation)
                        throws CanonicalizationException

Parameters:

rootNode -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

secureValidation - Whether secure validation is enabled

Throws:

CanonicalizationException

engineCanonicalizeXPathNodeSet

public void engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet,
 String inclusiveNamespaces,
 OutputStream writer)
                                    throws CanonicalizationException

Method engineCanonicalizeXPathNodeSet C14n a nodeset

Specified by:

engineCanonicalizeXPathNodeSet in class CanonicalizerSpi

Parameters:

xpathNodeSet -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

outputAttributesSubtree

protected void outputAttributesSubtree(Element element,
 NameSpaceSymbTable ns,
 Map<String,byte[]> cache,
 OutputStream writer)
                                throws CanonicalizationException,
DOMException,
IOException

Description copied from class: CanonicalizerBase

Output the attributes for this node in a Subtree c14n.

Specified by:

outputAttributesSubtree in class CanonicalizerBase

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

DOMException

IOException

outputAttributes

protected void outputAttributes(Element element,
 NameSpaceSymbTable ns,
 Map<String,byte[]> cache,
 OutputStream writer)
                         throws CanonicalizationException,
DOMException,
IOException

Description copied from class: CanonicalizerBase

Output the attributes for this node in XPathNodeSet c14n.

Specified by:

outputAttributes in class CanonicalizerBase

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

DOMException

IOException

circumventBugIfNeeded

protected void circumventBugIfNeeded(XMLSignatureInput input)
                              throws XMLParserException,
IOException

Specified by:

circumventBugIfNeeded in class CanonicalizerBase

Throws:

XMLParserException

IOException