FileDocCategorySizeDatePackage
RetrievalMethod.javaAPI DocJava SE 6 API3776Tue Jun 10 00:27:06 BST 2008javax.xml.crypto.dsig.keyinfo

RetrievalMethod

public interface RetrievalMethod implements 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 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));
author
Sean Mullan
author
JSR 105 Expert Group
since
1.6
see
KeyInfoFactory#newRetrievalMethod(String)
see
KeyInfoFactory#newRetrievalMethod(String, String, List)

Fields Summary
Constructors Summary
Methods Summary
public javax.xml.crypto.Datadereference(javax.xml.crypto.XMLCryptoContext context)
Dereferences the KeyInfo information referenced by this RetrievalMethod and applies the specified Transforms.

param
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
return
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 if context is null
throws
URIReferenceException if there is an error while dereferencing

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

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

public java.lang.StringgetURI()
Returns the URI of the referenced KeyInfo information.

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