javax.xml.crypto.dsig.keyinfo: public interface: KeyInfo

javax.xml.crypto.dsig.keyinfo
public interface: KeyInfo [javadoc | source]

All Implemented Interfaces:
XMLStructure

A representation of the XML KeyInfo element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. A KeyInfo contains a list of XMLStructure s, each of which contain information that enables the recipient(s) to obtain the key needed to validate an XML signature. The XML Schema Definition is defined as:

<element name="KeyInfo" type="ds:KeyInfoType"/>
<complexType name="KeyInfoType" mixed="true">
  <choice maxOccurs="unbounded">
    <element ref="ds:KeyName"/>
    <element ref="ds:KeyValue"/>
    <element ref="ds:RetrievalMethod"/>
    <element ref="ds:X509Data"/>
    <element ref="ds:PGPData"/>
    <element ref="ds:SPKIData"/>
    <element ref="ds:MgmtData"/>
    <any processContents="lax" namespace="##other"/>
    <!-- (1,1) elements from (0,unbounded) namespaces -->
  </choice>
  <attribute name="Id" type="ID" use="optional"/>
</complexType>

A KeyInfo instance may be created by invoking one of the newKeyInfo methods of the KeyInfoFactory class, and passing it a list of one or more XMLStructures and an optional id parameter; for example:

  KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
  KeyInfo keyInfo = factory.newKeyInfo
     (Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));

KeyInfo objects can also be marshalled to XML by invoking the marshal method.

Also see:

KeyInfoFactory#newKeyInfo(List)

KeyInfoFactory#newKeyInfo(List, String)

author: Sean - Mullan

author: JSR - 105 Expert Group

since: 1.6 -

Method from javax.xml.crypto.dsig.keyinfo.KeyInfo Summary:
getContent, getId, marshal

Method from javax.xml.crypto.dsig.keyinfo.KeyInfo Detail:
public List getContent() Returns an unmodifiable list containing the key information. Each entry of the list is an XMLStructure . If there is a public subclass representing the type of `XMLStructure`, it is returned as an instance of that class (ex: an `X509Data` element would be returned as an instance of javax.xml.crypto.dsig.keyinfo.X509Data ).
public String getId() Return the optional Id attribute of this `KeyInfo`, which may be useful for referencing this `KeyInfo` from other XML structures.
public void marshal(XMLStructure parent, XMLCryptoContext context) throws MarshalException Marshals the key info to XML.

Method from javax.xml.crypto.dsig.keyinfo.KeyInfo Detail:

 public List getContent()Returns an  unmodifiable
list  containing the key information. Each entry of the list is
an XMLStructure .

If there is a public subclass representing the type of
XMLStructure, it is returned as an instance of that
class (ex: an X509Data element would be returned as an
instance of javax.xml.crypto.dsig.keyinfo.X509Data ).

 public String getId()Return the optional Id attribute of this KeyInfo, which
may be useful for referencing this KeyInfo from other
XML structures.

 public  void marshal(XMLStructure parent,
    XMLCryptoContext context) throws MarshalExceptionMarshals the key info to XML.