APIdia Launch Partner
Top Description Fields Methods
javax.xml.crypto.dsig

public Interface CanonicalizationMethod

extends Transform
Known Direct Implementers
org.jcp.xml.dsig.internal.dom.DOMCanonicalizationMethod
Imports
java.security.spec.AlgorithmParameterSpec, javax.xml.crypto.dsig.spec.C14NMethodParameterSpec
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.
Authors
Sean Mullan, JSR 105 Expert Group
Since
1.6
See Also
XMLSignatureFactory#newCanonicalizationMethod(String, C14NMethodParameterSpec)

Field Summary

Modifier and TypeField and Description
public static final String
EXCLUSIVE

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

public static final String
EXCLUSIVE_WITH_COMMENTS

The Exclusive Canonical XML with comments canonicalization method algorithm URI.

public static final String
INCLUSIVE

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

public static final String
INCLUSIVE_11

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

public static final String
INCLUSIVE_11_WITH_COMMENTS

The Canonical XML 1.1 with comments canonicalization method algorithm URI.

public static final String
INCLUSIVE_WITH_COMMENTS

The Canonical XML with comments canonicalization method algorithm URI.

Inherited from javax.xml.crypto.dsig.Transform:
BASE64ENVELOPEDXPATHXPATH2XSLT

Method Summary

Modifier and TypeMethod and Description
public AlgorithmParameterSpec

Returns:

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

Redeclares javax.xml.crypto.dsig.Transform.getParameterSpec.

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

Inherited from javax.xml.crypto.dsig.Transform:
transformtransform

Field Detail

EXCLUSIVEback to summary
public static final String EXCLUSIVE

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

EXCLUSIVE_WITH_COMMENTSback to summary
public static final String EXCLUSIVE_WITH_COMMENTS

The Exclusive Canonical XML with comments canonicalization method algorithm URI.

INCLUSIVEback to summary
public static final String INCLUSIVE

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

INCLUSIVE_11back to summary
public static final String INCLUSIVE_11

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

Since
13
INCLUSIVE_11_WITH_COMMENTSback to summary
public static final String INCLUSIVE_11_WITH_COMMENTS

The Canonical XML 1.1 with comments canonicalization method algorithm URI.

Since
13
INCLUSIVE_WITH_COMMENTSback to summary
public static final String INCLUSIVE_WITH_COMMENTS

The Canonical XML with comments canonicalization method algorithm URI.

Method Detail

getParameterSpecback to summary
public AlgorithmParameterSpec getParameterSpec()

Redeclares javax.xml.crypto.dsig.Transform.getParameterSpec.

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

The returned parameters can be typecast to a C14NMethodParameterSpec object.

Returns:AlgorithmParameterSpec

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