Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xml.security.c14n.implementations
Class Canonicalizer20010315Excl

    java.lang.Object
      org.apache.xml.security.c14n.CanonicalizerSpi
          org.apache.xml.security.c14n.implementations.CanonicalizerBase
              org.apache.xml.security.c14n.implementations.Canonicalizer20010315Excl

Direct Known Subclasses:
  Canonicalizer20010315ExclOmitComments, Canonicalizer20010315ExclWithComments

    public abstract class Canonicalizer20010315Excl

extends CanonicalizerBase

Implements " Exclusive XML Canonicalization, Version 1.0 "
Credits: During restructuring of the Canonicalizer framework, Ren?? Kollmorgen from Software AG submitted an implementation of ExclC14n which fitted into the old architecture and which based heavily on my old (and slow) implementation of "Canonical XML". A big "thank you" to Ren?? for this.
THIS implementation is a complete rewrite of the algorithm.

Version:
  $Revision: 1558590 $
Author:
  Christian Geuer-Pollmann
See Also:
  XML Canonicalization, Version 1.0

Field Summary

Fields inherited from class org.apache.xml.security.c14n.implementations.CanonicalizerBase
`COMPARE, NODE_AFTER_DOCUMENT_ELEMENT, NODE_BEFORE_DOCUMENT_ELEMENT, NODE_NOT_BEFORE_OR_AFTER_DOCUMENT_ELEMENT, XML, XMLNS`

Fields inherited from class org.apache.xml.security.c14n.CanonicalizerSpi
`reset, secureValidation`

Constructor Summary
`Canonicalizer20010315Excl(boolean includeComments)` Constructor Canonicalizer20010315Excl

Method Summary
`protected void` | `circumventBugIfNeeded(XMLSignatureInput input)`
`byte[]` | `engineCanonicalize(XMLSignatureInput rootNode, java.lang.String inclusiveNamespaces)`
`byte[]` | `engineCanonicalizeSubTree(org.w3c.dom.Node rootNode)` Method engineCanonicalizeSubTree
`byte[]` | `engineCanonicalizeSubTree(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces)` Method engineCanonicalizeSubTree
`byte[]` | `engineCanonicalizeSubTree(org.w3c.dom.Node rootNode, java.lang.String inclusiveNamespaces, org.w3c.dom.Node excl)` Method engineCanonicalizeSubTree
`byte[]` | `engineCanonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.lang.String inclusiveNamespaces)` Method engineCanonicalizeXPathNodeSet
`protected java.util.Iterator<org.w3c.dom.Attr>` | `handleAttributes(org.w3c.dom.Element element, NameSpaceSymbTable ns)` Obtain the attributes to output for this node in XPathNodeSet c14n.
`protected java.util.Iterator<org.w3c.dom.Attr>` | `handleAttributesSubtree(org.w3c.dom.Element element, NameSpaceSymbTable ns)` Obtain the attributes to output for this node in a Subtree c14n.

Methods inherited from class org.apache.xml.security.c14n.implementations.CanonicalizerBase
`canonicalizeSubTree, canonicalizeXPathNodeSet, engineCanonicalize, engineCanonicalizeSubTree, engineCanonicalizeXPathNodeSet, getNullNode, getParentNameSpaces, handleParent, isVisible, isVisibleDO, isVisibleInt, outputAttrToWriter, outputCommentToWriter, outputPItoWriter, outputTextToWriter, setWriter`

Methods inherited from class org.apache.xml.security.c14n.CanonicalizerSpi
`engineCanonicalize, engineCanonicalizeXPathNodeSet, engineCanonicalizeXPathNodeSet, engineGetIncludeComments, engineGetURI, isSecureValidation, setSecureValidation`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### Canonicalizer20010315Excl

    public Canonicalizer20010315Excl(boolean includeComments)

  Constructor Canonicalizer20010315Excl

  Parameters:
    `includeComments` -

Method Detail

### engineCanonicalizeSubTree

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

  Method engineCanonicalizeSubTree

  Overrides:
    `engineCanonicalizeSubTree` in class `CanonicalizerBase`
  Parameters:
    `rootNode` -
  Returns:
    the c14n bytes
  Throws:
    `CanonicalizationException`

### engineCanonicalizeSubTree

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

  Method engineCanonicalizeSubTree

  Specified by:
    `engineCanonicalizeSubTree` in class `CanonicalizerSpi`
  Parameters:
    `rootNode` -
    `inclusiveNamespaces` -
  Returns:
    the c14n bytes
  Throws:
    `CanonicalizationException`

### engineCanonicalizeSubTree

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

  Method engineCanonicalizeSubTree

  Parameters:
    `rootNode` -
    `inclusiveNamespaces` -
    `excl` - A element to exclude from the c14n process.
  Returns:
    the rootNode c14n.
  Throws:
    `CanonicalizationException`

### engineCanonicalize

    public byte[] engineCanonicalize(XMLSignatureInput rootNode,
                                     java.lang.String inclusiveNamespaces)
                              throws CanonicalizationException

  Parameters:
    `rootNode` -
    `inclusiveNamespaces` -
  Returns:
    the rootNode c14n.
  Throws:
    `CanonicalizationException`

### engineCanonicalizeXPathNodeSet

    public byte[] engineCanonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
                                                 java.lang.String inclusiveNamespaces)
                                          throws CanonicalizationException

  Method engineCanonicalizeXPathNodeSet

  Specified by:
    `engineCanonicalizeXPathNodeSet` in class `CanonicalizerSpi`
  Parameters:
    `xpathNodeSet` -
    `inclusiveNamespaces` -
  Returns:
    the c14n bytes
  Throws:
    `CanonicalizationException`

### handleAttributesSubtree

    protected java.util.Iterator<org.w3c.dom.Attr> handleAttributesSubtree(org.w3c.dom.Element element,
                                                                           NameSpaceSymbTable ns)
                                                                    throws CanonicalizationException

  Description copied from class: `CanonicalizerBase`
  Obtain the attributes to output for this node in a Subtree c14n.

  Returns:
    the attributes nodes to output.
  Throws:
    `CanonicalizationException`

### handleAttributes

    protected final java.util.Iterator<org.w3c.dom.Attr> handleAttributes(org.w3c.dom.Element element,
                                                                          NameSpaceSymbTable ns)
                                                                   throws CanonicalizationException

  Description copied from class: `CanonicalizerBase`
  Obtain the attributes to output for this node in XPathNodeSet c14n.

  Parameters:
    `element` -
  Returns:
    the attributes nodes to output.
  Throws:
    `CanonicalizationException`

### circumventBugIfNeeded

    protected void circumventBugIfNeeded(XMLSignatureInput input)
                                  throws CanonicalizationException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

  Throws:
    `CanonicalizationException`
    `javax.xml.parsers.ParserConfigurationException`
    `java.io.IOException`
    `org.xml.sax.SAXException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD