iaik.ixsil.util

Class CanonicalXMLSerializerImpl

java.lang.Object

iaik.ixsil.util.CanonicalXMLSerializerImpl

All Implemented Interfaces:

CanonicalXMLSerializerInterface, ExclusiveCanonicalXMLSerializerInterface

public class CanonicalXMLSerializerImpl
extends java.lang.Object
implements CanonicalXMLSerializerInterface, ExclusiveCanonicalXMLSerializerInterface

This class implements the interfaces CanonicalXMLSerializerInterface and ExclusiveCanonicalXMLSerializerInterface. See there for further information. IMPORTANT NOTE: The algorithms implemented by this class only works correct if namespace attributes are explicitely declared for all element they should be in scope for. This precondition is necessary due to a difference in the tree model of XPath and DOM.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CanonicalXMLSerializerImpl.AttributeComparator Implements the Comparator interface for DOM attributes.
protected class	CanonicalXMLSerializerImpl.NSAttributeComparator Implements the Comparator interface for DOM namespace attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	AFTER_DOC_ELEMENT_ Constant indicating that the document element has already been processed.
protected org.w3c.dom.traversal.NodeIterator	allNodesIterator_ A node iterator for the underlying DOM document.
protected org.w3c.dom.NodeList	allOutputNodesList_ All nodes to be canonicalized as a NodeList.
protected java.util.HashMap	allOutputNodesMap_ All nodes to be canonicalized as a HashMap.
protected static int	BEFORE_DOC_ELEMENT_ Constant indicating that the document element has not been processed.
static int	C14N_ Constant indicating that the output has to be canonical XML.
protected int	canonMode_ Indicates wheter the output has to be canonical XML or exclusive canonical XML.
static java.lang.String	EXC_C14N_DEFAULT_NS_PREFIX_ The string used to indicate the default namespace, according to section 4 of Exclusive XML Canonicalization Version 1.0.
static int	EXCLUSIVE_C14N_ Constant indicating that the output has to be exclusive canonical XML.
protected static int	IN_DOC_ELEMENT_ Constant indicating that the document element is currently being processed.
protected java.util.HashMap	inclusiveNamespacePrefixMap_ In case that Exclusive Canonical XML should be serialized, this member contains a list of all namespace prefixes that should be treated as described in Canonical XML.
protected java.util.Map	namespaceAndXMLAxes_ Contains in scope namespace attributes and xml:foo attributes for each element of the underlying DOM document (see @link #computeNamespaceAndXMLAxes}.
protected boolean	omitComments_ Indicates wheter to filter comment nodes or not.
protected int	processingPosition_ Indicates processing position during serialization (see {link BEFORE_DOC_ELEMENT_}, IN_DOC_ELEMENT_ and AFTER_DOC_ELEMENT_).
protected java.io.CharArrayWriter	serializationResultSink_ Sink for serialization result.

Fields inherited from interface iaik.ixsil.util.CanonicalXMLSerializerInterface

FACTORY_METHOD_NAME_, INITPROPERTY_IMPL_CLASSNAME_

Fields inherited from interface iaik.ixsil.util.ExclusiveCanonicalXMLSerializerInterface

FACTORY_METHOD_NAME_, INITPROPERTY_IMPL_CLASSNAME_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CanonicalXMLSerializerImpl(org.w3c.dom.NodeList allOutputNodesList, int canonMode, boolean omitComments, java.lang.String inclusiveNamespacePrefixes) Standard constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForRelativeNamespaceURIs() Report an error if there is any namespace attribute in the list of output nodes having a relative URI as its value.
protected java.util.Map	computeNamespaceAndXMLAxes(org.w3c.dom.Document document) Computes two sets for each element node of the specified DOM document: One contains all namespace attributes that are in scope for the element, the other one contains all xml attributes (such as xml:space), that are in scope for the element.
static CanonicalXMLSerializerInterface	getCanonicalXMLSerializer(org.w3c.dom.NodeList allOutputNodesList, boolean omitComments) Gets an implementation instance of interface CanonicalXMLSerializerInterface.
static ExclusiveCanonicalXMLSerializerInterface	getExclusiveCanonicalXMLSerializer(org.w3c.dom.NodeList allOutputNodesList, java.lang.String inclusiveNamespacePrefixes, boolean omitComments) Gets an implementation instance of interface ExclusiveCanonicalXMLSerializerInterface.
protected java.util.Vector	getOutputAncestors(org.w3c.dom.Element candidate) Gets all output ancestors of an element node.
protected java.util.SortedSet	getOutputAttrs(org.w3c.dom.Element element) Gets the list of all attributes to be serialized for the specified element node.
protected java.util.SortedSet	getOutputNSAttrs(org.w3c.dom.Element element) Gets the list of all namespace attributes to be serialized for the specified element node.
protected org.w3c.dom.Element	getOutputParent(org.w3c.dom.Element candidate) Gets the output parent of an element node.
protected boolean	isDocumentElement(org.w3c.dom.Element candidate) Tests if an element node is the document element.
protected boolean	isNSAttribute(org.w3c.dom.Attr candidate) Tests wheter an attribute node is a namespace node.
protected boolean	isOrphan(org.w3c.dom.Element candidate) Tests wheter an element node is orphan or not.
protected boolean	isVisiblyUtilized(java.lang.String prefix, org.w3c.dom.Element element) Tests if a namespace prefix is visibly utilized by an element.
protected boolean	isXMLAttribute(org.w3c.dom.Attr candidate) Tests wheter an attribute node is an xml:foo attribute node.
java.io.InputStream	serialize() Serializes all Node objects contained by {link #allOutputNodesList_}, according to the rules of Canonical XML Version 1.0 or Exclusive XML Canonicalization Version 1.0 .
protected void	serialize(org.w3c.dom.Node parent) Serializes the all children of parent which are in the output node list.
protected void	serializeAttribute(org.w3c.dom.Attr attr) Serializes the specified DOM Attr node.
protected void	serializeComment(org.w3c.dom.Comment comment) Serializes the specified DOM Comment node.
protected void	serializeElement(org.w3c.dom.Element element) Serializes the specified DOM element if it is in the list of output nodes.
protected void	serializeProcessingInstruction(org.w3c.dom.ProcessingInstruction pi) Serializes the specified DOM ProcessingInstruction node.
protected void	serializeText(org.w3c.dom.Node text) Serializes the specified DOM Text node.

Methods inherited from class java.lang.Object

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

Field Detail

BEFORE_DOC_ELEMENT_

protected static final int BEFORE_DOC_ELEMENT_

Constant indicating that the document element has not been processed.

See Also:

Constant Field Values

IN_DOC_ELEMENT_

protected static final int IN_DOC_ELEMENT_

Constant indicating that the document element is currently being processed.

See Also:

Constant Field Values

AFTER_DOC_ELEMENT_

protected static final int AFTER_DOC_ELEMENT_

Constant indicating that the document element has already been processed.

See Also:

Constant Field Values

C14N_

public static final int C14N_

Constant indicating that the output has to be canonical XML.

See Also:

Constant Field Values

EXCLUSIVE_C14N_

public static final int EXCLUSIVE_C14N_

Constant indicating that the output has to be exclusive canonical XML.

See Also:

Constant Field Values

EXC_C14N_DEFAULT_NS_PREFIX_

public static final java.lang.String EXC_C14N_DEFAULT_NS_PREFIX_

The string used to indicate the default namespace, according to section 4 of Exclusive XML Canonicalization Version 1.0.

See Also:

Constant Field Values

canonMode_

protected int canonMode_

Indicates wheter the output has to be canonical XML or exclusive canonical XML.

omitComments_

protected boolean omitComments_

Indicates wheter to filter comment nodes or not.

allOutputNodesList_

protected org.w3c.dom.NodeList allOutputNodesList_

All nodes to be canonicalized as a NodeList.

allOutputNodesMap_

protected java.util.HashMap allOutputNodesMap_

All nodes to be canonicalized as a HashMap.

allNodesIterator_

protected org.w3c.dom.traversal.NodeIterator allNodesIterator_

A node iterator for the underlying DOM document.

namespaceAndXMLAxes_

protected java.util.Map namespaceAndXMLAxes_

Contains in scope namespace attributes and xml:foo attributes for each element of the underlying DOM document (see @link #computeNamespaceAndXMLAxes}.

processingPosition_

protected int processingPosition_

Indicates processing position during serialization (see {link BEFORE_DOC_ELEMENT_}, IN_DOC_ELEMENT_ and AFTER_DOC_ELEMENT_).

serializationResultSink_

protected java.io.CharArrayWriter serializationResultSink_

Sink for serialization result.

inclusiveNamespacePrefixMap_

protected java.util.HashMap inclusiveNamespacePrefixMap_

In case that Exclusive Canonical XML should be serialized, this member contains a list of all namespace prefixes that should be treated as described in Canonical XML.

Constructor Detail

CanonicalXMLSerializerImpl

protected CanonicalXMLSerializerImpl(org.w3c.dom.NodeList allOutputNodesList,
                          int canonMode,
                          boolean omitComments,
                          java.lang.String inclusiveNamespacePrefixes)

Standard constructor.

Parameters:

allOutputNodesList - A list containg objects of type Node, which are to be serialized. May equal null. The following node types are allowed:

• Document
• Element
• Attr
• Text
• Comment
• ProcessingInstruction

canonMode - Indicates wheter the output has to be canonical XML or exclusive canonical XML (see C14N_ and EXCLUSIVE_C14N_.

inclusiveNamespacePrefixes - Contains the list of namespace prefixes to be treated as described in Canonical XML. If canonMode equals C14N_ , this parameter must be null. Otherwise it contains a whitespace seperated list of namespace prefixes. May be null or an emtpy string.

omitComments - Indicates wheter to filter comment nodes or not.

Method Detail

serialize

public java.io.InputStream serialize()
                              throws CanonicalXMLSerializerException

Serializes all Node objects contained by {link #allOutputNodesList_}, according to the rules of Canonical XML Version 1.0 or Exclusive XML Canonicalization Version 1.0 .

Specified by:

serialize in interface CanonicalXMLSerializerInterface

Specified by:

serialize in interface ExclusiveCanonicalXMLSerializerInterface

Returns:

the serialization result as an octet stream. If {link #allOutputNodesList_} equals null , or if it contains no nodes, an empty octet stream will be returned.

Throws:

CanonicalXMLSerializerException - if there exists a namespace attribute node in the node list, whose value is a relative URI. Relative namespace URIs are not allowed according to Canonical XML.

getCanonicalXMLSerializer

public static CanonicalXMLSerializerInterface getCanonicalXMLSerializer(org.w3c.dom.NodeList allOutputNodesList,
                                                        boolean omitComments)

Gets an implementation instance of interface CanonicalXMLSerializerInterface. See there for further documentation.

Parameters:

allOutputNodesList - See CanonicalXMLSerializerInterface.

omitComments - See CanonicalXMLSerializerInterface.

Returns:

an implementation instance of interface CanonicalXMLSerializerInterface.

getExclusiveCanonicalXMLSerializer

public static ExclusiveCanonicalXMLSerializerInterface getExclusiveCanonicalXMLSerializer(org.w3c.dom.NodeList allOutputNodesList,
                                                                          java.lang.String inclusiveNamespacePrefixes,
                                                                          boolean omitComments)

Gets an implementation instance of interface ExclusiveCanonicalXMLSerializerInterface. See there for further documentation.

Parameters:

allOutputNodesList - See CanonicalXMLSerializerInterface.

inclusiveNamespacePrefixes - See CanonicalXMLSerializerInterface.

omitComments - See CanonicalXMLSerializerInterface.

Returns:

an implementation instance of interface ExclusiveCanonicalXMLSerializerInterface.

serialize

protected void serialize(org.w3c.dom.Node parent)

Serializes the all children of parent which are in the output node list.

Parameters:

parent - The parent DOM node, which children are to be serialized. If parent equals null, all nodes in the output node list will be serialized.

serializeElement

protected void serializeElement(org.w3c.dom.Element element)
                         throws java.io.IOException

Serializes the specified DOM element if it is in the list of output nodes. Also all children of the DOM element are serialized in this manner recursively.

Parameters:

element - The DOM element to be serialized if it is in the list of output nodes.

Throws:

java.io.IOException - if writing to the serialization result sink fails.

serializeAttribute

protected void serializeAttribute(org.w3c.dom.Attr attr)
                           throws java.io.IOException

Serializes the specified DOM Attr node.

Parameters:

attr - The DOM Attr node to be serialized.

Throws:

java.io.IOException - if writing to the serialization result sink fails.

serializeText

protected void serializeText(org.w3c.dom.Node text)
                      throws java.io.IOException

Serializes the specified DOM Text node.

Parameters:

text - The DOM Text node to be serialized.

Throws:

java.io.IOException - if writing to the serialization result sink fails.

serializeProcessingInstruction

protected void serializeProcessingInstruction(org.w3c.dom.ProcessingInstruction pi)
                                       throws java.io.IOException

Serializes the specified DOM ProcessingInstruction node.

Parameters:

pi - The DOM ProcessingInstruction node to be serialized.

Throws:

java.io.IOException - if writing to the serialization result sink fails.

serializeComment

protected void serializeComment(org.w3c.dom.Comment comment)
                         throws java.io.IOException

Serializes the specified DOM Comment node.

Parameters:

comment - The DOM Comment node to be serialized.

Throws:

java.io.IOException - if writing to the serialization result sink fails.

getOutputAttrs

protected java.util.SortedSet getOutputAttrs(org.w3c.dom.Element element)

Gets the list of all attributes to be serialized for the specified element node.

Parameters:

element - The owner of the requested attributes.

Returns:

the list of all attributes to be serialized for the specified element node.

getOutputNSAttrs

protected java.util.SortedSet getOutputNSAttrs(org.w3c.dom.Element element)

Gets the list of all namespace attributes to be serialized for the specified element node.

Parameters:

element - The owner of the requested namespace attributes.

Returns:

the list of all namespace attributes to be serialized for the specified element node.

computeNamespaceAndXMLAxes

protected java.util.Map computeNamespaceAndXMLAxes(org.w3c.dom.Document document)

Computes two sets for each element node of the specified DOM document: One contains all namespace attributes that are in scope for the element, the other one contains all xml attributes (such as xml:space), that are in scope for the element.

Parameters:

document - The DOM document for whose elements the sets should be computed.

Returns:

a Map containing an entry for each element of the DOM document. The key is the element itself, while the value is a Vector of size 2. The first position of the Vector contains a HashMap with all namespace attributes that are in scope for the key element, the second position contains a HashMap with all XML attributes that are in scope for the key element. The keys for those two HashMaps are the attribute names, the values are the attribute nodes.

isNSAttribute

protected boolean isNSAttribute(org.w3c.dom.Attr candidate)

Tests wheter an attribute node is a namespace node.

Parameters:

candidate - The attribute node to be tested.

Returns:

true if candidate is a namespace node, false otherwise.

isXMLAttribute

protected boolean isXMLAttribute(org.w3c.dom.Attr candidate)

Tests wheter an attribute node is an xml:foo attribute node.

Parameters:

candidate - The attribute node to be tested.

Returns:

true if candidate is an xml:foo attribute node, false otherwise.

isOrphan

protected boolean isOrphan(org.w3c.dom.Element candidate)

Tests wheter an element node is orphan or not. An element node is orphan, if its parent element is not in the output node list. A document element is always non-orphan.

Parameters:

candidate - The element node to be tested.

Returns:

true if candidate is orphan, false otherwise.

getOutputParent

protected org.w3c.dom.Element getOutputParent(org.w3c.dom.Element candidate)

Gets the output parent of an element node. The output parent of an element node is the nearest ancestor element that is in the output node list. The document element has never an output parent.

Parameters:

candidate - The element node to be investigated.

Returns:

the output parent, or null if candiate has no output parent.

getOutputAncestors

protected java.util.Vector getOutputAncestors(org.w3c.dom.Element candidate)

Gets all output ancestors of an element node.

Parameters:

candidate - The element node to be investigated.

Returns:

a Vector of all output ancestors of the element node. The first element of the Vector is the nearest ancestor. The Vector will be empty, if there are no output ancestors.

isVisiblyUtilized

protected boolean isVisiblyUtilized(java.lang.String prefix,
                        org.w3c.dom.Element element)

Tests if a namespace prefix is visibly utilized by an element.

Parameters:

prefix - The prefix to be tested.

element - The element to be tested.

Returns:

true, if the element visibly utilizes the prefix, false otherwise.

isDocumentElement

protected boolean isDocumentElement(org.w3c.dom.Element candidate)

Tests if an element node is the document element.

Parameters:

candidate - The element node to be tested.

Returns:

true if candidate is the document element, false otherwise.

checkForRelativeNamespaceURIs

protected void checkForRelativeNamespaceURIs()
                                      throws CanonicalXMLSerializerException

Report an error if there is any namespace attribute in the list of output nodes having a relative URI as its value.

Throws:

CanonicalXMLSerializerException - if there exists a namespace attribute node in the node list, whose value is a relative URI. Relative namespace URIs are not allowed according to Canonical XML.