- 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 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 Transform
s; for example:
KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM"); RetrievalMethod rm = factory.newRetrievalMethod ("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64));
-
Method Summary
Modifier and Type Method Description Data
dereference(XMLCryptoContext context)
Dereferences theKeyInfo
information referenced by thisRetrievalMethod
and applies the specifiedTransform
s.List<Transform>
getTransforms()
String
getURI()
Returns the URI of the referencedKeyInfo
information.Methods declared in interface javax.xml.crypto.URIReference
getType
Methods declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
Method Details
-
getTransforms
- Returns:
- an unmodifiable list of
Transform
objects (may be empty but nevernull
).
-
getURI
String getURI()Returns the URI of the referencedKeyInfo
information.- Specified by:
getURI
in interfaceURIReference
- Returns:
- the URI of the referenced
KeyInfo
information in RFC 2396 format (nevernull
)
-
dereference
Dereferences theKeyInfo
information referenced by thisRetrievalMethod
and applies the specifiedTransform
s.- Parameters:
context
- anXMLCryptoContext
that may contain additional useful information for dereferencing the URI. The context'sbaseURI
anddereferencer
parameters (if specified) are used to resolve and dereference thisRetrievalMethod
- Returns:
- a
Data
object representing the raw contents of theKeyInfo
information referenced by thisRetrievalMethod
. It is the caller's responsibility to convert the returned data to an appropriateKeyInfo
object. - Throws:
NullPointerException
- ifcontext
isnull
URIReferenceException
- if there is an error while dereferencing
-