iaik.ixsil.algorithms

Class TransformImplExclusiveCanonicalXML

java.lang.Object

iaik.ixsil.algorithms.Algorithm

iaik.ixsil.algorithms.Transform

iaik.ixsil.algorithms.TransformImplExclusiveCanonicalXML

Direct Known Subclasses:

TransformImplExclusiveCanonicalXMLWithComments

public class TransformImplExclusiveCanonicalXML
extends Transform

Provides an transform 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.Transform

inputNodeSet_, inputOctetStream_, inputURI_

Fields inherited from class iaik.ixsil.algorithms.Algorithm

uri_

Constructor Summary

Constructors

Constructor and Description
TransformImplExclusiveCanonicalXML() Standard constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInclusiveNamespacePrefixes() Get 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 transformEl) This transform 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 transform.
java.lang.Object	transform() Creates a canonical physical representation of the specified input according to the standard mentioned in the description of this class.

Methods inherited from class iaik.ixsil.algorithms.Transform

distributeNSDeclarations, setInput, setInput, skipStylesheetElem, withdrawDistributedNSDeclarations

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

TransformImplExclusiveCanonicalXML

public TransformImplExclusiveCanonicalXML()

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()

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

Returns:

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

setParameters

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

This transform 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:

transformEl - The DOM element representation of the transform, 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 transform.

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 transform.

Throws:

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

transform

public java.lang.Object transform()
                           throws AlgorithmException

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

If the input has been specified as an octet stream with method Transform.setInput(InputStream, URI), this octet stream is treated as the physical representation of a well-formed XML document. The octet stream will be parsed, and a XPath node set will be produced containing all nodes of the XML document.

Alternatively, the input can be specified directly as XPath node set with method Transform.setInput(NodeList, URI).

.

In any case, the XPath node set is converted to the canonical physical representation as definied in the standard mentioned in the description of this class.

Specified by:

transform in class Transform

Returns:

the canonical physical representation of this transform's input as an octet stream.

Throws:

AlgorithmException - if no input has been set previously, if converting a XPath node set input into a octet stream input fails, or if computing the canonical physical representation fails for any reason.