org.apache.xml.security.stax.impl.transformer.canonicalizer
Class CanonicalizerBase

java.lang.Object
  org.apache.xml.security.stax.impl.transformer.TransformIdentity
      org.apache.xml.security.stax.impl.transformer.canonicalizer.CanonicalizerBase

All Implemented Interfaces:

Transformer

Direct Known Subclasses:

Canonicalizer11, Canonicalizer20010315, Canonicalizer20010315_Excl

public abstract class CanonicalizerBase
extends TransformIdentity

Version:

$Revision: 1603390 $ $Date: 2014-06-18 11:13:18 +0100 (Wed, 18 Jun 2014) $

Author:

$Author: coheigea $

Nested Class Summary

static class

CanonicalizerBase.C14NStack<E>

Field Summary

protected static char	DOUBLEPOINT
protected boolean	firstCall
protected static String	XML
protected static String	XMLNS

Constructor Summary

CanonicalizerBase(boolean includeComments)

Method Summary

void	doFinal()
protected List<XMLSecAttribute>	getCurrentUtilizedAttributes(XMLSecStartElement xmlSecStartElement, CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)
protected List<XMLSecNamespace>	getCurrentUtilizedNamespaces(XMLSecStartElement xmlSecStartElement, CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)
protected List<XMLSecAttribute>	getInitialUtilizedAttributes(XMLSecStartElement xmlSecStartElement, CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)
protected List<XMLSecNamespace>	getInitialUtilizedNamespaces(XMLSecStartElement xmlSecStartElement, CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)
XMLSecurityConstants.TransformMethod	getPreferredTransformMethod(XMLSecurityConstants.TransformMethod forInput)
protected static void	outputAttrToWriter(String prefix, String name, String value, OutputStream writer, Map<String,byte[]> cache)
protected static void	outputCommentToWriter(XMLSecComment currentComment, OutputStream writer, org.apache.xml.security.stax.impl.transformer.canonicalizer.CanonicalizerBase.DocumentLevel position) Method outputCommentToWriter
protected static void	outputPItoWriter(XMLSecProcessingInstruction currentPI, OutputStream writer, org.apache.xml.security.stax.impl.transformer.canonicalizer.CanonicalizerBase.DocumentLevel position) Outputs a PI to the internal Writer.
protected static void	outputTextToWriter(char[] text, OutputStream writer)
protected static void	outputTextToWriter(String text, OutputStream writer) Outputs a Text of CDATA section to the internal Writer.
void	setProperties(Map<String,Object> properties)
void	setTransformer(Transformer transformer)
void	transform(InputStream inputStream)
void	transform(XMLSecEvent xmlSecEvent)

Methods inherited from class org.apache.xml.security.stax.impl.transformer.TransformIdentity

getOutputStream, getTransformer, getXmlEventWriterForOutputStream, getXmlInputFactory, getXmlOutputFactory, setOutputStream

Methods inherited from class java.lang.Object

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

Field Detail

XML

protected static final String XML

See Also:

Constant Field Values

XMLNS

protected static final String XMLNS

See Also:

Constant Field Values

DOUBLEPOINT

protected static final char DOUBLEPOINT

See Also:

Constant Field Values

firstCall

protected boolean firstCall

Constructor Detail

CanonicalizerBase

public CanonicalizerBase(boolean includeComments)

Method Detail

setProperties

public void setProperties(Map<String,Object> properties)
                   throws XMLSecurityException

Specified by:

setProperties in interface Transformer

Overrides:

setProperties in class TransformIdentity

Throws:

XMLSecurityException

setTransformer

public void setTransformer(Transformer transformer)
                    throws XMLSecurityException

Specified by:

setTransformer in interface Transformer

Overrides:

setTransformer in class TransformIdentity

Throws:

XMLSecurityException

getCurrentUtilizedNamespaces

protected List<XMLSecNamespace> getCurrentUtilizedNamespaces(XMLSecStartElement xmlSecStartElement,
                                                             CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)

getCurrentUtilizedAttributes

protected List<XMLSecAttribute> getCurrentUtilizedAttributes(XMLSecStartElement xmlSecStartElement,
                                                             CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)

getInitialUtilizedNamespaces

protected List<XMLSecNamespace> getInitialUtilizedNamespaces(XMLSecStartElement xmlSecStartElement,
                                                             CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)

getInitialUtilizedAttributes

protected List<XMLSecAttribute> getInitialUtilizedAttributes(XMLSecStartElement xmlSecStartElement,
                                                             CanonicalizerBase.C14NStack<XMLSecEvent> outputStack)

getPreferredTransformMethod

public XMLSecurityConstants.TransformMethod getPreferredTransformMethod(XMLSecurityConstants.TransformMethod forInput)

Specified by:

getPreferredTransformMethod in interface Transformer

Overrides:

getPreferredTransformMethod in class TransformIdentity

transform

public void transform(XMLSecEvent xmlSecEvent)
               throws XMLStreamException

Specified by:

transform in interface Transformer

Overrides:

transform in class TransformIdentity

Throws:

XMLStreamException

transform

public void transform(InputStream inputStream)
               throws XMLStreamException

Specified by:

transform in interface Transformer

Overrides:

transform in class TransformIdentity

Throws:

XMLStreamException

doFinal

public void doFinal()
             throws XMLStreamException

Specified by:

doFinal in interface Transformer

Overrides:

doFinal in class TransformIdentity

Throws:

XMLStreamException

outputAttrToWriter

protected static void outputAttrToWriter(String prefix,
                                         String name,
                                         String value,
                                         OutputStream writer,
                                         Map<String,byte[]> cache)
                                  throws IOException

Throws:

IOException

outputTextToWriter

protected static void outputTextToWriter(String text,
                                         OutputStream writer)
                                  throws IOException

Outputs a Text of CDATA section to the internal Writer.

Parameters:

text -

writer - writer where to write the things

Throws:

IOException

outputTextToWriter

protected static void outputTextToWriter(char[] text,
                                         OutputStream writer)
                                  throws IOException

Throws:

IOException

outputPItoWriter

protected static void outputPItoWriter(XMLSecProcessingInstruction currentPI,
                                       OutputStream writer,
                                       org.apache.xml.security.stax.impl.transformer.canonicalizer.CanonicalizerBase.DocumentLevel position)
                                throws IOException

Outputs a PI to the internal Writer.

Parameters:

currentPI -

writer - where to write the things

Throws:

IOException

outputCommentToWriter

protected static void outputCommentToWriter(XMLSecComment currentComment,
                                            OutputStream writer,
                                            org.apache.xml.security.stax.impl.transformer.canonicalizer.CanonicalizerBase.DocumentLevel position)
                                     throws IOException

Method outputCommentToWriter

Parameters:

currentComment -

writer - writer where to write the things

Throws:

IOException