iaik.ixsil.algorithms

Class Algorithm

java.lang.Object

iaik.ixsil.algorithms.Algorithm

Direct Known Subclasses:

CanonicalizationAlgorithm, DigestAlgorithm, SignatureAlgorithm, Transform

public abstract class Algorithm
extends java.lang.Object

Defines the common behaviour of all types of algorithms utilized by IXSIL.

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	uri_ The name URI associated with this algorithm.

Constructor Summary

Constructors

Constructor and Description
Algorithm()

Method Summary

Modifier and Type	Method and Description
URI	getURI() Gets the URI, which identifies the algorithm.
void	setParameters(org.w3c.dom.Element algorithmElement) Allows the specification of parameters for this algorithm.
void	setURI(URI uri) Set the URI, which identifies the algorithm.
abstract org.w3c.dom.Element	toElement(org.w3c.dom.Document signatureDOMDoc) Returns the DOM element representation of the algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

uri_

protected URI uri_

The name URI associated with this algorithm.

Constructor Detail

Algorithm

public Algorithm()

Method Detail

getURI

public URI getURI()

Gets the URI, which identifies the algorithm.

Returns:

the algorithm's name URI.

setURI

public void setURI(URI uri)

Set the URI, which identifies the algorithm.

Parameters:

uri - The URI identifying the algorithm. Must not be null.

setParameters

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

Allows the specification of parameters for this algorithm. Used by IXSIL in the signature verification use case. This implementation simply does nothing. It can be used by all algorithm implementations which do not provide any parameters.

Parameters:

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

Throws:

AlgorithmException - if the algorithm cannot interpret the specified parameter.

toElement

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

Returns the DOM element representation of the algorithm. Used by IXSIL to incorporate the algorithm into the XML representation of the signature.

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 computing the DOM element representation fails for any reason.