org.apache.xml.security.c14n
Class CanonicalizerSpi

java.lang.Object
  |
  +--org.apache.xml.security.c14n.CanonicalizerSpi

public abstract class CanonicalizerSpi
extends java.lang.Object

Base class which all Caninicalization algorithms extend. $todo$ cange JavaDoc

Author:
Christian Geuer-Pollmann

Constructor Summary
CanonicalizerSpi()
           
 
Method Summary
 byte[] engineCanonicalize(byte[] inputBytes)
          Method canonicalize
abstract  byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode)
           
abstract  byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces)
           
 byte[] engineCanonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet)
          Method engineCanonicalizeXPathNodeSet
 byte[] engineCanonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet, java.lang.String inclusiveNamespaces)
           
abstract  byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet)
           
abstract  byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet, java.lang.String inclusiveNamespaces)
           
abstract  boolean engineGetIncludeComments()
           
abstract  java.lang.String engineGetURI()
           
 
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 byte[] engineCanonicalize(byte[] inputBytes)
                          throws javax.xml.parsers.ParserConfigurationException,
                                 java.io.IOException,
                                 org.xml.sax.SAXException,
                                 CanonicalizationException
Method canonicalize

Parameters:
inputBytes -
Throws:
CanonicalizationException
java.io.IOException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet)
                                      throws CanonicalizationException
Method engineCanonicalizeXPathNodeSet

Parameters:
xpathNodeSet -
Throws:
CanonicalizationException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet,
                                             java.lang.String inclusiveNamespaces)
                                      throws CanonicalizationException
CanonicalizationException

engineGetURI

public abstract java.lang.String engineGetURI()

engineGetIncludeComments

public abstract boolean engineGetIncludeComments()

engineCanonicalizeXPathNodeSet

public abstract byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet)
                                               throws CanonicalizationException
CanonicalizationException

engineCanonicalizeXPathNodeSet

public abstract byte[] engineCanonicalizeXPathNodeSet(java.util.Set xpathNodeSet,
                                                      java.lang.String inclusiveNamespaces)
                                               throws CanonicalizationException
CanonicalizationException

engineCanonicalizeSubTree

public abstract byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode)
                                          throws CanonicalizationException
CanonicalizationException

engineCanonicalizeSubTree

public abstract byte[] engineCanonicalizeSubTree(org.w3c.dom.Node rootNode,
                                                 java.lang.String inclusiveNamespaces)
                                          throws CanonicalizationException
CanonicalizationException