CanonicalizationMethod (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.crypto.dsig
interface CanonicalizationMethod

All Superinterfaces:: AlgorithmMethod, Transform

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:

   <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 {@link XMLSignatureFactory#newCanonicalizationMethod newCanonicalizationMethod} method of the {@link XMLSignatureFactory} class.

Field Summary
`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 class javax.xml.crypto.dsig.Transform
`BASE64, ENVELOPED, XPATH, XPATH2, XSLT`

Method Summary
`AlgorithmParameterSpec`	`getParameterSpec()` Returns the algorithm-specific input parameters associated with this `CanonicalizationMethod`.

Methods inherited from class javax.xml.crypto.dsig.Transform
`getParameterSpec, transform, transform`

Methods inherited from class javax.xml.crypto.AlgorithmMethod
`getAlgorithm, getParameterSpec`

Field Detail

EXCLUSIVE

public static final String EXCLUSIVE

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

EXCLUSIVE_WITH_COMMENTS

public static final String EXCLUSIVE_WITH_COMMENTS

The Exclusive Canonical XML with comments canonicalization method algorithm URI.

INCLUSIVE

public static final String INCLUSIVE

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

INCLUSIVE_WITH_COMMENTS

public static final String INCLUSIVE_WITH_COMMENTS

The Canonical XML with comments canonicalization method algorithm URI.

Method Detail

getParameterSpec

public AlgorithmParameterSpec getParameterSpec()

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

The returned parameters can be typecast to a {@link C14NMethodParameterSpec} object.

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