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

public Interface RetrievalMethod

extends URIReference, XMLStructure
Known Direct Implementers
org.jcp.xml.dsig.internal.dom.DOMRetrievalMethod
Imports
javax.xml.crypto.Data, .URIReference, .URIReferenceException, .XMLCryptoContext, .XMLStructure, javax.xml.crypto.dsig.Transform, java.util.List
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 newRetrievalMethod 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));
Authors
Sean Mullan, JSR 105 Expert Group
Since
1.6
See Also
KeyInfoFactory#newRetrievalMethod(String), KeyInfoFactory#newRetrievalMethod(String, String, List)

Method Summary

Modifier and TypeMethod and Description
public Data

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.
dereference(XMLCryptoContext
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
context)

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

public List<Transform>

Returns:

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

Returns an unmodifiable list of Transforms of this RetrievalMethod.

public String

Returns:

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

Redeclares javax.xml.crypto.URIReference.getURI.

Returns the URI of the referenced KeyInfo information.

Inherited from javax.xml.crypto.URIReference:
getType
Inherited from javax.xml.crypto.XMLStructure:
isFeatureSupported

Method Detail

dereferenceback to summary
public Data dereference(XMLCryptoContext context) throws URIReferenceException

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

Parameters
context:XMLCryptoContext

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:Data

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.

Exceptions
URIReferenceException:
if there is an error while dereferencing
NullPointerException:
if context is null
getTransformsback to summary
public List<Transform> getTransforms()

Returns an unmodifiable list of Transforms of this RetrievalMethod.

Returns:List<Transform>

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

getURIback to summary
public String getURI()

Redeclares javax.xml.crypto.URIReference.getURI.

Returns the URI of the referenced KeyInfo information.

Returns:String

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