Module org.apache.santuario.xmlsec

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

Class Canonicalizer20010315

java.lang.Object

org.apache.xml.security.c14n.CanonicalizerSpi

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

org.apache.xml.security.c14n.implementations.Canonicalizer20010315

Direct Known Subclasses:

Canonicalizer11_OmitComments, Canonicalizer11_WithComments, Canonicalizer20010315OmitComments, Canonicalizer20010315WithComments

public abstract class Canonicalizer20010315
extends CanonicalizerBase

Implements Canonical XML Version 1.0, a W3C Recommendation from 15 March 2001.

Field Summary

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
Canonicalizer20010315(boolean includeComments)	Constructor Canonicalizer20010315
Canonicalizer20010315(boolean includeComments, boolean c14n11)	Constructor Canonicalizer20010315

Method Summary

Modifier and Type	Method	Description
protected void	circumventBugIfNeeded(XMLSignatureInput input)
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean propagateDefaultNamespace, OutputStream writer)	Always throws a CanonicalizationException because this is inclusive c14n.
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream writer)	Always throws a CanonicalizationException because this is inclusive c14n.
void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces, OutputStream writer)	Always throws a CanonicalizationException because this is inclusive c14n.
protected void	handleParent(Element e, NameSpaceSymbTable ns)
protected void	outputAttributes(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the Attr[]s for the given element.
protected void	outputAttributesSubtree(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the Attr[]s for the given element.

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

engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, getNullNode, 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

Constructor Detail

Canonicalizer20010315

public Canonicalizer20010315(boolean includeComments)

Constructor Canonicalizer20010315

Parameters:

includeComments -

Canonicalizer20010315

public Canonicalizer20010315(boolean includeComments,
                             boolean c14n11)

Constructor Canonicalizer20010315

Parameters:

includeComments -

c14n11 - Whether this is a Canonical XML 1.1 implementation or not

Method Detail

engineCanonicalizeXPathNodeSet

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

Always throws a CanonicalizationException because this is inclusive c14n.

Specified by:

engineCanonicalizeXPathNodeSet in class CanonicalizerSpi

Parameters:

xpathNodeSet -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException - always

engineCanonicalizeSubTree

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

Always throws a CanonicalizationException because this is inclusive c14n.

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

Always throws a CanonicalizationException because this is inclusive c14n.

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

Parameters:

rootNode -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

propagateDefaultNamespace - If true the default namespace will be propagated to the c14n-ized root element

Throws:

CanonicalizationException

outputAttributesSubtree

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

Output the Attr[]s for the given element.
The code of this method is a copy of outputAttributes(Element, NameSpaceSymbTable, Map, OutputStream), whereas it takes into account that subtree-c14n is -- well -- subtree-based. So if the element in question isRoot of c14n, it's parent is not in the node set, as well as all other ancestors.

Parameters:

element -

ns -

cache -

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

Output the Attr[]s for the given element.
IMPORTANT: This method expects to work on a modified DOM tree, i.e. a DOM which has been prepared using XMLUtils.circumventBug2650( org.w3c.dom.Document).

Parameters:

element -

ns -

cache -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

DOMException

IOException

circumventBugIfNeeded

protected void circumventBugIfNeeded(XMLSignatureInput input)
                              throws org.apache.xml.security.parser.XMLParserException,
                                     IOException

Throws:

org.apache.xml.security.parser.XMLParserException

IOException

handleParent

protected void handleParent(Element e,
                            NameSpaceSymbTable ns)

Overrides:

handleParent in class CanonicalizerBase