org.apache.xml.security.c14n
Class CanonicalizerSpi

java.lang.Object
  extended by org.apache.xml.security.c14n.CanonicalizerSpi
Direct Known Subclasses:
CanonicalizerBase

public abstract class CanonicalizerSpi
extends Object

Base class which all Canonicalization algorithms extend.

Author:
Christian Geuer-Pollmann

Field Summary
protected  boolean reset
          Reset the writer after a c14n
protected  boolean secureValidation
           
 
Constructor Summary
CanonicalizerSpi()
           
 
Method Summary
 byte[] engineCanonicalize(byte[] inputBytes)
          Method canonicalize
abstract  byte[] engineCanonicalizeSubTree(Node rootNode)
          C14n a node tree.
abstract  byte[] engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces)
          C14n a node tree.
abstract  byte[] engineCanonicalizeSubTree(Node rootNode, String inclusiveNamespaces, boolean propagateDefaultNamespace)
          C14n a node tree.
 byte[] engineCanonicalizeXPathNodeSet(NodeList xpathNodeSet)
          Method engineCanonicalizeXPathNodeSet
 byte[] engineCanonicalizeXPathNodeSet(NodeList xpathNodeSet, String inclusiveNamespaces)
          Method engineCanonicalizeXPathNodeSet
abstract  byte[] engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet)
          C14n a nodeset
abstract  byte[] engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet, String inclusiveNamespaces)
          C14n a nodeset
abstract  boolean engineGetIncludeComments()
          Returns true if comments are included
abstract  String engineGetURI()
          Returns the URI of this engine.
 boolean isSecureValidation()
           
 void setSecureValidation(boolean secureValidation)
           
abstract  void setWriter(OutputStream os)
          Sets the writer where the canonicalization ends.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

reset

protected boolean reset
Reset the writer after a c14n


secureValidation

protected boolean secureValidation
Constructor Detail

CanonicalizerSpi

public CanonicalizerSpi()
Method Detail

engineCanonicalize

public byte[] engineCanonicalize(byte[] inputBytes)
                          throws ParserConfigurationException,
                                 IOException,
                                 SAXException,
                                 CanonicalizationException
Method canonicalize

Parameters:
inputBytes -
Returns:
the c14n bytes.
Throws:
CanonicalizationException
IOException
ParserConfigurationException
SAXException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(NodeList xpathNodeSet)
                                      throws CanonicalizationException
Method engineCanonicalizeXPathNodeSet

Parameters:
xpathNodeSet -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineCanonicalizeXPathNodeSet

public byte[] engineCanonicalizeXPathNodeSet(NodeList xpathNodeSet,
                                             String inclusiveNamespaces)
                                      throws CanonicalizationException
Method engineCanonicalizeXPathNodeSet

Parameters:
xpathNodeSet -
inclusiveNamespaces -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineGetURI

public abstract String engineGetURI()
Returns the URI of this engine.

Returns:
the URI

engineGetIncludeComments

public abstract boolean engineGetIncludeComments()
Returns true if comments are included

Returns:
true if comments are included

engineCanonicalizeXPathNodeSet

public abstract byte[] engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet)
                                               throws CanonicalizationException
C14n a nodeset

Parameters:
xpathNodeSet -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineCanonicalizeXPathNodeSet

public abstract byte[] engineCanonicalizeXPathNodeSet(Set<Node> xpathNodeSet,
                                                      String inclusiveNamespaces)
                                               throws CanonicalizationException
C14n a nodeset

Parameters:
xpathNodeSet -
inclusiveNamespaces -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineCanonicalizeSubTree

public abstract byte[] engineCanonicalizeSubTree(Node rootNode)
                                          throws CanonicalizationException
C14n a node tree.

Parameters:
rootNode -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineCanonicalizeSubTree

public abstract byte[] engineCanonicalizeSubTree(Node rootNode,
                                                 String inclusiveNamespaces)
                                          throws CanonicalizationException
C14n a node tree.

Parameters:
rootNode -
inclusiveNamespaces -
Returns:
the c14n bytes
Throws:
CanonicalizationException

engineCanonicalizeSubTree

public abstract byte[] engineCanonicalizeSubTree(Node rootNode,
                                                 String inclusiveNamespaces,
                                                 boolean propagateDefaultNamespace)
                                          throws CanonicalizationException
C14n a node tree.

Parameters:
rootNode -
inclusiveNamespaces -
propagateDefaultNamespace - If true the default namespace will be propagated to the c14n-ized root element
Returns:
the c14n bytes
Throws:
CanonicalizationException

setWriter

public abstract void setWriter(OutputStream os)
Sets the writer where the canonicalization ends. ByteArrayOutputStream if none is set.

Parameters:
os -

isSecureValidation

public boolean isSecureValidation()

setSecureValidation

public void setSecureValidation(boolean secureValidation)


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.