org.apache.xml.security.transforms
Class TransformSpi

java.lang.Object
  extended byorg.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(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.
protected  XMLSignatureInput enginePerformTransform(XMLSignatureInput input, java.io.OutputStream os)
          The mega method which MUST be implemented by the Transformation Algorithm.
protected  void setTransform(Transform transform)
           
 
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)

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   java.io.OutputStream os)
                                            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
os - where to output this transformation.
Returns:
XMLSignatureInput as the result of transformation
Throws:
CanonicalizationException
java.io.IOException
InvalidCanonicalizerException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
TransformationException

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
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