Top Description Fields Constructors Methods
org.jcp.xml.dsig.internal.dom

public Class DOMCanonicalizationMethod

extends DOMTransform
implements CanonicalizationMethod
Class Inheritance
All Implemented Interfaces
javax.xml.crypto.dsig.CanonicalizationMethod, javax.xml.crypto.dsig.Transform, javax.xml.crypto.AlgorithmMethod, javax.xml.crypto.XMLStructure
Imports
java.io.OutputStream, java.security.InvalidAlgorithmParameterException, .Provider, java.security.spec.AlgorithmParameterSpec, java.util.Collections, .HashSet, .Set, javax.xml.crypto.Data, .MarshalException, .XMLCryptoContext, javax.xml.crypto.dsig.CanonicalizationMethod, .TransformException, .TransformService, org.w3c.dom.Element

DOM-based abstract implementation of CanonicalizationMethod.

Field Summary

Modifier and TypeField and Description
private static final Set<String>
Inherited from org.jcp.xml.dsig.internal.dom.DOMTransform:
spi

Constructor Summary

AccessConstructor and Description
public
DOMCanonicalizationMethod(TransformService
TransformService
spi
)

Creates a DOMCanonicalizationMethod.

public
DOMCanonicalizationMethod(Element
a CanonicalizationMethod element
cmElem
,
XMLCryptoContext context, Provider provider)

Creates a DOMCanonicalizationMethod from an element.

Method Summary

Modifier and TypeMethod and Description
public Data

Returns:

the canonicalized data
canonicalize
(Data
the data to be canonicalized
data
,
XMLCryptoContext
the XMLCryptoContext containing additional context (may be null if not applicable)
xc
)

Canonicalizes the specified data using the underlying canonicalization algorithm.

public Data
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides org.jcp.xml.dsig.internal.dom.DOMTransform.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides org.jcp.xml.dsig.internal.dom.DOMTransform.hashCode.

Returns a hash code value for this object.
private static boolean
Inherited from org.jcp.xml.dsig.internal.dom.DOMTransform:
getAlgorithmgetParameterSpecmarshaltransformtransformtransform

Field Detail

C14N_ALGORITHMSback to summary
private static final Set<String> C14N_ALGORITHMS

Constructor Detail

DOMCanonicalizationMethodback to summary
public DOMCanonicalizationMethod(TransformService spi) throws InvalidAlgorithmParameterException

Creates a DOMCanonicalizationMethod.

Parameters
spi:TransformService

TransformService

DOMCanonicalizationMethodback to summary
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:Element

a CanonicalizationMethod element

Method Detail

canonicalizeback to summary
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:Data

the data to be canonicalized

xc:XMLCryptoContext

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

Returns:Data

the canonicalized data

Exceptions
TransformException:
if an unexpected error occurs while canonicalizing the data
NullPointerException:
if data is null
canonicalizeback to summary
public Data canonicalize(Data data, XMLCryptoContext xc, OutputStream os) throws TransformException
equalsback to summary
public boolean equals(Object o)

Overrides org.jcp.xml.dsig.internal.dom.DOMTransform.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides org.jcp.xml.dsig.internal.dom.DOMTransform.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isC14Nalgback to summary
private static boolean isC14Nalg(String alg)