compact3

javax.xml.crypto.dsig.keyinfo

Interface KeyInfo

All Superinterfaces:

XMLStructure

public interface KeyInfo
extends XMLStructure

W3C Recommendation for XML-Signature Syntax and Processing中定义的XML KeyInfo元素的表示 。 甲KeyInfo包含的列表XMLStructure个 S，其中的每一个包含能够使接收者（一个或多个），以获得验证XML签名所需的关键信息。 XML模式定义定义为：

  <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> 

可以通过调用KeyInfoFactory类的newKeyInfo方法之一并传递一个或多个XMLStructure和可选的id参数的列表来创建KeyInfo实例。 例如：

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

KeyInfo对象也可以通过调用marshal方法编组到XML。

从以下版本开始：

1.6

另请参见：

KeyInfoFactory.newKeyInfo(List) ， KeyInfoFactory.newKeyInfo(List, String)

方法摘要

Modifier and Type	Method and Description
List	getContent() 返回一个 unmodifiable list包含关键信息。
String	getId() 返回此 KeyInfo的可选Id属性，这对于从其他XML结构引用此 KeyInfo可能很有用。
void	marshal(XMLStructure parent, XMLCryptoContext context) 将关键信息传达给XML。

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

方法详细信息

getContent

List getContent()

返回一个unmodifiable list包含关键信息。 列表的每个条目都是XMLStructure 。

如果有一个表示类型为XMLStructure的公共子类，则作为该类的实例返回（例如： X509Data元素将作为X509Data的实例返回）。

结果

一个或多个可修改的列表XMLStructure S IN此KeyInfo 。 永远不会返回null或空列表。

getId

String getId()

返回此 KeyInfo的可选Id属性，这对于从其他XML结构引用此 KeyInfo可能很有用。

结果

此的Id属性 KeyInfo （可以是 null如果未指定）

marshal

void marshal(XMLStructure parent,
             XMLCryptoContext context)
      throws MarshalException

将关键信息传达给XML。

参数

parent - 一个机制特定的结构，包含编组的密钥信息将被附加到的父节点

context - 包含附加上下文的 XMLCryptoContext （如果不适用，可以为null）

异常

ClassCastException - 如果 parent或 context的类型与此关键信息不兼容

MarshalException - 如果密钥信息无法编组

NullPointerException - 如果 parent是 null