org.apache.xml.security.transforms
Class TransformSpi

java.lang.Object
  org.apache.xml.security.transforms.TransformSpi

Direct Known Subclasses:

TransformBase64Decode, TransformC14N, TransformC14N11, TransformC14N11_WithComments, TransformC14NExclusive, TransformC14NExclusiveWithComments, TransformC14NWithComments, TransformEnvelopedSignature, TransformXPath, TransformXPath2Filter, TransformXPointer, 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, Transform) method.

Author:

Christian Geuer-Pollmann

Constructor Summary

TransformSpi()

Method Summary

protected abstract String	engineGetURI() Returns the URI representation of Transformation algorithm
protected XMLSignatureInput	enginePerformTransform(XMLSignatureInput input) The mega method which MUST be implemented by the Transformation Algorithm.
protected XMLSignatureInput	enginePerformTransform(XMLSignatureInput input, OutputStream os, Transform transformObject) The mega method which MUST be implemented by the Transformation Algorithm.
protected XMLSignatureInput	enginePerformTransform(XMLSignatureInput input, Transform transformObject) 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 XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   OutputStream os,
                                                   Transform transformObject)
                                            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.

transformObject - the Transform object

Returns:

XMLSignatureInput as the result of transformation

Throws:

CanonicalizationException

IOException

InvalidCanonicalizerException

ParserConfigurationException

SAXException

TransformationException

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   Transform transformObject)
                                            throws IOException,
                                                   CanonicalizationException,
                                                   InvalidCanonicalizerException,
                                                   TransformationException,
                                                   ParserConfigurationException,
                                                   SAXException

The mega method which MUST be implemented by the Transformation Algorithm. In order to be compatible with preexisting Transform implementations, by default this implementation invokes the deprecated, thread-unsafe methods. Subclasses should override this with a thread-safe implementation.

Parameters:

input - XMLSignatureInput as the input of transformation

transformObject - the Transform object

Returns:

XMLSignatureInput as the result of transformation

Throws:

CanonicalizationException

IOException

InvalidCanonicalizerException

ParserConfigurationException

SAXException

TransformationException

enginePerformTransform

protected 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