Module org.apache.santuario.xmlsec

Package org.apache.xml.security.transforms

Class TransformSpi

java.lang.Object

org.apache.xml.security.transforms.TransformSpi

Direct Known Subclasses:

TransformBase64Decode, TransformC14N, TransformC14NExclusive, TransformEnvelopedSignature, TransformXPath, TransformXPath2Filter, TransformXSLT

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, OutputStream, Element, String, boolean) method. Extensions of this class must be thread-safe.

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, OutputStream os, Element transformElement, String baseURI, boolean secureValidation)	The mega method which MUST be implemented by the Transformation Algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformSpi

public TransformSpi()

Method Detail

enginePerformTransform

protected abstract XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                            OutputStream os,
                                                            Element transformElement,
                                                            String baseURI,
                                                            boolean secureValidation)
                                                     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.

transformElement - the Transform element

baseURI - The baseURI

secureValidation - Whether secure validation is enabled

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