Class TransformSpi

java.lang.Object

org.apache.xml.security.transforms.TransformSpi

public abstract class TransformSpi
extends Object

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

Author:

Christian Geuer-Pollmann

Field Summary

Fields

Modifier and Type	Field	Description
protected Transform	_transformObject

Constructor Summary

Constructors

Constructor	Description
TransformSpi()

Method Summary

Modifier and Type	Method	Description
protected abstract 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.
protected XMLSignatureInput	enginePerformTransform(XMLSignatureInput input, OutputStream os)	The mega method which MUST be implemented by the Transformation Algorithm.
protected void	setTransform(Transform transform)

Methods inherited from class Object

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

Field Details

_transformObject

protected Transform _transformObject

Constructor Details

TransformSpi

public TransformSpi()

Method Details

setTransform

protected void setTransform(Transform transform)

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
 OutputStream os)
                                            throws IOException,
CanonicalizationException,
InvalidCanonicalizerException,
TransformationException,
ParserConfigurationException,
SAXException

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

Parameters:

input - XMLSignatureInput as the input of transformation

os - where to output this transformation.

Returns:

XMLSignatureInput as the result of transformation

Throws:

CanonicalizationException

IOException

InvalidCanonicalizerException

ParserConfigurationException

SAXException

TransformationException

enginePerformTransform

protected abstract XMLSignatureInput enginePerformTransform(XMLSignatureInput input)
                                                     throws IOException,
CanonicalizationException,
InvalidCanonicalizerException,
TransformationException,
ParserConfigurationException,
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

IOException

InvalidCanonicalizerException

ParserConfigurationException

SAXException

TransformationException

engineGetURI

protected abstract String engineGetURI()

Returns the URI representation of Transformation algorithm

Returns:

the URI representation of Transformation algorithm