org.apache.axiom.c14n.impl

Class CanonicalizerBase

java.lang.Object

org.apache.axiom.c14n.CanonicalizerSpi

org.apache.axiom.c14n.impl.CanonicalizerBase

Direct Known Subclasses:

Canonicalizer20010315, Canonicalizer20010315Excl

public abstract class CanonicalizerBase
extends CanonicalizerSpi

Field Summary

Fields

Modifier and Type	Field and Description
private static byte[]	__X9_
private static byte[]	__XA_
private static byte[]	__XD_
private static byte[]	_AMP_
private static byte[]	_BEGIN_COMM
private static byte[]	_BEGIN_PI
private static byte[]	_END_COMM
private static byte[]	_END_PI
private static byte[]	_END_TAG
(package private) Node	_excludeNode The node to be skiped/excluded from the OM tree in subtree canonicalizations.
private static byte[]	_GT_
(package private) boolean	_includeComments
private static byte[]	_LT_
private static byte[]	_QUOT_
(package private) java.io.OutputStream	_writer
(package private) static AttrCompare	COMPARE
(package private) static byte[]	equalsStr
(package private) static int	NODE_AFTER_DOCUMENT_ELEMENT
(package private) static int	NODE_BEFORE_DOCUMENT_ELEMENT
(package private) static int	NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT
(package private) java.util.List	nodeFilter
protected static Attr	nullNode
(package private) static java.lang.String	XML
(package private) static java.lang.String	XMLNS

Fields inherited from class org.apache.axiom.c14n.CanonicalizerSpi

reset

Constructor Summary

Constructors

Constructor and Description
CanonicalizerBase(boolean includeComments) Constructor CanonicalizerBase

Method Summary

Modifier and Type	Method and Description
(package private) void	canonicalizeSubTree(Node currentNode, NameSpaceSymbTable ns, Node endnode, int documentLevel) Method canonicalizeSubTree, this function is a recursive one.
byte[]	engineCanonicalizeSubTree(Node rootNode) Method engineCanonicalizeSubTree
(package private) byte[]	engineCanonicalizeSubTree(Node rootNode, Node excludeNode) Canonicalizes a Subtree node.
(package private) void	getParentNameSpaces(Element el, NameSpaceSymbTable ns) Adds to ns the definitons from the parent elements of el
(package private) abstract java.util.Iterator	handleAttributesSubtree(Element E, NameSpaceSymbTable ns)
(package private) void	handleParent(Element e, NameSpaceSymbTable ns)
(package private) static void	outputAttrToWriter(java.lang.String name, java.lang.String value, java.io.OutputStream writer, java.util.Map cache) Outputs an Attribute to the internal Writer.
(package private) static void	outputCommentToWriter(Comment currentComment, java.io.OutputStream writer, int position) Method outputCommentToWriter
(package private) static void	outputPItoWriter(ProcessingInstruction currentPI, java.io.OutputStream writer, int position) Outputs a PI to the internal Writer.
(package private) static void	outputTextToWriter(java.lang.String text, java.io.OutputStream writer) Outputs a Text of CDATA section to the internal Writer.
void	setWriter(java.io.OutputStream _writer) Method setWriter

Methods inherited from class org.apache.axiom.c14n.CanonicalizerSpi

engineCanonicalize, engineCanonicalizeSubTree, engineGetIncludeComments, engineGetURI

Methods inherited from class java.lang.Object

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

Field Detail

_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_

COMPARE

static final AttrCompare COMPARE

XML

static final java.lang.String XML

See Also:

Constant Field Values

XMLNS

static final java.lang.String XMLNS

See Also:

Constant Field Values

equalsStr

static final byte[] equalsStr

NODE_BEFORE_DOCUMENT_ELEMENT

static final int NODE_BEFORE_DOCUMENT_ELEMENT

See Also:

Constant Field Values

NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT

static final int NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT

See Also:

Constant Field Values

NODE_AFTER_DOCUMENT_ELEMENT

static final int NODE_AFTER_DOCUMENT_ELEMENT

See Also:

Constant Field Values

nullNode

protected static final Attr nullNode

nodeFilter

java.util.List nodeFilter

_includeComments

boolean _includeComments

_excludeNode

Node _excludeNode

The node to be skiped/excluded from the OM tree in subtree canonicalizations.

_writer

java.io.OutputStream _writer

Constructor Detail

CanonicalizerBase

public CanonicalizerBase(boolean includeComments)

Constructor CanonicalizerBase

Parameters:

includeComments -

Method Detail

engineCanonicalizeSubTree

public byte[] engineCanonicalizeSubTree(Node rootNode)
                                 throws CanonicalizationException

Method engineCanonicalizeSubTree

Specified by:

engineCanonicalizeSubTree in class CanonicalizerSpi

Parameters:

rootNode -

Throws:

CanonicalizationException

setWriter

public void setWriter(java.io.OutputStream _writer)

Description copied from class: CanonicalizerSpi

Method setWriter

Specified by:

setWriter in class CanonicalizerSpi

Parameters:

_writer - The _writer to set.

engineCanonicalizeSubTree

byte[] engineCanonicalizeSubTree(Node rootNode,
                                 Node excludeNode)
                          throws CanonicalizationException

Canonicalizes a Subtree node.

Parameters:

rootNode - the root of the subtree to canicalize

excludeNode - a node to be excluded from the canonicalize operation

Returns:

The canonicalize stream.

Throws:

CanonicalizationException

canonicalizeSubTree

final void canonicalizeSubTree(Node currentNode,
                               NameSpaceSymbTable ns,
                               Node endnode,
                               int documentLevel)
                        throws CanonicalizationException,
                               java.io.IOException

Method canonicalizeSubTree, this function is a recursive one.

Parameters:

currentNode -

ns -

endnode -

Throws:

CanonicalizationException

java.io.IOException

handleParent

void handleParent(Element e,
                  NameSpaceSymbTable ns)

getParentNameSpaces

final void getParentNameSpaces(Element el,
                               NameSpaceSymbTable ns)

Adds to ns the definitons from the parent elements of el

Parameters:

el -

ns -

handleAttributesSubtree

abstract java.util.Iterator handleAttributesSubtree(Element E,
                                                    NameSpaceSymbTable ns)
                                             throws CanonicalizationException

Throws:

CanonicalizationException

outputAttrToWriter

static final void outputAttrToWriter(java.lang.String name,
                                     java.lang.String value,
                                     java.io.OutputStream writer,
                                     java.util.Map cache)
                              throws java.io.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:

java.io.IOException

outputPItoWriter

static final void outputPItoWriter(ProcessingInstruction currentPI,
                                   java.io.OutputStream writer,
                                   int position)
                            throws java.io.IOException

Outputs a PI to the internal Writer.

Parameters:

currentPI -

writer - where to write the things

Throws:

java.io.IOException

outputCommentToWriter

static final void outputCommentToWriter(Comment currentComment,
                                        java.io.OutputStream writer,
                                        int position)
                                 throws java.io.IOException

Method outputCommentToWriter

Parameters:

currentComment -

writer - writer where to write the things

Throws:

java.io.IOException

outputTextToWriter

static final void outputTextToWriter(java.lang.String text,
                                     java.io.OutputStream writer)
                              throws java.io.IOException

Outputs a Text of CDATA section to the internal Writer.

Parameters:

text -

writer - writer where to write the things

Throws:

java.io.IOException