iaik.ixsil.algorithms

Class CanonicalizationAlgorithmImplExclusiveCanonicalXML

java.lang.Object

iaik.ixsil.algorithms.Algorithm

iaik.ixsil.algorithms.CanonicalizationAlgorithm

iaik.ixsil.algorithms.CanonicalizationAlgorithmImplExclusiveCanonicalXML

Direct Known Subclasses:

CanonicalizationAlgorithmImplExclusiveCanonicalXMLWithComments

public class CanonicalizationAlgorithmImplExclusiveCanonicalXML
extends CanonicalizationAlgorithm

Provides an canonicalization algorithm implementation of the Exclusive XML Canonicalization Version 1.0 canonicalization algorithm. Comments will be omitted.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_ALGORITHM_URI_ The default algorithm URI for this algorithm implementation.
protected java.lang.String	inclusiveNamespacePrefixes_ Contains the list of namespace prefixes to be handled as per Canonical XML.
protected static java.lang.String	INCLUSIVENAMESPACES_ATTR_PREFIXLIST_ Name of the PrefixList attribute of the InclusiveNamespaces XML element.
protected static java.lang.String	INCLUSIVENAMESPACES_TAG_ Name of the InclusiveNamespaces XML element (parameter element of CanonicalizationMethod).
protected static java.lang.String	NAMESPACE_PREFIX_EC14N_ The namespace prefix to be used for the InclusiveNamespaces XML element.
protected boolean	omitComments_ Contains the information whether to omit comments or not.

Fields inherited from class iaik.ixsil.algorithms.CanonicalizationAlgorithm

inputNodeSet_

Fields inherited from class iaik.ixsil.algorithms.Algorithm

uri_

Constructor Summary

Constructors

Constructor and Description
CanonicalizationAlgorithmImplExclusiveCanonicalXML() Standard constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	canonicalize() Creates a canonical physical representation of the specified XPath node set input according to the standard mentioned in the description of this class.
java.lang.String	getInclusiveNamespacePrefixes() Gets the list of namespace prefixes to be handled as per Canonical XML.
void	setInclusiveNamespacePrefixes(java.lang.String prefixes) Sets the list of namespace prefixes to be handled as per Canonical XML.
void	setParameters(org.w3c.dom.Element algorithmElement) This algorithm optionally takes the list of namespace prefixes to be handled as per Canonical XML as a parameter.
org.w3c.dom.Element	toElement(org.w3c.dom.Document signatureDOMDoc) Returns the DOM element representation of the algorithm.

Methods inherited from class iaik.ixsil.algorithms.CanonicalizationAlgorithm

setInput

Methods inherited from class iaik.ixsil.algorithms.Algorithm

getURI, setURI

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALGORITHM_URI_

protected static final java.lang.String DEFAULT_ALGORITHM_URI_

The default algorithm URI for this algorithm implementation.

See Also:

Constant Field Values

INCLUSIVENAMESPACES_TAG_

protected static final java.lang.String INCLUSIVENAMESPACES_TAG_

Name of the InclusiveNamespaces XML element (parameter element of CanonicalizationMethod).

See Also:

Constant Field Values

INCLUSIVENAMESPACES_ATTR_PREFIXLIST_

protected static final java.lang.String INCLUSIVENAMESPACES_ATTR_PREFIXLIST_

Name of the PrefixList attribute of the InclusiveNamespaces XML element.

See Also:

Constant Field Values

NAMESPACE_PREFIX_EC14N_

protected static final java.lang.String NAMESPACE_PREFIX_EC14N_

The namespace prefix to be used for the InclusiveNamespaces XML element.

See Also:

Constant Field Values

omitComments_

protected boolean omitComments_

Contains the information whether to omit comments or not. Has a fix value of true for this class, but can be changed by superclasses.

inclusiveNamespacePrefixes_

protected java.lang.String inclusiveNamespacePrefixes_

Contains the list of namespace prefixes to be handled as per Canonical XML.

Constructor Detail

CanonicalizationAlgorithmImplExclusiveCanonicalXML

public CanonicalizationAlgorithmImplExclusiveCanonicalXML()

Standard constructor. Sets the default value for the algorithm URI to http://www.w3.org/2001/10/xml-exc-c14n#.

Method Detail

setInclusiveNamespacePrefixes

public void setInclusiveNamespacePrefixes(java.lang.String prefixes)

Sets the list of namespace prefixes to be handled as per Canonical XML.

Parameters:

prefixes - The prefixes as a whitespace separated list. May be null or an empty string.

getInclusiveNamespacePrefixes

public java.lang.String getInclusiveNamespacePrefixes()

Gets the list of namespace prefixes to be handled as per Canonical XML.

Returns:

the prefixes as a whitespace separated list.

setParameters

public void setParameters(org.w3c.dom.Element algorithmElement)

This algorithm optionally takes the list of namespace prefixes to be handled as per Canonical XML as a parameter. If specified, the parameter element InclusiveNamespaces is an empty element with a required PrefixList attribute. This attribute contains the prefixes as a whitespace seperated list.

Overrides:

setParameters in class Algorithm

Parameters:

algorithmElement - The DOM element representation of the algorithm, as it will be found by IXSIL in the XML signature. Must not be null.

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document signatureDOMDoc)
                              throws AlgorithmException

Returns the DOM element representation of the algorithm.

Specified by:

toElement in class Algorithm

Parameters:

signatureDOMDoc - The DOM document which should be used to create necessary DOM nodes.

Returns:

the DOM element representation of the algorithm.

Throws:

AlgorithmException - if no identifying URI has been specified for this algorithm.

canonicalize

public java.io.InputStream canonicalize()
                                 throws AlgorithmException

Creates a canonical physical representation of the specified XPath node set input according to the standard mentioned in the description of this class.

Specified by:

canonicalize in class CanonicalizationAlgorithm

Returns:

the canonical physical representation of this algorithm's input.

Throws:

AlgorithmException - if no input has been set previously, or if computing the canonical physical representation fails for any reason.