iaik.ixsil.util

Interface ExclusiveCanonicalXMLSerializerInterface

All Known Implementing Classes:

CanonicalXMLSerializerImpl

public interface ExclusiveCanonicalXMLSerializerInterface

Defines the interface for an XML serializer according to the rules defined in Exclusive XML Canonicalization.

An implementation of this interface MUST provide a factory method to get an instance of the implementation, which must fulfill the following signature:

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

The first argument allOutputNodesList provides a list of all DOM nodes which are to be serialized. The following node types are allowed:

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

The second argument contains a list of XML namespace prefixes and corresponds with the attribute PrefixList of the InclusiveNamespaces parameter element defined in section 4 of Exclusive XML Canonicalization. May be null or an emtpy string.

The third argument indicates whether comment nodes should be serialized or not.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FACTORY_METHOD_NAME_ The name of the factory method in the implementation class which IXSIL uses to get an implementation instance for this interface.
static java.lang.String	INITPROPERTY_IMPL_CLASSNAME_ The name of the IXSIL Init Property containing the name of the implementation class IXSIL should use for this interface.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	serialize() Serializes the nodes specified at the factory method invokation, according to the rules defined in Exclusive XML Canonicalization.

Field Detail

INITPROPERTY_IMPL_CLASSNAME_

static final java.lang.String INITPROPERTY_IMPL_CLASSNAME_

The name of the IXSIL Init Property containing the name of the implementation class IXSIL should use for this interface.

See Also:

Constant Field Values

FACTORY_METHOD_NAME_

static final java.lang.String FACTORY_METHOD_NAME_

The name of the factory method in the implementation class which IXSIL uses to get an implementation instance for this interface.

See Also:

Constant Field Values

Method Detail

serialize

java.io.InputStream serialize()
                              throws CanonicalXMLSerializerException

Serializes the nodes specified at the factory method invokation, according to the rules defined in Exclusive XML Canonicalization.

Returns:

the serialization result as an octet stream. If there are no nodes to be serialized, an octet stream of length 0 will be returned.

Throws:

CanonicalXMLSerializerException - if serialization fails for any reason.