Module org.apache.santuario.xmlsec

Package org.apache.xml.security.transforms.implementations

Class TransformBase64Decode

java.lang.Object

org.apache.xml.security.transforms.TransformSpi

org.apache.xml.security.transforms.implementations.TransformBase64Decode

public class TransformBase64Decode
extends TransformSpi

Implements the http://www.w3.org/2000/09/xmldsig#base64 decoding transform.

The normative specification for base64 decoding transforms is [MIME]. The base64 Transform element has no content. The input is decoded by the algorithms. This transform is useful if an application needs to sign the raw data associated with the encoded content of an element.

This transform requires an octet stream for input. If an XPath node-set (or sufficiently functional alternative) is given as input, then it is converted to an octet stream by performing operations LOGically equivalent to 1) applying an XPath transform with expression self::text(), then 2) taking the string-value of the node-set. Thus, if an XML element is identified by a barename XPointer in the Reference URI, and its content consists solely of base64 encoded character data, then this transform automatically strips away the start and end tags of the identified element and any of its descendant elements as well as any descendant comments and processing instructions. The output of this transform is an octet stream.

Constructor Summary

Constructors

Constructor	Description
TransformBase64Decode()

Method Summary

Modifier and Type	Method	Description
protected String	engineGetURI()	Returns the URI representation of Transformation algorithm
protected 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

TransformBase64Decode

public TransformBase64Decode()

Method Detail

engineGetURI

protected String engineGetURI()

Returns the URI representation of Transformation algorithm

Specified by:

engineGetURI in class TransformSpi

Returns:

the URI representation of Transformation algorithm

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   OutputStream os,
                                                   Element transformElement,
                                                   String baseURI,
                                                   boolean secureValidation)
                                            throws IOException,
                                                   CanonicalizationException,
                                                   TransformationException

The mega method which MUST be implemented by the Transformation Algorithm.

Specified by:

enginePerformTransform in class TransformSpi

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:

IOException

CanonicalizationException

TransformationException