compact3
javax.xml.crypto.dsig.keyinfo
Interface RetrievalMethod
-
- All Superinterfaces:
- URIReference, XMLStructure
public interface RetrievalMethod extends URIReference, XMLStructure
A representation of the XMLRetrievalMethodelement as defined in the W3C Recommendation for XML-Signature Syntax and Processing. ARetrievalMethodobject is used to convey a reference toKeyInfoinformation 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>ARetrievalMethodinstance may be created by invoking one of thenewRetrievalMethodmethods of theKeyInfoFactoryclass, and passing it the URI identifying the location of the KeyInfo, an optional type URI identifying the type of KeyInfo, and an optional list ofTransforms; for example:KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM"); RetrievalMethod rm = factory.newRetrievalMethod ("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64));
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Datadereference(XMLCryptoContext context)Dereferences theKeyInfoinformation referenced by thisRetrievalMethodand applies the specifiedTransforms.ListgetTransforms()StringgetURI()Returns the URI of the referencedKeyInfoinformation.-
Methods inherited from interface javax.xml.crypto.URIReference
getType
-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Method Detail
getTransforms
List 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
Data dereference(XMLCryptoContext context) throws URIReferenceException
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- ifcontextisnull -
URIReferenceException- 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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
