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.


javax.xml.crypto.dsig.keyinfo
interface RetrievalMethod

All Superinterfaces:
XMLStructure

public interface RetrievalMethod
extends XMLStructure

A representation of the XML RetrievalMethod element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. A RetrievalMethod object is used to convey a reference to KeyInfo information that is stored at another location. The XML schema definition is defined as:

   <element name="RetrievalMethod" type="ds:RetrievalMethodType"/>
   <complexType name="RetrievalMethodType">
     <sequence>
       <element name="Transforms" type="ds:TransformsType" minOccurs="0"/> 
     </sequence>  
     <attribute name="URI" type="anyURI"/>
     <attribute name="Type" type="anyURI" use="optional"/>
   </complexType>
 
A RetrievalMethod instance may be created by invoking one of the {@link KeyInfoFactory#newRetrievalMethod newRetrievalMethod} methods of the {@link KeyInfoFactory} class, and passing it the URI identifying the location of the KeyInfo, an optional type URI identifying the type of KeyInfo, and an optional list of {@link Transform}s; for example:
   KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
   RetrievalMethod rm = factory.newRetrievalMethod
      ("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64));
 


Method Summary
 Data

          Dereferences the KeyInfo information referenced by this RetrievalMethod and applies the specified Transforms.
 List

          Returns an java.util.Collections.unmodifiableList of javax.xml.crypto.dsig.Transforms of this RetrievalMethod.
 String

          Returns the URI of the referenced KeyInfo information.
 
Methods inherited from class javax.xml.crypto.XMLStructure
isFeatureSupported
 

Method Detail

dereference

public Data dereference(XMLCryptoContext context)
                 throws URIReferenceException
Dereferences the KeyInfo information referenced by this RetrievalMethod and applies the specified Transforms.

Parameters:
context - an XMLCryptoContext that may contain additional useful information for dereferencing the URI. The context's baseURI and dereferencer parameters (if specified) are used to resolve and dereference this RetrievalMethod
Returns:
a Data object representing the raw contents of the KeyInfo information referenced by this RetrievalMethod. It is the caller's responsibility to convert the returned data to an appropriate KeyInfo object.
Throws:
URIReferenceException - if there is an error while dereferencing

getTransforms

public List getTransforms()
Returns an {@link java.util.Collections#unmodifiableList unmodifiable list} of {@link Transform}s of this RetrievalMethod.

Returns:
an unmodifiable list of Transform objects (may be empty but never null).

getURI

public String getURI()
Returns the URI of the referenced KeyInfo information.

Returns:
the URI of the referenced KeyInfo information in RFC 2396 format (never null)


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.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.