Module org.apache.santuario.xmlsec

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

Class CanonicalizerPhysical

java.lang.Object

org.apache.xml.security.c14n.CanonicalizerSpi

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

org.apache.xml.security.c14n.implementations.CanonicalizerPhysical

public class CanonicalizerPhysical
extends CanonicalizerBase

Serializes the physical representation of the subtree. All the attributes present in the subtree are emitted. The attributes are sorted within an element, with the namespace declarations appearing before the regular attributes. This algorithm is not a true canonicalization since equivalent subtrees may produce different output. It is therefore unsuitable for digital signatures. This same property makes it ideal for XML Encryption Syntax and Processing, because the decrypted XML content will share the same physical representation as the original XML content that was encrypted.

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
CanonicalizerPhysical()	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.
void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream writer)	Always throws a CanonicalizationException.
void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces, OutputStream writer)	Always throws a CanonicalizationException.
String	engineGetURI()	Returns the URI of this engine.
protected void	handleParent(Element e, NameSpaceSymbTable ns)
protected void	outputAttributes(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)
protected void	outputAttributesSubtree(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the Attr[]s for the given element.
protected void	outputCommentToWriter(Comment currentComment, OutputStream writer, int position)	Method outputCommentToWriter
protected void	outputPItoWriter(ProcessingInstruction currentPI, OutputStream writer, int position)	Outputs a PI to the internal Writer.

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

engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, getNullNode, isVisible, isVisibleDO, isVisibleInt, outputAttrToWriter

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

engineCanonicalize

Methods inherited from class java.lang.Object

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

Constructor Detail

CanonicalizerPhysical

public CanonicalizerPhysical()

Constructor Canonicalizer20010315

Method Detail

engineCanonicalizeXPathNodeSet

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

Always throws a CanonicalizationException.

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.

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.

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

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

engineGetURI

public final String engineGetURI()

Returns the URI of this engine.

Specified by:

engineGetURI in class CanonicalizerSpi

Returns:

the URI

outputPItoWriter

protected void outputPItoWriter(ProcessingInstruction currentPI,
                                OutputStream writer,
                                int position)
                         throws IOException

Description copied from class: CanonicalizerBase

Outputs a PI to the internal Writer.

Overrides:

outputPItoWriter in class CanonicalizerBase

writer - where to write the things

Throws:

IOException

outputCommentToWriter

protected void outputCommentToWriter(Comment currentComment,
                                     OutputStream writer,
                                     int position)
                              throws IOException

Description copied from class: CanonicalizerBase

Method outputCommentToWriter

Overrides:

outputCommentToWriter in class CanonicalizerBase

writer - writer where to write the things

Throws:

IOException