CanonicalizationMethod (Java Platform SE 8 ) (original) (raw)

• All Superinterfaces:
  AlgorithmMethod, Transform, XMLStructure

public interface CanonicalizationMethod
extends Transform
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:

A CanonicalizationMethod instance may be created by invoking the newCanonicalizationMethod method of the XMLSignatureFactory class.
Since:
1.6
See Also:
XMLSignatureFactory.newCanonicalizationMethod(String, C14NMethodParameterSpec)

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static String	EXCLUSIVE	The Exclusive Canonical XML (without comments) canonicalization method algorithm URI.
  static String	EXCLUSIVE_WITH_COMMENTS	The Exclusive Canonical XML with comments canonicalization method algorithm URI.
  static String	INCLUSIVE	The Canonical XML (without comments) canonicalization method algorithm URI.
  static String	INCLUSIVE_WITH_COMMENTS	The Canonical XML with comments canonicalization method algorithm URI.

     * ### Fields inherited from interface javax.xml.crypto.dsig.[Transform](../../../../javax/xml/crypto/dsig/Transform.html "interface in javax.xml.crypto.dsig")  
     `[BASE64](../../../../javax/xml/crypto/dsig/Transform.html#BASE64), [ENVELOPED](../../../../javax/xml/crypto/dsig/Transform.html#ENVELOPED), [XPATH](../../../../javax/xml/crypto/dsig/Transform.html#XPATH), [XPATH2](../../../../javax/xml/crypto/dsig/Transform.html#XPATH2), [XSLT](../../../../javax/xml/crypto/dsig/Transform.html#XSLT)`  

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  AlgorithmParameterSpec	getParameterSpec()	Returns the algorithm-specific input parameters associated with thisCanonicalizationMethod.

     * ### Methods inherited from interface javax.xml.crypto.dsig.[Transform](../../../../javax/xml/crypto/dsig/Transform.html "interface in javax.xml.crypto.dsig")  
     `[transform](../../../../javax/xml/crypto/dsig/Transform.html#transform-javax.xml.crypto.Data-javax.xml.crypto.XMLCryptoContext-), [transform](../../../../javax/xml/crypto/dsig/Transform.html#transform-javax.xml.crypto.Data-javax.xml.crypto.XMLCryptoContext-java.io.OutputStream-)`  
     * ### Methods inherited from interface javax.xml.crypto.[XMLStructure](../../../../javax/xml/crypto/XMLStructure.html "interface in javax.xml.crypto")  
     `[isFeatureSupported](../../../../javax/xml/crypto/XMLStructure.html#isFeatureSupported-java.lang.String-)`  
     * ### Methods inherited from interface javax.xml.crypto.[AlgorithmMethod](../../../../javax/xml/crypto/AlgorithmMethod.html "interface in javax.xml.crypto")  
     `[getAlgorithm](../../../../javax/xml/crypto/AlgorithmMethod.html#getAlgorithm--)`

• • Field Detail

     * #### INCLUSIVE  
     static final [String](../../../../java/lang/String.html "class in java.lang") INCLUSIVE  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.crypto.dsig.CanonicalizationMethod.INCLUSIVE)  
     * #### INCLUSIVE\_WITH\_COMMENTS  
     static final [String](../../../../java/lang/String.html "class in java.lang") INCLUSIVE_WITH_COMMENTS  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.crypto.dsig.CanonicalizationMethod.INCLUSIVE%5FWITH%5FCOMMENTS)  
     * #### EXCLUSIVE  
     static final [String](../../../../java/lang/String.html "class in java.lang") EXCLUSIVE  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.crypto.dsig.CanonicalizationMethod.EXCLUSIVE)  
     * #### EXCLUSIVE\_WITH\_COMMENTS  
     static final [String](../../../../java/lang/String.html "class in java.lang") EXCLUSIVE_WITH_COMMENTS  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.crypto.dsig.CanonicalizationMethod.EXCLUSIVE%5FWITH%5FCOMMENTS)  

  • Method Detail

    * #### getParameterSpec  
    [AlgorithmParameterSpec](../../../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec") getParameterSpec()  
    Returns the algorithm-specific input parameters associated with this`CanonicalizationMethod`.  
    The returned parameters can be typecast to a[C14NMethodParameterSpec](../../../../javax/xml/crypto/dsig/spec/C14NMethodParameterSpec.html "interface in javax.xml.crypto.dsig.spec") object.  
    Specified by:  
    `[getParameterSpec](../../../../javax/xml/crypto/AlgorithmMethod.html#getParameterSpec--)` in interface `[AlgorithmMethod](../../../../javax/xml/crypto/AlgorithmMethod.html "interface in javax.xml.crypto")`  
    Specified by:  
    `[getParameterSpec](../../../../javax/xml/crypto/dsig/Transform.html#getParameterSpec--)` in interface `[Transform](../../../../javax/xml/crypto/dsig/Transform.html "interface in javax.xml.crypto.dsig")`  
    Returns:  
    the algorithm-specific input parameters (may be`null` if not specified)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.