iaik.xml.crypto.alg.transform

Class Base64TransformService

java.lang.Object

javax.xml.crypto.dsig.TransformService

iaik.xml.crypto.alg.transform.TransformServiceImpl

iaik.xml.crypto.alg.transform.Base64TransformService

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

public class Base64TransformService
extends TransformServiceImpl

This TransformService implements the Base64 transform (http://www.w3.org/2000/09/xmldsig#base64) as specified by the W3C recommendation XML-Signature Syntax and Processing.

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.

Supported algorithm parameter:

• none (null)

Transform result:

• 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
Base64TransformService()

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

Base64TransformService

public Base64TransformService()

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:

Transform.getParameterSpec()

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)