org.apache.xml.security.c14n

Class CanonicalizerSpi

java.lang.Object

org.apache.xml.security.c14n.CanonicalizerSpi

Direct Known Subclasses:

CanonicalizerBase

public abstract class CanonicalizerSpi
extends Object

Base class which all Canonicalization algorithms extend.

Constructor Summary

Constructors

Constructor and Description
CanonicalizerSpi()

Method Summary

Modifier and Type	Method and Description
void	engineCanonicalize(byte[] inputBytes, OutputStream writer, boolean secureValidation) Method canonicalize
abstract void	engineCanonicalizeSubTree(Node rootNode, OutputStream writer) C14n a node tree.
abstract void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean propagateDefaultNamespace, OutputStream writer) C14n a node tree.
abstract void	engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, OutputStream writer) C14n a node tree.
abstract void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, OutputStream writer) C14n a nodeset
abstract void	engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces, OutputStream writer) C14n a nodeset
abstract String	engineGetURI() Returns the URI of this engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

CanonicalizerSpi

public CanonicalizerSpi()

Method Detail

engineCanonicalize

public void engineCanonicalize(byte[] inputBytes,
                               OutputStream writer,
                               boolean secureValidation)
                        throws XMLParserException,
                               IOException,
                               CanonicalizationException

Method canonicalize

Parameters:

inputBytes -

writer - OutputStream to write the canonicalization result

secureValidation - Whether secure validation is enabled

Throws:

XMLParserException

IOException

ParserConfigurationException

CanonicalizationException

engineGetURI

public abstract String engineGetURI()

Returns the URI of this engine.

Returns:

the URI

engineCanonicalizeXPathNodeSet

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

C14n a nodeset

Parameters:

xpathNodeSet -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeXPathNodeSet

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

C14n a nodeset

Parameters:

xpathNodeSet -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeSubTree

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

C14n a node tree.

Parameters:

rootNode -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeSubTree

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

C14n a node tree.

Parameters:

rootNode -

inclusiveNamespaces -

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException

engineCanonicalizeSubTree

public abstract void engineCanonicalizeSubTree(Node rootNode,
                                               String inclusiveNamespaces,
                                               boolean propagateDefaultNamespace,
                                               OutputStream writer)
                                        throws CanonicalizationException

C14n a node tree.

Parameters:

rootNode -

inclusiveNamespaces -

propagateDefaultNamespace - If true the default namespace will be propagated to the c14n-ized root element

writer - OutputStream to write the canonicalization result

Throws:

CanonicalizationException