public interface

CanonicalizationMethod

implements Transform
javax.xml.crypto.dsig.CanonicalizationMethod

Class Overview

A representation of the XML CanonicalizationMethod element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. The XML Schema Definition is defined as:

   <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/>
     <complexType name="CanonicalizationMethodType" mixed="true">
       <sequence>
         <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>
           <!-- (0,unbounded) elements from (1,1) namespace -->
       </sequence>
       <attribute name="Algorithm" type="anyURI" use="required"/>
     </complexType>
 
A CanonicalizationMethod instance may be created by invoking the newCanonicalizationMethod method of the XMLSignatureFactory class.

Summary

Constants
String EXCLUSIVE The Exclusive Canonical XML (without comments) canonicalization method algorithm URI.
String EXCLUSIVE_WITH_COMMENTS The Exclusive Canonical XML with comments canonicalization method algorithm URI.
String INCLUSIVE The Canonical XML (without comments) canonicalization method algorithm URI.
String INCLUSIVE_WITH_COMMENTS The Canonical XML with comments canonicalization method algorithm URI.
[Expand]
Inherited Constants
From interface javax.xml.crypto.dsig.Transform
Public Methods
abstract AlgorithmParameterSpec getParameterSpec()
Returns the algorithm-specific input parameters associated with this CanonicalizationMethod.
[Expand]
Inherited Methods
From interface javax.xml.crypto.AlgorithmMethod
From interface javax.xml.crypto.XMLStructure
From interface javax.xml.crypto.dsig.Transform

Constants

public static final String EXCLUSIVE

The Exclusive Canonical XML (without comments) canonicalization method algorithm URI.

Constant Value: "http://www.w3.org/2001/10/xml-exc-c14n#"

public static final String EXCLUSIVE_WITH_COMMENTS

The Exclusive Canonical XML with comments canonicalization method algorithm URI.

Constant Value: "http://www.w3.org/2001/10/xml-exc-c14n#WithComments"

public static final String INCLUSIVE

The Canonical XML (without comments) canonicalization method algorithm URI.

Constant Value: "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"

public static final String INCLUSIVE_WITH_COMMENTS

The Canonical XML with comments canonicalization method algorithm URI.

Constant Value: "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"

Public Methods

public abstract AlgorithmParameterSpec getParameterSpec ()

Returns the algorithm-specific input parameters associated with this CanonicalizationMethod.

The returned parameters can be typecast to a C14NMethodParameterSpec object.

Returns
  • the algorithm-specific input parameters (may be null if not specified)