This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.crypto.dsig.keyinfo
interface KeyInfo

All Superinterfaces:
XMLStructure

public interface KeyInfo
extends 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 {@link 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 {@link KeyInfoFactory#newKeyInfo newKeyInfo} methods of the {@link 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 {@link #marshal marshal} method.


Method Summary
 List

          Returns an java.util.Collections.unmodifiableList containing the key information.
 String

          Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.
 void

          Marshals the key info to XML.
 
Methods inherited from class javax.xml.crypto.XMLStructure
isFeatureSupported
 

Method Detail

getContent

public List getContent()
Returns an {@link java.util.Collections#unmodifiableList unmodifiable list} containing the key information. Each entry of the list is an {@link 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 {@link javax.xml.crypto.dsig.keyinfo.X509Data}).

Returns:
an unmodifiable list of one or more XMLStructures in this KeyInfo. Never returns null or an empty list.

getId

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

Returns:
the Id attribute of this KeyInfo (may be null if not specified)

marshal

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

Parameters:
parent - a mechanism-specific structure containing the parent node that the marshalled key info will be appended to
context - the XMLCryptoContext containing additional context (may be null if not applicable)
Throws:
MarshalException - if the key info cannot be marshalled


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.