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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CanonicalizerBase.C14NStack<E>
private static enum	CanonicalizerBase.DocumentLevel

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final byte[]	__X9_
(package private) static final byte[]	__XA_
(package private) static final byte[]	__XD_
(package private) static final byte[]	_AMP_
(package private) static final byte[]	_BEGIN_COMM
(package private) static final byte[]	_BEGIN_PI
(package private) static final byte[]	_END_COMM
(package private) static final byte[]	_END_PI
(package private) static final byte[]	_END_TAG
(package private) static final byte[]	_GT_
(package private) static final byte[]	_LT_
(package private) static final byte[]	_QUOT_
private static final Map<String,byte[]>	CACHE
private CanonicalizerBase.DocumentLevel	currentDocumentLevel
protected static final char	DOUBLEPOINT
(package private) static final byte[]	EQUAL_STRING
protected boolean	firstCall
private boolean	includeComments
(package private) static final byte[]	NEWLINE
private final CanonicalizerBase.C14NStack<XMLSecEvent>	outputStack
protected static final String	XML
protected static final String	XMLNS

Constructor Summary

Constructors

Constructor	Description
CanonicalizerBase(boolean includeComments)

Method Summary

Modifier and Type	Method	Description
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)
private boolean	namespaceIsAbsolute(String namespaceValue)
protected static void	outputAttrToWriter(String prefix, String name, String value, OutputStream writer, Map<String,byte[]> CACHE)
protected static void	outputCommentToWriter(XMLSecComment currentComment, OutputStream writer, CanonicalizerBase.DocumentLevel position)	Method outputCommentToWriter
protected static void	outputPItoWriter(XMLSecProcessingInstruction currentPI, OutputStream writer, 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 TransformIdentity

getOutputStream, getTransformer, getXmlEventWriterForOutputStream, getXmlInputFactory, getXmlOutputFactory, setOutputStream

Methods inherited from class Object

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

Field Details

_END_PI

static final byte[] _END_PI

_BEGIN_PI

static final byte[] _BEGIN_PI

_END_COMM

static final byte[] _END_COMM

_BEGIN_COMM

static final byte[] _BEGIN_COMM

__XA_

static final byte[] __XA_

__X9_

static final byte[] __X9_

_QUOT_

static final byte[] _QUOT_

__XD_

static final byte[] __XD_

_GT_

static final byte[] _GT_

_LT_

static final byte[] _LT_

_END_TAG

static final byte[] _END_TAG

_AMP_

static final byte[] _AMP_

EQUAL_STRING

static final byte[] EQUAL_STRING

NEWLINE

static final byte[] NEWLINE

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

CACHE

private static final Map<String,byte[]> CACHE

outputStack

private final CanonicalizerBase.C14NStack<XMLSecEvent> outputStack

includeComments

private boolean includeComments

currentDocumentLevel

private CanonicalizerBase.DocumentLevel currentDocumentLevel

firstCall

protected boolean firstCall

Constructor Details

CanonicalizerBase

public CanonicalizerBase(boolean includeComments)

Method Details

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,
 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,
 CanonicalizerBase.DocumentLevel position)
                                     throws IOException

Method outputCommentToWriter

Parameters:

currentComment -

writer - writer where to write the things

Throws:

IOException

namespaceIsAbsolute

private boolean namespaceIsAbsolute(String namespaceValue)