org.apache.jcp.xml.dsig.internal.dom

Class DOMExcC14NMethod

java.lang.Object

javax.xml.crypto.dsig.TransformService

org.apache.jcp.xml.dsig.internal.dom.ApacheCanonicalizer

org.apache.jcp.xml.dsig.internal.dom.DOMExcC14NMethod

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

public final class DOMExcC14NMethod
extends ApacheCanonicalizer

DOM-based implementation of CanonicalizationMethod for Exclusive Canonical XML algorithm (with or without comments). Uses Apache XML-Sec Canonicalizer.

Author:

Sean Mullan

Field Summary

Fields inherited from class org.apache.jcp.xml.dsig.internal.dom.ApacheCanonicalizer

apacheCanonicalizer, inclusiveNamespaces, ownerDoc, params, transformElem

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

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Constructor and Description
DOMExcC14NMethod()

Method Summary

Modifier and Type	Method and Description
String	getParamsNSURI()
void	init(TransformParameterSpec params) Initializes this TransformService with the specified parameters.
void	init(XMLStructure parent, XMLCryptoContext context) Initializes this TransformService with the specified parameters and document context.
void	marshalParams(XMLStructure parent, XMLCryptoContext context) Marshals the algorithm-specific parameters.
Data	transform(Data data, XMLCryptoContext xc) Transforms the specified data using the underlying transform algorithm.

Methods inherited from class org.apache.jcp.xml.dsig.internal.dom.ApacheCanonicalizer

canonicalize, canonicalize, getParameterSpec, isFeatureSupported, 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

DOMExcC14NMethod

public DOMExcC14NMethod()

Method Detail

init

public void init(TransformParameterSpec params)
          throws InvalidAlgorithmParameterException

Description copied from class: TransformService

Initializes this TransformService with the specified parameters.

If the parameters exist in XML form, the TransformService.init(XMLStructure, XMLCryptoContext) method should be used to initialize the TransformService.

Specified by:

init in class TransformService

Parameters:

params - the algorithm parameters (may be null if not required or optional)

Throws:

InvalidAlgorithmParameterException - if the specified parameters are invalid for this algorithm

init

public void init(XMLStructure parent,
                 XMLCryptoContext context)
          throws InvalidAlgorithmParameterException

Description copied from class: TransformService

Initializes this TransformService with the specified parameters and document context.

Overrides:

init in class ApacheCanonicalizer

Parameters:

parent - a mechanism-specific structure containing the parent structure

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

Throws:

InvalidAlgorithmParameterException - if the specified parameters are invalid for this algorithm

marshalParams

public void marshalParams(XMLStructure parent,
                          XMLCryptoContext context)
                   throws MarshalException

Description copied from class: TransformService

Marshals the algorithm-specific parameters. If there are no parameters to be marshalled, this method returns without throwing an exception.

Overrides:

marshalParams in class ApacheCanonicalizer

Parameters:

parent - a mechanism-specific structure containing the parent node that the marshalled parameters should be appended to

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

Throws:

MarshalException - if the parameters cannot be marshalled

getParamsNSURI

public String getParamsNSURI()

transform

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

Description copied from interface: Transform

Transforms the specified data using the underlying transform algorithm.

Parameters:

data - the data to be transformed

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