Module org.apache.santuario.xmlsec

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

Class CanonicalizerBase

java.lang.Object

org.apache.xml.security.c14n.CanonicalizerSpi

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

Direct Known Subclasses:

Canonicalizer20010315, Canonicalizer20010315Excl, CanonicalizerPhysical

public abstract class CanonicalizerBase
extends CanonicalizerSpi

Abstract base class for canonicalization algorithms. Please note that these implementations are NOT thread safe - please see the following JIRA for more information: https://issues.apache.org/jira/browse/SANTUARIO-463

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	AMP
private static final byte[]	BEGIN_COMM
private static final byte[]	BEGIN_PI
protected static final AttrCompare	COMPARE
private static final byte[]	END_COMM
private static final byte[]	END_PI
private static final byte[]	END_TAG
private static final byte[]	EQUALS_STR
private static final byte[]	GT
private boolean	includeComments
private static final byte[]	LT
protected static final int	NODE_AFTER_DOCUMENT_ELEMENT
protected static final int	NODE_BEFORE_DOCUMENT_ELEMENT
protected static final int	NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT
private List<NodeFilter>	nodeFilter
private Attr	nullNode	The null xmlns definition.
private static final byte[]	QUOT
private static final byte[]	X9
private static final byte[]	XA
private static final byte[]	XD
static final String	XML
static final String	XML_LANG_URI
static final String	XMLNS
static final String	XMLNS_URI
private Set<Node>	xpathNodeSet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CanonicalizerBase(boolean includeComments)	Constructor CanonicalizerBase

Method Summary

Modifier and Type	Method	Description
private void	canonicalizeSubTree(Node currentNode, NameSpaceSymbTable ns, Node endnode, int documentLevel, Node excludeNode, OutputStream writer)	Method canonicalizeSubTree, this function is a recursive one.
private void	canonicalizeXPathNodeSet(Node currentNode, Node endnode, OutputStream writer)	Canonicalizes all the nodes included in the currentNode and contained in the xpathNodeSet field.
(package private) abstract void	circumventBugIfNeeded(XMLSignatureInput input)
void	engineCanonicalize(XMLSignatureInput input, OutputStream writer, boolean secureValidation)	Canonicalizes a Subtree node.
void	engineCanonicalizeSubTree(Node rootNode, OutputStream writer)	Method engineCanonicalizeSubTree C14n a node tree.
protected void	engineCanonicalizeSubTree(Node rootNode, Node excludeNode, OutputStream writer)	Canonicalizes a Subtree node.
void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, OutputStream writer)	Method engineCanonicalizeXPathNodeSet C14n a nodeset
private void	engineCanonicalizeXPathNodeSetInternal(Node doc, OutputStream writer)
protected Attr	getNullNode(Document ownerDocument)
private void	getParentNameSpaces(Element el, NameSpaceSymbTable ns)	Adds to ns the definitions from the parent elements of el
protected void	handleParent(Element e, NameSpaceSymbTable ns)
protected boolean	isVisible(Node currentNode)
protected int	isVisibleDO(Node currentNode, int level)
protected int	isVisibleInt(Node currentNode)
(package private) abstract void	outputAttributes(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the attributes for this node in XPathNodeSet c14n.
(package private) abstract void	outputAttributesSubtree(Element element, NameSpaceSymbTable ns, Map<String,byte[]> cache, OutputStream writer)	Output the attributes for this node in a Subtree c14n.
protected static final void	outputAttrToWriter(String name, String value, OutputStream writer, Map<String,byte[]> cache)	Outputs an Attribute to the internal Writer.
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.
private static final void	outputTextToWriter(String text, OutputStream writer)	Outputs a Text of CDATA section to the internal Writer.

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

engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, engineGetURI

Methods inherited from class java.lang.Object

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

Field Details

XML

public static final String XML

See Also:

• Constant Field Values

XMLNS

public static final String XMLNS

See Also:

• Constant Field Values

XMLNS_URI

public static final String XMLNS_URI

See Also:

• Constant Field Values

XML_LANG_URI

public static final String XML_LANG_URI

See Also:

• Constant Field Values

COMPARE

protected static final AttrCompare COMPARE

NODE_BEFORE_DOCUMENT_ELEMENT

protected static final int NODE_BEFORE_DOCUMENT_ELEMENT

See Also:

• Constant Field Values

NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT

protected static final int NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT

See Also:

• Constant Field Values

NODE_AFTER_DOCUMENT_ELEMENT

protected static final int NODE_AFTER_DOCUMENT_ELEMENT

See Also:

• Constant Field Values

END_PI

private static final byte[] END_PI

BEGIN_PI

private static final byte[] BEGIN_PI

END_COMM

private static final byte[] END_COMM

BEGIN_COMM

private static final byte[] BEGIN_COMM

XA

private static final byte[] XA

X9

private static final byte[] X9

QUOT

private static final byte[] QUOT

XD

private static final byte[] XD

GT

private static final byte[] GT

LT

private static final byte[] LT

END_TAG

private static final byte[] END_TAG

AMP

private static final byte[] AMP

EQUALS_STR

private static final byte[] EQUALS_STR

includeComments

private boolean includeComments

nodeFilter

private List<NodeFilter> nodeFilter

xpathNodeSet

private Set<Node> xpathNodeSet

nullNode

private Attr nullNode

The null xmlns definition.

Constructor Details

CanonicalizerBase

protected CanonicalizerBase(boolean includeComments)

Constructor CanonicalizerBase

Parameters:

includeComments -

Method Details

engineCanonicalizeSubTree

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

Method engineCanonicalizeSubTree C14n a node tree.

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

Parameters:

rootNode -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeXPathNodeSet

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

Method engineCanonicalizeXPathNodeSet C14n a nodeset

Specified by:

engineCanonicalizeXPathNodeSet in class CanonicalizerSpi

Parameters:

xpathNodeSet -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalize

public void engineCanonicalize(XMLSignatureInput input,
 OutputStream writer,
 boolean secureValidation)
                        throws CanonicalizationException

Canonicalizes a Subtree node.

Parameters:

input - the root of the subtree to canicalize

writer - OutputStream to write the canonicalization result

secureValidation - Whether secure validation is enabled

Throws:

CanonicalizationException

engineCanonicalizeSubTree

protected void engineCanonicalizeSubTree(Node rootNode,
 Node excludeNode,
 OutputStream writer)
                                  throws CanonicalizationException

Canonicalizes a Subtree node.

Parameters:

rootNode - the root of the subtree to canonicalize

excludeNode - a node to be excluded from the canonicalize operation

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

canonicalizeSubTree

private void canonicalizeSubTree(Node currentNode,
 NameSpaceSymbTable ns,
 Node endnode,
 int documentLevel,
 Node excludeNode,
 OutputStream writer)
                          throws CanonicalizationException,
IOException

Method canonicalizeSubTree, this function is a recursive one.

Parameters:

currentNode -

ns -

endnode -

documentLevel -

excludeNode -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

IOException

engineCanonicalizeXPathNodeSetInternal

private void engineCanonicalizeXPathNodeSetInternal(Node doc,
 OutputStream writer)
                                             throws CanonicalizationException

Throws:

CanonicalizationException

canonicalizeXPathNodeSet

private void canonicalizeXPathNodeSet(Node currentNode,
 Node endnode,
 OutputStream writer)
                               throws CanonicalizationException,
IOException

Canonicalizes all the nodes included in the currentNode and contained in the xpathNodeSet field.

Parameters:

currentNode -

endnode -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

IOException

isVisibleDO

protected int isVisibleDO(Node currentNode,
 int level)
                   throws CanonicalizationException

Throws:

CanonicalizationException

isVisibleInt

protected int isVisibleInt(Node currentNode)
                    throws CanonicalizationException

Throws:

CanonicalizationException

isVisible

protected boolean isVisible(Node currentNode)
                     throws CanonicalizationException

Throws:

CanonicalizationException

handleParent

protected void handleParent(Element e,
 NameSpaceSymbTable ns)

getParentNameSpaces

private void getParentNameSpaces(Element el,
 NameSpaceSymbTable ns)

Adds to ns the definitions from the parent elements of el

Parameters:

el -

ns -

outputAttributes

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

Output the attributes for this node in XPathNodeSet c14n.

Parameters:

element -

ns -

cache -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

DOMException

IOException

outputAttributesSubtree

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

Output the attributes for this node in a Subtree c14n.

Parameters:

element -

ns -

cache -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

DOMException

IOException

circumventBugIfNeeded

abstract void circumventBugIfNeeded(XMLSignatureInput input)
                             throws XMLParserException,
IOException

Throws:

XMLParserException

IOException

outputAttrToWriter

protected static final void outputAttrToWriter(String name,
 String value,
 OutputStream writer,
 Map<String,byte[]> cache)
                                        throws IOException

Outputs an Attribute to the internal Writer. The string value of the node is modified by replacing

• all ampersands with &
• all open angle brackets with <
• all quotation mark characters with "
• and the whitespace characters #x9, #xA, and #xD, with character references. The character references are written in uppercase hexadecimal with no leading zeroes (for example, #xD is represented by the character reference 
)

Parameters:

name -

value -

writer -

Throws:

IOException

outputPItoWriter

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

Outputs a PI to the internal Writer.

Parameters:

currentPI -

writer - where to write the things

Throws:

IOException

outputCommentToWriter

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

Method outputCommentToWriter

Parameters:

currentComment -

writer - writer where to write the things

Throws:

IOException

outputTextToWriter

private static final void outputTextToWriter(String text,
 OutputStream writer)
                                      throws IOException

Outputs a Text of CDATA section to the internal Writer.

Parameters:

text -

writer - writer where to write the things

Throws:

IOException

getNullNode

protected Attr getNullNode(Document ownerDocument)