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

java.lang.Object
  org.jcp.xml.dsig.internal.dom.DOMStructure
      org.jcp.xml.dsig.internal.dom.DOMTransform
          org.jcp.xml.dsig.internal.dom.DOMCanonicalizationMethod

All Implemented Interfaces:

AlgorithmMethod, CanonicalizationMethod, Transform, XMLStructure

public class DOMCanonicalizationMethod
extends DOMTransform
implements CanonicalizationMethod

Disabled: no SafeJ information.

DOM-based abstract implementation of CanonicalizationMethod.

Field Summary

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

spi

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

EXCLUSIVE, EXCLUSIVE_WITH_COMMENTS, INCLUSIVE, INCLUSIVE_WITH_COMMENTS

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

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

DOMCanonicalizationMethod(org.w3c.dom.Element cmElem, XMLCryptoContext context, Provider provider)
Creates a DOMCanonicalizationMethod from an element.

DOMCanonicalizationMethod(TransformService spi)
Creates a DOMCanonicalizationMethod.

Method Summary

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) Indicates whether some other object is "equal to" this one.

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

getAlgorithm, getParameterSpec, marshal, transform, transform

Methods inherited from class org.jcp.xml.dsig.internal.dom.DOMStructure

isFeatureSupported

Methods inherited from class java.lang.Object

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

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

getParameterSpec

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

transform, transform

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Methods inherited from interface javax.xml.crypto.AlgorithmMethod

getAlgorithm

Constructor Detail

DOMCanonicalizationMethod

public DOMCanonicalizationMethod(TransformService spi)
                          throws InvalidAlgorithmParameterException

Class is disabled.

Creates a DOMCanonicalizationMethod.

Parameters:

spi - TransformService

Throws:

InvalidAlgorithmParameterException

DOMCanonicalizationMethod

public DOMCanonicalizationMethod(org.w3c.dom.Element cmElem,
                                 XMLCryptoContext context,
                                 Provider provider)
                          throws MarshalException

Class is disabled.

Creates a DOMCanonicalizationMethod from an element. This ctor invokes the abstract unmarshalParams method to unmarshal any algorithm-specific input parameters.

Parameters:

cmElem - a CanonicalizationMethod element

Throws:

MarshalException

Method Detail

canonicalize

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

Class is disabled.

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

Class is disabled.

Throws:

TransformException

equals

public boolean equals(Object o)

Enabled. assumes no non-deterministic equals methods in libraries

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class DOMTransform

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap