iaik.ixsil.algorithms

Class TransformImplXSLT

java.lang.Object

iaik.ixsil.algorithms.Algorithm

iaik.ixsil.algorithms.Transform

iaik.ixsil.algorithms.TransformImplXSLT

public class TransformImplXSLT
extends Transform

Provides a Transform implementation of a XSL Transformation (XSLT).

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_ALGORITHM_URI_ The default algorithm URI for this algorithm implementation.
protected static int	ESXLT_DISABLED
protected static int	EXSLT_ENABLED
protected static int	EXSLT_UNKNOWN
protected static java.lang.String	NAMESPACE_URI_XSLT_ The namespace for XSLT.
protected static java.lang.String	STYLESHEET_TAG_ The name for the XSL stylesheet element.
protected org.w3c.dom.Element	styleSheetDOMElem_ The stylesheet parameter element which contains the XLS stylesheet to be applied.
protected URI	styleSheetURI_ The URI for the stylesheet to be applied.
protected javax.xml.transform.Transformer	transformer_ The XLS transformer object.
protected javax.xml.transform.URIResolver	uRIResolver_ The URI resolver used for resolving URIs within the stylesheet (include, import, document()).

Fields inherited from class iaik.ixsil.algorithms.Transform

inputNodeSet_, inputOctetStream_, inputURI_

Fields inherited from class iaik.ixsil.algorithms.Algorithm

uri_

Constructor Summary

Constructors

Constructor and Description
TransformImplXSLT() Standard constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.Element	getStyleSheetElement() Gets the XSL stylesheet to be processed by this transform as a DOM element.
URI	getStyleSheetURI() Gets the XSL stylesheet to be processed by this transform as a DOM element.
javax.xml.transform.URIResolver	getURIResolver() Gets the URI resolver used for resolving URIs within the stylesheet (include, import, document()).
void	setParameters(org.w3c.dom.Element transformElement) Sets the parameters for this XSL transform implementation.
void	setStyleSheet(org.w3c.dom.Element styleSheetDOMElem, URI styleSheetURI) Sets the XSL stylesheet to be processed by this transform.
void	setStyleSheet(java.io.InputStream styleSheetXMLStream, URI styleSheetURI) Sets the XSL stylesheet to be processed by this transform.
void	setURIResolver(javax.xml.transform.URIResolver uRIResolver) Sets the URI resolver used for resolving URIs within the stylesheet (include, import, document()).
org.w3c.dom.Element	toElement(org.w3c.dom.Document signatureDOMDoc) Returns the DOM element representation of the transform.
java.lang.Object	transform() Computes the transform result for the previously specified input.

Methods inherited from class iaik.ixsil.algorithms.Transform

distributeNSDeclarations, setInput, setInput, skipStylesheetElem, withdrawDistributedNSDeclarations

Methods inherited from class iaik.ixsil.algorithms.Algorithm

getURI, setURI

Methods inherited from class java.lang.Object

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

Field Detail

ESXLT_DISABLED

protected static final int ESXLT_DISABLED

See Also:

Constant Field Values

EXSLT_ENABLED

protected static final int EXSLT_ENABLED

See Also:

Constant Field Values

EXSLT_UNKNOWN

protected static final int EXSLT_UNKNOWN

See Also:

Constant Field Values

DEFAULT_ALGORITHM_URI_

protected static final java.lang.String DEFAULT_ALGORITHM_URI_

The default algorithm URI for this algorithm implementation.

See Also:

Constant Field Values

NAMESPACE_URI_XSLT_

protected static final java.lang.String NAMESPACE_URI_XSLT_

The namespace for XSLT.

See Also:

Constant Field Values

STYLESHEET_TAG_

protected static final java.lang.String STYLESHEET_TAG_

The name for the XSL stylesheet element.

See Also:

Constant Field Values

styleSheetDOMElem_

protected org.w3c.dom.Element styleSheetDOMElem_

The stylesheet parameter element which contains the XLS stylesheet to be applied.

uRIResolver_

protected javax.xml.transform.URIResolver uRIResolver_

The URI resolver used for resolving URIs within the stylesheet (include, import, document()).

transformer_

protected javax.xml.transform.Transformer transformer_

The XLS transformer object.

styleSheetURI_

protected URI styleSheetURI_

The URI for the stylesheet to be applied.

Constructor Detail

TransformImplXSLT

public TransformImplXSLT()

Standard constructor. Sets the default value for the algorithm URI to http://www.w3.org/TR/1999/REC-xslt-19991116.

Method Detail

setParameters

public void setParameters(org.w3c.dom.Element transformElement)
                   throws AlgorithmException

Sets the parameters for this XSL transform implementation. The Transform element for a XSL transform must have a single parameter element, namely a stylesheet element which is in the xsl namespace (http://www.w3.org/1999/XSL/Transform).

Overrides:

setParameters in class Algorithm

Parameters:

transformElement - The DOM element representation of the transform, as it will be found by IXSIL in the XML signature. Must not equal null.

Throws:

AlgorithmException - if the stylesheet parameter element cannot be found.

setStyleSheet

public void setStyleSheet(org.w3c.dom.Element styleSheetDOMElem,
                 URI styleSheetURI)
                   throws AlgorithmException

Sets the XSL stylesheet to be processed by this transform.

Parameters:

styleSheetDOMElem - A XSL stylesheet DOM element to be processed by this transform. Must not be null and must be in the XSL namespace.

styleSheetURI - An URI indicating the system identifier of the stylesheet. Used to resolve relative URIs within the XML stylesheet. May be null.

Throws:

AlgorithmException - if initializing the XSL transformer fails.

setStyleSheet

public void setStyleSheet(java.io.InputStream styleSheetXMLStream,
                 URI styleSheetURI)
                   throws AlgorithmException

Sets the XSL stylesheet to be processed by this transform.

Parameters:

styleSheetXMLStream - An XML stylesheet document which has a stylesheet element as its document element. Must not be null.

styleSheetURI - An URI indicating the system identifier of the stylesheet. Used to resolve relative URIs within the XML stylesheet. May be null.

Throws:

AlgorithmException - If the XML document does not have a stylesheet element in the XSL namespace as its document element, or if parsing the XML style- sheet document fails for any other reason, or if initializing the XSL transformer fails.

getStyleSheetElement

public org.w3c.dom.Element getStyleSheetElement()

Gets the XSL stylesheet to be processed by this transform as a DOM element.

Returns:

An XSL stylesheet DOM element to be processed by this transform.

getStyleSheetURI

public URI getStyleSheetURI()

Gets the XSL stylesheet to be processed by this transform as a DOM element.

Returns:

An URI indicating the system identifier of the stylesheet. Used to resolve relative URIs within the XML stylesheet.

setURIResolver

public void setURIResolver(javax.xml.transform.URIResolver uRIResolver)

Sets the URI resolver used for resolving URIs within the stylesheet (include, import, document()). If this resolver is never set by the application, a default resolver is used.

Parameters:

uRIResolver - The URI resolver. May be null.

getURIResolver

public javax.xml.transform.URIResolver getURIResolver()

Gets the URI resolver used for resolving URIs within the stylesheet (include, import, document()). If the resolver has never been set by the application (setURIResolver(javax.xml.transform.URIResolver)), this method will return null.

Returns:

the URI resolver.

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document signatureDOMDoc)
                              throws AlgorithmException

Returns the DOM element representation of the transform. Used by IXSIL to incorporate the transform into the XML representation of the signature.

Specified by:

toElement in class Algorithm

Parameters:

signatureDOMDoc - The DOM document which should be used to create necessary DOM nodes.

Returns:

the DOM element representation of the transform.

Throws:

AlgorithmException - if no identifying URI has been specified for this transform, or if no XSL stylesheet has been specified for this transform.

transform

public java.lang.Object transform()
                           throws AlgorithmException

Computes the transform result for the previously specified input.

If the input has been specified as an XPath node set, it will be serialized using Canonical XML to get the input in octet stream form. If the input has been specified as octet stream, no further pre- processing will be done.

The input is then transformed according to section 6.6.5 of XML Signature.

Specified by:

transform in class Transform

Returns:

the result of the transformation process as octet stream.

Throws:

AlgorithmException - if no input has been set previously, or if no XSL stylesheet has been set previously, or if converting a XPath node set input into an octet stream input fails, or if performing the transform fails for any reason.