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

java.lang.Object
  extended by org.apache.xml.security.transforms.TransformSpi
      extended by 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.

Author:
Christian Geuer-Pollmann
See Also:
Base64

Field Summary
static String implementedTransformURI
          Field implementedTransformURI
 
Fields inherited from class org.apache.xml.security.transforms.TransformSpi
secureValidation
 
Constructor Summary
TransformBase64Decode()
           
 
Method Summary
protected  String engineGetURI()
          Method engineGetURI
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)
          Method enginePerformTransform
 
Methods inherited from class org.apache.xml.security.transforms.TransformSpi
enginePerformTransform
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

implementedTransformURI

public static final String implementedTransformURI
Field implementedTransformURI

See Also:
Constant Field Values
Constructor Detail

TransformBase64Decode

public TransformBase64Decode()
Method Detail

engineGetURI

protected String engineGetURI()
Method engineGetURI

Specified by:
engineGetURI in class TransformSpi
Returns:
the URI representation of Transformation algorithm

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   Transform transformObject)
                                            throws IOException,
                                                   CanonicalizationException,
                                                   TransformationException
Method enginePerformTransform

Overrides:
enginePerformTransform in class TransformSpi
Parameters:
input -
transformObject - the Transform object
Returns:
XMLSignatureInput as the result of transformation
Throws:
CanonicalizationException
IOException
TransformationException

enginePerformTransform

protected XMLSignatureInput enginePerformTransform(XMLSignatureInput input,
                                                   OutputStream os,
                                                   Transform transformObject)
                                            throws IOException,
                                                   CanonicalizationException,
                                                   TransformationException
Description copied from class: TransformSpi
The mega method which MUST be implemented by the Transformation Algorithm.

Overrides:
enginePerformTransform in class TransformSpi
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:
IOException
CanonicalizationException
TransformationException


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.