| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RetrievalMethod extends 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));
Method Summary | |
---|---|
Data |
dereference(XMLCryptoContext context) Dereferences the KeyInfo information referenced by this
RetrievalMethod and applies the specified
Transform s.
|
List |
Returns an java.util.Collections.unmodifiableList of javax.xml.crypto.dsig.Transforms of this RetrievalMethod .
|
String |
getURI() Returns the URI of the referenced KeyInfo information.
|
Methods inherited from class javax.xml.crypto.XMLStructure |
---|
isFeatureSupported |
Method Detail |
---|
public Data dereference(XMLCryptoContext context) throws URIReferenceException
KeyInfo
information referenced by this
RetrievalMethod
and applies the specified
Transform
s.
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
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.URIReferenceException
- if there is an error while dereferencingpublic List getTransforms()
RetrievalMethod
.
Transform
objects (may be
empty but never null
).public String getURI()
KeyInfo
information.
KeyInfo
information in
RFC 2396 format (never null
)
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |