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

• All Superinterfaces:
  URIReference, XMLStructure

public interface RetrievalMethod
extends URIReference, 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 toKeyInfo information that is stored at another location. The XML schema definition is defined as:

A RetrievalMethod instance may be created by invoking one of thenewRetrievalMethod methods of the 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 Transforms; for example:
KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
RetrievalMethod rm = factory.newRetrievalMethod
("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64));

Since:
1.6
See Also:
KeyInfoFactory.newRetrievalMethod(String), KeyInfoFactory.newRetrievalMethod(String, String, List)

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  Data	dereference(XMLCryptoContext context)	Dereferences the KeyInfo information referenced by thisRetrievalMethod and applies the specifiedTransforms.
  List	getTransforms()	Returns an unmodifiable list of Transforms of this RetrievalMethod.
  String	getURI()	Returns the URI of the referenced KeyInfo information.

     * ### Methods inherited from interface javax.xml.crypto.[URIReference](../../../../../javax/xml/crypto/URIReference.html "interface in javax.xml.crypto")  
     `[getType](../../../../../javax/xml/crypto/URIReference.html#getType--)`  
     * ### 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-)`

• • Method Detail

     * #### getTransforms  
     [List](../../../../../java/util/List.html "interface in java.util") getTransforms()  
     Returns:  
     an unmodifiable list of `Transform` objects (may be empty but never `null`).  
     * #### getURI  
     [String](../../../../../java/lang/String.html "class in java.lang") getURI()  
     Returns the URI of the referenced `KeyInfo` information.  
     Specified by:  
     `[getURI](../../../../../javax/xml/crypto/URIReference.html#getURI--)` in interface `[URIReference](../../../../../javax/xml/crypto/URIReference.html "interface in javax.xml.crypto")`  
     Returns:  
     the URI of the referenced `KeyInfo` information in RFC 2396 format (never `null`)  
     * #### dereference  
     [Data](../../../../../javax/xml/crypto/Data.html "interface in javax.xml.crypto") dereference([XMLCryptoContext](../../../../../javax/xml/crypto/XMLCryptoContext.html "interface in javax.xml.crypto") context)  
               throws [URIReferenceException](../../../../../javax/xml/crypto/URIReferenceException.html "class in javax.xml.crypto")  
     Dereferences the `KeyInfo` information referenced by this`RetrievalMethod` and applies the specified`Transform`s.  
     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:  
     `[NullPointerException](../../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `context` is `null`  
     `[URIReferenceException](../../../../../javax/xml/crypto/URIReferenceException.html "class in javax.xml.crypto")` \- if there is an error while dereferencing

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.