201 lines
10 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
compact3
</div>
<div class="subTitle">
javax.xml.crypto.dsig.keyinfo
</div>
<h2 class="title" title="Interface KeyInfo">Interface KeyInfo</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Superinterfaces:
</dt>
<dd>
<span><a href="../../../../../javax/xml/crypto/XMLStructure.html" title="javax.xml.crypto中的接口">XMLStructure</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public interface <span class="typeNameLabel">KeyInfo</span>
extends <a href="../../../../../javax/xml/crypto/XMLStructure.html" title="interface in javax.xml.crypto">XMLStructure</a></pre>
<div class="block">
<span>W3C Recommendation for XML-Signature Syntax and Processing中定义的XML <code>KeyInfo</code>元素的<a href="http://www.w3.org/TR/xmldsig-core/">表示</a></span>
<span><code>KeyInfo</code>包含的列表<a href="../../../../../javax/xml/crypto/XMLStructure.html" title="javax.xml.crypto中的接口"><code>XMLStructure</code></a> S其中的每一个包含能够使接收者一个或多个以获得验证XML签名所需的关键信息。</span>
<span>XML模式定义定义为</span>
<pre> <span>&lt;element name="KeyInfo" type="ds:KeyInfoType"/&gt;
&lt;complexType name="KeyInfoType" mixed="true"&gt;
&lt;choice maxOccurs="unbounded"&gt;
&lt;element ref="ds:KeyName"/&gt;
&lt;element ref="ds:KeyValue"/&gt;
&lt;element ref="ds:RetrievalMethod"/&gt;
&lt;element ref="ds:X509Data"/&gt;
&lt;element ref="ds:PGPData"/&gt;
&lt;element ref="ds:SPKIData"/&gt;
&lt;element ref="ds:MgmtData"/&gt;
&lt;any processContents="lax" namespace="##other"/&gt;
&lt;!-- (1,1) elements from (0,unbounded) namespaces --&gt;
&lt;/choice&gt;
&lt;attribute name="Id" type="ID" use="optional"/&gt;
&lt;/complexType&gt;</span> </pre>
<span>可以通过调用<a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.html" title="javax.xml.crypto.dsig.keyinfo中的类"><code>KeyInfoFactory</code></a>类的<a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.html#newKeyInfo-java.util.List-"><code>newKeyInfo</code></a>方法之一并传递一个或多个<code>XMLStructure</code>和可选的id参数的列表来创建<code>KeyInfo</code>实例。</span>
<span>例如:</span>
<pre> <span>KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
KeyInfo keyInfo = factory.newKeyInfo
(Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));</span> </pre>
<p> <span><code>KeyInfo</code>对象也可以通过调用<a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfo.html#marshal-javax.xml.crypto.XMLStructure-javax.xml.crypto.XMLCryptoContext-"><code>marshal</code></a>方法编组到XML。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.6
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.html#newKeyInfo-java.util.List-"><code>KeyInfoFactory.newKeyInfo(List)</code></a>
<a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.html#newKeyInfo-java.util.List-java.lang.String-"><code>KeyInfoFactory.newKeyInfo(List, String)</code></a>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t3"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../../../../java/util/List.html" title="interface in java.util">List</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfo.html#getContent--">getContent</a></span>()</code>
<div class="block">
返回一个
<a href="../../../../../java/util/Collections.html#unmodifiableList-java.util.List-"><code>unmodifiable list</code></a>包含关键信息。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfo.html#getId--">getId</a></span>()</code>
<div class="block">
返回此
<code>KeyInfo</code>的可选Id属性这对于从其他XML结构引用此
<code>KeyInfo</code>可能很有用。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/xml/crypto/dsig/keyinfo/KeyInfo.html#marshal-javax.xml.crypto.XMLStructure-javax.xml.crypto.XMLCryptoContext-">marshal</a></span>(<a href="../../../../../javax/xml/crypto/XMLStructure.html" title="interface in javax.xml.crypto">XMLStructure</a> parent, <a href="../../../../../javax/xml/crypto/XMLCryptoContext.html" title="interface in javax.xml.crypto">XMLCryptoContext</a> context)</code>
<div class="block">
将关键信息传达给XML。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.crypto.XMLStructure">
<!-- --> </a> <h3>Methods inherited from interface javax.xml.crypto.<a href="../../../../../javax/xml/crypto/XMLStructure.html" title="interface in javax.xml.crypto">XMLStructure</a></h3> <code><a href="../../../../../javax/xml/crypto/XMLStructure.html#isFeatureSupported-java.lang.String-">isFeatureSupported</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getContent--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getContent</h4> <pre><a href="../../../../../java/util/List.html" title="interface in java.util">List</a> getContent()</pre>
<div class="block">
<span>返回一个<a href="../../../../../java/util/Collections.html#unmodifiableList-java.util.List-"><code>unmodifiable list</code></a>包含关键信息。</span>
<span>列表的每个条目都是<a href="../../../../../javax/xml/crypto/XMLStructure.html" title="javax.xml.crypto中的接口"><code>XMLStructure</code></a></span>
<p> <span>如果有一个表示类型为<code>XMLStructure</code>的公共子类,则作为该类的实例返回(例如: <code>X509Data</code>元素将作为<a href="../../../../../javax/xml/crypto/dsig/keyinfo/X509Data.html" title="javax.xml.crypto.dsig.keyinfo中的接口"><code>X509Data</code></a>的实例返回)。</span> </p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>一个或多个可修改的列表<code>XMLStructure</code> S IN此<code>KeyInfo</code></span>
<span>永远不会返回<code>null</code>或空列表。</span>
</dd>
</dl> </li>
</ul> <a name="getId--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getId</h4> <pre><a href="../../../../../java/lang/String.html" title="class in java.lang">String</a> getId()</pre>
<div class="block">
返回此
<code>KeyInfo</code>的可选Id属性这对于从其他XML结构引用此
<code>KeyInfo</code>可能很有用。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
此的Id属性
<code>KeyInfo</code> (可以是
<code>null</code>如果未指定)
</dd>
</dl> </li>
</ul> <a name="marshal-javax.xml.crypto.XMLStructure-javax.xml.crypto.XMLCryptoContext-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>marshal</h4> <pre>void marshal(<a href="../../../../../javax/xml/crypto/XMLStructure.html" title="interface in javax.xml.crypto">XMLStructure</a> parent,
<a href="../../../../../javax/xml/crypto/XMLCryptoContext.html" title="interface in javax.xml.crypto">XMLCryptoContext</a> context)
throws <a href="../../../../../javax/xml/crypto/MarshalException.html" title="class in javax.xml.crypto">MarshalException</a></pre>
<div class="block">
将关键信息传达给XML。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>parent</code> - 一个机制特定的结构,包含编组的密钥信息将被附加到的父节点
</dd>
<dd>
<code>context</code> - 包含附加上下文的
<code>XMLCryptoContext</code> 如果不适用可以为null
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../../../java/lang/ClassCastException.html" title="class in java.lang">ClassCastException</a></code> - 如果
<code>parent</code>
<code>context</code>的类型与此关键信息不兼容
</dd>
<dd>
<code><a href="../../../../../javax/xml/crypto/MarshalException.html" title="class in javax.xml.crypto">MarshalException</a></code> - 如果密钥信息无法编组
</dd>
<dd>
<code><a href="../../../../../java/lang/NullPointerException.html" title="class in java.lang">NullPointerException</a></code> - 如果
<code>parent</code>
<code>null</code>
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>