org.apache.xml.security.transforms
Class TransformSpi

java.lang.Object
  |
  +--org.apache.xml.security.transforms.TransformSpi

public abstract class TransformSpi

extends java.lang.Object

Base class which all Transform algorithms extend. The common methods that have to be overridden are the enginePerformTransform(org.apache.xml.security.signature.XMLSignatureInput) method.

Author:

Christian Geuer-Pollmann

Field Summary

protected Transform

_transformObject

Constructor Summary

TransformSpi()

Method Summary

protected abstract java.lang.String	engineGetURI() Returns the URI representation of Transformation algorithm
protected abstract XMLSignatureInput	enginePerformTransform(XMLSignatureInput input) The mega method which MUST be implemented by the Transformation Algorithm.
abstract boolean	returnsNodeSet() Tests whether Transform implemenation class will generate Node Set as output of result of Transformation
abstract boolean	returnsOctetStream() Tests whether Transform implemenation class will generate Octect Stream as output of result of Transformation
protected void	setTransform(Transform transform)
abstract boolean	wantsNodeSet() Tests whether Transform implemenation class is need Octect Stream as input of Transformation
abstract boolean	wantsOctetStream() Tests whether Transform implemenation class is need Octect Stream as input of Transformation

Methods inherited from class java.lang.Object

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

Field Detail

_transformObject

protected Transform _transformObject

Constructor Detail

TransformSpi

public TransformSpi()

Method Detail

setTransform

protected void setTransform(Transform transform)

wantsOctetStream

public abstract boolean wantsOctetStream()

Tests whether Transform implemenation class is need Octect Stream as input of Transformation

Returns:

true if need Octect Stream as input

wantsNodeSet

public abstract boolean wantsNodeSet()

Tests whether Transform implemenation class is need Octect Stream as input of Transformation

Returns:

true if need Node Set as input

returnsOctetStream

public abstract boolean returnsOctetStream()

Tests whether Transform implemenation class will generate Octect Stream as output of result of Transformation

Returns:

true if will returns Octect Stream as output

returnsNodeSet

public abstract boolean returnsNodeSet()

Tests whether Transform implemenation class will generate Node Set as output of result of Transformation

Returns:

true if will returns node set as output

enginePerformTransform

protected abstract XMLSignatureInput enginePerformTransform(XMLSignatureInput input)
                                                     throws java.io.IOException,
                                                            CanonicalizationException,
                                                            InvalidCanonicalizerException,
                                                            TransformationException,
                                                            javax.xml.parsers.ParserConfigurationException,
                                                            org.xml.sax.SAXException

The mega method which MUST be implemented by the Transformation Algorithm.

Parameters:

input - XMLSignatureInput as the input of transformation

Returns:

XMLSignatureInput as the result of transformation

Throws:

CanonicalizationException

java.io.IOException

InvalidCanonicalizerException

NotYetImplementedException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

TransformationException

engineGetURI

protected abstract java.lang.String engineGetURI()

Returns the URI representation of Transformation algorithm

Returns:

the URI representation of Transformation algorithm