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

Class DOMCanonicalizationMethod

java.lang.Object

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

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

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

All Implemented Interfaces:

AlgorithmMethod, CanonicalizationMethod, Transform, XMLStructure

public class DOMCanonicalizationMethod
extends DOMTransform
implements CanonicalizationMethod

DOM-based abstract implementation of CanonicalizationMethod.

Author:

Sean Mullan

Field Summary

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

EXCLUSIVE, EXCLUSIVE_WITH_COMMENTS, INCLUSIVE, INCLUSIVE_WITH_COMMENTS

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

spi

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

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Constructor	Description
DOMCanonicalizationMethod(TransformService spi)	Creates a DOMCanonicalizationMethod.
DOMCanonicalizationMethod(Element cmElem, XMLCryptoContext context, Provider provider)	Creates a DOMCanonicalizationMethod from an element.

Method Summary

Modifier and Type	Method	Description
Data	canonicalize(Data data, XMLCryptoContext xc)	Canonicalizes the specified data using the underlying canonicalization algorithm.
Data	canonicalize(Data data, XMLCryptoContext xc, OutputStream os)
boolean	equals(Object o)
int	hashCode()

Methods inherited from interface javax.xml.crypto.AlgorithmMethod

getAlgorithm

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

isFeatureSupported, textOfNode

Methods inherited from interface javax.xml.crypto.dsig.CanonicalizationMethod

getParameterSpec

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

getAlgorithm, getParameterSpec, marshal, transform, transform

Methods inherited from class java.lang.Object

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

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

transform, transform

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Constructor Detail

DOMCanonicalizationMethod

public DOMCanonicalizationMethod(TransformService spi)
                          throws InvalidAlgorithmParameterException

Creates a DOMCanonicalizationMethod.

Parameters:

spi - TransformService

Throws:

InvalidAlgorithmParameterException

DOMCanonicalizationMethod

public DOMCanonicalizationMethod(Element cmElem,
                                 XMLCryptoContext context,
                                 Provider provider)
                          throws MarshalException

Creates a DOMCanonicalizationMethod from an element. It unmarshals any algorithm-specific input parameters.

Parameters:

cmElem - a CanonicalizationMethod element

Throws:

MarshalException

Method Detail

canonicalize

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

Canonicalizes the specified data using the underlying canonicalization algorithm. This is a convenience method that is equivalent to invoking the transform method.

Parameters:

data - the data to be canonicalized

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

Returns:

the canonicalized data

Throws:

NullPointerException - if data is null

TransformException - if an unexpected error occurs while canonicalizing the data

canonicalize

public Data canonicalize(Data data,
                         XMLCryptoContext xc,
                         OutputStream os)
                  throws TransformException

Throws:

TransformException

equals

public boolean equals(Object o)

Overrides:

equals in class DOMTransform

hashCode

public int hashCode()

Overrides:

hashCode in class DOMTransform