- All Superinterfaces:
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
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));
-
Method Summary
Modifier and TypeMethodDescriptiondereference(XMLCryptoContext context) Dereferences theKeyInfoinformation referenced by thisRetrievalMethodand applies the specifiedTransforms.getURI()Returns the URI of the referencedKeyInfoinformation.Methods declared in interface javax.xml.crypto.URIReference
getTypeMethods declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
Method Details
-
getTransforms
- Returns:
- an unmodifiable list of
Transformobjects (may be empty but nevernull).
-
getURI
String getURI()Returns the URI of the referencedKeyInfoinformation.- Specified by:
getURIin interfaceURIReference- Returns:
- the URI of the referenced
KeyInfoinformation in RFC 2396 format (nevernull)
-
dereference
Dereferences theKeyInfoinformation referenced by thisRetrievalMethodand applies the specifiedTransforms.- Parameters:
context- anXMLCryptoContextthat may contain additional useful information for dereferencing the URI. The context'sbaseURIanddereferencerparameters (if specified) are used to resolve and dereference thisRetrievalMethod- Returns:
- a
Dataobject representing the raw contents of theKeyInfoinformation referenced by thisRetrievalMethod. It is the caller's responsibility to convert the returned data to an appropriateKeyInfoobject. - Throws:
NullPointerException- ifcontextisnullURIReferenceException- if there is an error while dereferencing
-