iaik.xml.crypto.alg.transform

Class XSLTTransformService

java.lang.Object

javax.xml.crypto.dsig.TransformService

iaik.xml.crypto.alg.transform.TransformServiceImpl

iaik.xml.crypto.alg.transform.XSLTTransformService

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

public class XSLTTransformService
extends TransformServiceImpl

This TransformService implements the XSLT Transform (http://www.w3.org/TR/1999/REC-xslt-19991116) as specified by the W3C recommendation XML-Signature Syntax and Processing.

The normative specification for XSL Transformations is XSLT. Specification of a namespace-qualified stylesheet element, which MUST be the sole child of the Transform element, indicates that the specified style sheet should be used. Whether this instantiates in-line processing of local XSLT declarations within the resource is determined by the XSLT processing model; the ordered application of multiple stylesheet may require multiple Transforms. No special provision is made for the identification of a remote stylesheet at a given URI because it can be communicated via an xsl:include or xsl:import within the stylesheet child of the Transform.

This transform requires an octet stream as input. If the actual input is an XPath node-set, then the signature application should attempt to convert it to octets (apply Canonical XML) as described in the Reference Processing Model (section 4.3.3.2).

The output of this transform is an octet stream. The processing rules for the XSL style sheet or transform element are stated in the XSLT specification. We RECOMMEND that XSLT transform authors use an output method of xml for XML and HTML. As XSLT implementations do not produce consistent serializations of their output, we further RECOMMEND inserting a transform after the XSLT transform to canonicalize the output. These steps will help to ensure interoperability of the resulting signatures among applications that support the XSLT transform. Note that if the output is actually HTML, then the result of these steps is logically equivalent.

Supported Algorithm Parameter:

• XSLTTransformParameterSpec (mandatory)

Transform Result type:

• OctetStreamData

Field Summary

Fields inherited from class iaik.xml.crypto.alg.transform.TransformServiceImpl

transformNode_

Fields inherited from interface javax.xml.crypto.dsig.Transform

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Constructor and Description
XSLTTransformService()

Method Summary

Modifier and Type	Method and Description
List	getAlgorithmParameters() Returns the list of algorithm parameter.
AlgorithmParameterSpec	getParameterSpec() Returns the algorithm-specific input parameters associated with this Transform.
static Transformer	secureTransformer(URIResolver resolver, DOMSource stylesheet, XMLCryptoContext context) This method returns a secured XSLT Transformer.
protected void	setParameterSpec(AlgorithmParameterSpec spec) Sets the algorithm parameter for this TransformService.
protected void	setParameterSpec(List params) Sets the algorithm parameter for this TransformService.
Data	transform(Data data, XMLCryptoContext context) Transforms the specified data using the underlying transform algorithm.

Methods inherited from class iaik.xml.crypto.alg.transform.TransformServiceImpl

init, init, isFeatureSupported, marshalParams, parse, parse, transform

Methods inherited from class javax.xml.crypto.dsig.TransformService

getAlgorithm, getInstance, getInstance, getInstance, getMechanismType, getProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

XSLTTransformService

public XSLTTransformService()

Method Detail

setParameterSpec

protected void setParameterSpec(AlgorithmParameterSpec spec)
                         throws InvalidAlgorithmParameterException

Description copied from class: TransformServiceImpl

Sets the algorithm parameter for this TransformService.

Specified by:

setParameterSpec in class TransformServiceImpl

Parameters:

spec - the AlgorithmParameterSpec

Throws:

InvalidAlgorithmParameterException - if the supplied spec is not appropriate for this TransformService

See Also:

TransformServiceImpl.setParameterSpec(java.security.spec.AlgorithmParameterSpec)

setParameterSpec

protected void setParameterSpec(List params)
                         throws InvalidAlgorithmParameterException

Description copied from class: TransformServiceImpl

Sets the algorithm parameter for this TransformService.

Specified by:

setParameterSpec in class TransformServiceImpl

Parameters:

params - the list of AlgorithmParameterImpls

Throws:

InvalidAlgorithmParameterException - if supplied params are not appropriate for this TransformService

See Also:

TransformServiceImpl.setParameterSpec(java.util.List)

getAlgorithmParameters

public List getAlgorithmParameters()

Description copied from class: TransformServiceImpl

Returns the list of algorithm parameter.

Specified by:

getAlgorithmParameters in class TransformServiceImpl

Returns:

a list of AlgorithmParameterImpls (may be empty but never null)

See Also:

TransformServiceImpl.getAlgorithmParameters()

getParameterSpec

public AlgorithmParameterSpec getParameterSpec()

Description copied from interface: javax.xml.crypto.dsig.Transform

Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a TransformParameterSpec object.

Returns:

the algorithm parameters of this AlgorithmMethod. Returns null if this AlgorithmMethod does not require parameters and they are not specified.

See Also:

AlgorithmMethod.getParameterSpec()

secureTransformer

public static Transformer secureTransformer(URIResolver resolver,
                                            DOMSource stylesheet,
                                            XMLCryptoContext context)
                                     throws TransformerConfigurationException,
                                            TransformException

This method returns a secured XSLT Transformer.

Parameters:

resolver - The URI resolver to be used by this transformer.

stylesheet - The stylesheet to be compiled into a tranformer.

context - The crypto context.

Returns:

A Transformer object.

Throws:

TransformerConfigurationException

TransformException

transform

public Data transform(Data data,
                      XMLCryptoContext context)
               throws TransformException

Description copied from interface: javax.xml.crypto.dsig.Transform

Transforms the specified data using the underlying transform algorithm.

Parameters:

data - the data to be transformed

context - the XMLCryptoContext containing additional context (may be null if not applicable)

Returns:

the transformed data

Throws:

TransformException - if an error occurs while executing the transform

See Also:

Transform.transform(javax.xml.crypto.Data, javax.xml.crypto.XMLCryptoContext)