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 CanonicalizerBase

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

Fields inherited from class CanonicalizerSpi

reset, secureValidation

Constructor Summary

Constructors

Constructor	Description
Canonicalizer20010315Excl(boolean includeComments)	Constructor Canonicalizer20010315Excl

Method Summary

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

Methods inherited from class CanonicalizerBase

canonicalizeSubTree, canonicalizeXPathNodeSet, engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, getNullNode, getParentNameSpaces, getWriter, handleParent, isVisible, isVisibleDO, isVisibleInt, outputAttrToWriter, outputCommentToWriter, outputPItoWriter, outputTextToWriter, setWriter

Methods inherited from class CanonicalizerSpi

engineCanonicalize, engineCanonicalizeXPathNodeSet, engineCanonicalizeXPathNodeSet, engineGetIncludeComments, engineGetURI, isSecureValidation, setSecureValidation

Methods inherited from class 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 byte[] engineCanonicalizeSubTree(Node rootNode)
                                 throws CanonicalizationException

Method engineCanonicalizeSubTree Method engineCanonicalizeSubTree C14n a node tree.

Overrides:

engineCanonicalizeSubTree in class CanonicalizerBase

Parameters:

rootNode -

Returns:

the c14n bytes

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces)
                                 throws CanonicalizationException

Method engineCanonicalizeSubTree C14n a node tree.

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

Parameters:

rootNode -

inclusiveNamespaces -

Returns:

the c14n bytes

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces,
 boolean propagateDefaultNamespace)
                                 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

Returns:

the c14n bytes

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(Node rootNode,
 String inclusiveNamespaces,
 Node excl)
                                 throws CanonicalizationException

Method engineCanonicalizeSubTree

Parameters:

rootNode -

inclusiveNamespaces -

excl - A element to exclude from the c14n process.

Returns:

the rootNode c14n.

Throws:

CanonicalizationException

engineCanonicalize

public byte[] engineCanonicalize(XMLSignatureInput rootNode,
 String inclusiveNamespaces)
                          throws CanonicalizationException

Parameters:

rootNode -

inclusiveNamespaces -

Returns:

the rootNode c14n.

Throws:

CanonicalizationException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet,
 String inclusiveNamespaces)
                                      throws CanonicalizationException

Method engineCanonicalizeXPathNodeSet C14n a nodeset

Specified by:

engineCanonicalizeXPathNodeSet in class CanonicalizerSpi

Parameters:

xpathNodeSet -

inclusiveNamespaces -

Returns:

the c14n bytes

Throws:

CanonicalizationException

outputAttributesSubtree

protected void outputAttributesSubtree(Element element,
 NameSpaceSymbTable ns,
 Map<String,byte[]> cache)
                                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

Parameters:

element -

ns -

cache -

Throws:

CanonicalizationException

DOMException

IOException

outputAttributes

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

Description copied from class: CanonicalizerBase

Output the attributes for this node in XPathNodeSet c14n.

Specified by:

outputAttributes in class CanonicalizerBase

Parameters:

element -

ns -

cache -

Throws:

CanonicalizationException

DOMException

IOException

circumventBugIfNeeded

protected void circumventBugIfNeeded(XMLSignatureInput input)
                              throws CanonicalizationException,
ParserConfigurationException,
IOException,
SAXException

Specified by:

circumventBugIfNeeded in class CanonicalizerBase

Throws:

CanonicalizationException

ParserConfigurationException

IOException

SAXException