APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.security.c14n.implementations

public abstract Class Canonicalizer20010315Excl

extends CanonicalizerBase
Class Inheritance
Known Direct Subclasses
com.sun.org.apache.xml.internal.security.c14n.implementations.Canonicalizer20010315ExclOmitComments, com.sun.org.apache.xml.internal.security.c14n.implementations.Canonicalizer20010315ExclWithComments
Imports
java.io.IOException, .OutputStream, java.util.Collections, .Map, .Set, .SortedSet, .TreeSet, com.sun.org.apache.xml.internal.security.c14n.CanonicalizationException, com.sun.org.apache.xml.internal.security.c14n.helper.C14nHelper, com.sun.org.apache.xml.internal.security.parser.XMLParserException, com.sun.org.apache.xml.internal.security.signature.XMLSignatureInput, com.sun.org.apache.xml.internal.security.transforms.params.InclusiveNamespaces, com.sun.org.apache.xml.internal.security.utils.XMLUtils, org.w3c.dom.Attr, .DOMException, .Document, .Element, .NamedNodeMap, .Node

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

Modifier and TypeField and Description
private SortedSet<String>
inclusiveNSSet

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

private boolean
Inherited from com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase:
COMPARENODE_AFTER_DOCUMENT_ELEMENTNODE_BEFORE_DOCUMENT_ELEMENTNODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENTXMLXML_LANG_URIXMLNSXMLNS_URI

Constructor Summary

AccessConstructor and Description
public
Canonicalizer20010315Excl(boolean includeComments)

Constructor Canonicalizer20010315Excl

Method Summary

Modifier and TypeMethod and Description
protected void
public void
engineCanonicalize(XMLSignatureInput rootNode, String inclusiveNamespaces, OutputStream
OutputStream to write the canonicalization result
writer
,
boolean
Whether secure validation is enabled
secureValidation
)

public void
engineCanonicalizeSubTree(Node rootNode, OutputStream
OutputStream to write the canonicalization result
writer
)

Overrides com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree Method engineCanonicalizeSubTree C14n a node tree.

public void
engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream
OutputStream to write the canonicalization result
writer
)

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree C14n a node tree.

public void
engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean
If true the default namespace will be propagated to the c14n-ized root element
propagateDefaultNamespace
,
OutputStream
OutputStream to write the canonicalization result
writer
)

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree C14n a node tree.

public void
engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, Node
A element to exclude from the c14n process.
excl
,
OutputStream
OutputStream to write the canonicalization result
writer
)

Method engineCanonicalizeSubTree

public void
engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces, OutputStream
OutputStream to write the canonicalization result
writer
)

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeXPathNodeSet.

Method engineCanonicalizeXPathNodeSet C14n a nodeset

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

Implements abstract com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributes.

Output the attributes for this node in XPathNodeSet c14n.

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

Implements abstract com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributesSubtree.

Output the attributes for this node in a Subtree c14n.

Inherited from com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase:
engineCanonicalizeengineCanonicalizeSubTreeengineCanonicalizeXPathNodeSetgetNullNodehandleParentisVisibleisVisibleDOisVisibleIntoutputAttrToWriteroutputCommentToWriteroutputPItoWriter

Field Detail

inclusiveNSSetback to summary
private SortedSet<String> inclusiveNSSet

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

propagateDefaultNamespaceback to summary
private boolean propagateDefaultNamespace

Constructor Detail

Canonicalizer20010315Exclback to summary
public Canonicalizer20010315Excl(boolean includeComments)

Constructor Canonicalizer20010315Excl

Method Detail

circumventBugIfNeededback to summary
protected void circumventBugIfNeeded(XMLSignatureInput input) throws XMLParserException, IOException

Implements abstract com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.circumventBugIfNeeded.

Annotations
@Override
engineCanonicalizeback to summary
public void engineCanonicalize(XMLSignatureInput rootNode, String inclusiveNamespaces, OutputStream writer, boolean secureValidation) throws CanonicalizationException
Parameters
writer:OutputStream

OutputStream to write the canonicalization result

secureValidation:boolean

Whether secure validation is enabled

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

Overrides com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.engineCanonicalizeSubTree.

Doc from com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree Method engineCanonicalizeSubTree C14n a node tree.

Parameters
writer:OutputStream

OutputStream to write the canonicalization result

Annotations
@Override
engineCanonicalizeSubTreeback to summary
public void engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream writer) throws CanonicalizationException

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Doc from com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree C14n a node tree.

Parameters
writer:OutputStream

OutputStream to write the canonicalization result

Annotations
@Override
engineCanonicalizeSubTreeback to summary
public void engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean propagateDefaultNamespace, OutputStream writer) throws CanonicalizationException

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Doc from com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeSubTree.

Method engineCanonicalizeSubTree C14n a node tree.

Parameters
propagateDefaultNamespace:boolean

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

writer:OutputStream

OutputStream to write the canonicalization result

Annotations
@Override
engineCanonicalizeSubTreeback to summary
public void engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, Node excl, OutputStream writer) throws CanonicalizationException

Method engineCanonicalizeSubTree

Parameters
excl:Node

A element to exclude from the c14n process.

writer:OutputStream

OutputStream to write the canonicalization result

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

Implements abstract com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeXPathNodeSet.

Doc from com.sun.org.apache.xml.internal.security.c14n.CanonicalizerSpi.engineCanonicalizeXPathNodeSet.

Method engineCanonicalizeXPathNodeSet C14n a nodeset

Parameters
writer:OutputStream

OutputStream to write the canonicalization result

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

Implements abstract com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributes.

Doc from com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributes.

Output the attributes for this node in XPathNodeSet c14n.

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

Implements abstract com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributesSubtree.

Doc from com.sun.org.apache.xml.internal.security.c14n.implementations.CanonicalizerBase.outputAttributesSubtree.

Output the attributes for this node in a Subtree c14n.

Annotations
@Override