uTools-Manuals/docs/java/javax/net/ssl/HandshakeCompletedEvent.html

409 lines
19 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">
compact1, compact2, compact3
</div>
<div class="subTitle">
javax.net.ssl
</div>
<h2 class="title" title="Class HandshakeCompletedEvent">Class HandshakeCompletedEvent</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../java/util/EventObject.html" title="class in java.util">java.util.EventObject</a></li>
<li>
<ul class="inheritance">
<li>javax.net.ssl.HandshakeCompletedEvent</li>
</ul> </li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Implemented Interfaces:
</dt>
<dd>
<span><a href="../../../java/io/Serializable.html" title="java.io中的接口">Serializable</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public class <span class="typeNameLabel">HandshakeCompletedEvent</span>
extends <a href="../../../java/util/EventObject.html" title="class in java.util">EventObject</a></pre>
<div class="block">
<span>此事件表示在给定SSL连接上完成SSL握手。</span>
<span>关于握手结果的所有核心信息都通过“SSLSession”对象捕获。</span>
<span>为方便起见,此事件类可以直接访问某些重要的会话属性。</span>
<p> <span>这个事件的来源是刚刚完成握手的SSLSocket。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.4
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../javax/net/ssl/SSLSocket.html" title="javax.net.ssl中的类"><code>SSLSocket</code></a> <a href="../../../javax/net/ssl/HandshakeCompletedListener.html" title="javax.net.ssl中的接口"><code>HandshakeCompletedListener</code></a> <a href="../../../javax/net/ssl/SSLSession.html" title="javax.net.ssl中的接口"><code>SSLSession</code></a> <a href="../../../serialized-form.html#javax.net.ssl.HandshakeCompletedEvent">Serialized Form</a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.util.EventObject">
<!-- --> </a> <h3>Fields inherited from class java.util.<a href="../../../java/util/EventObject.html" title="class in java.util">EventObject</a></h3> <code><a href="../../../java/util/EventObject.html#source">source</a></code></li>
</ul> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#HandshakeCompletedEvent-javax.net.ssl.SSLSocket-javax.net.ssl.SSLSession-">HandshakeCompletedEvent</a></span>(<a href="../../../javax/net/ssl/SSLSocket.html" title="class in javax.net.ssl">SSLSocket</a> sock, <a href="../../../javax/net/ssl/SSLSession.html" title="interface in javax.net.ssl">SSLSession</a> s)</code>
<div class="block">
构造一个新的HandshakeCompletedEvent。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== 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="t4"><span><a href="javascript:show(8);">具体的方法</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/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getCipherSuite--">getCipherSuite</a></span>()</code>
<div class="block">
返回由握手产生的会话使用的密码套件。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../java/security/cert/Certificate.html" title="class in java.security.cert">Certificate</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getLocalCertificates--">getLocalCertificates</a></span>()</code>
<div class="block">
返回在握手期间发送给对等体的证书。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code><a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getLocalPrincipal--">getLocalPrincipal</a></span>()</code>
<div class="block">
返回在握手期间发送给对等体的主体。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="../../../javax/security/cert/X509Certificate.html" title="class in javax.security.cert">X509Certificate</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerCertificateChain--">getPeerCertificateChain</a></span>()</code>
<div class="block">
返回被确定为定义会话一部分的对等体的身份。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><a href="../../../java/security/cert/Certificate.html" title="class in java.security.cert">Certificate</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerCertificates--">getPeerCertificates</a></span>()</code>
<div class="block">
返回作为定义会话的一部分而建立的对等体的身份。
</div> </td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerPrincipal--">getPeerPrincipal</a></span>()</code>
<div class="block">
返回作为定义会话的一部分而建立的对等体的身份。
</div> </td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code><a href="../../../javax/net/ssl/SSLSession.html" title="interface in javax.net.ssl">SSLSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getSession--">getSession</a></span>()</code>
<div class="block">
返回触发此事件的会话。
</div> </td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../../javax/net/ssl/SSLSocket.html" title="class in javax.net.ssl">SSLSocket</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getSocket--">getSocket</a></span>()</code>
<div class="block">
返回作为此事件源的套接字。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.EventObject">
<!-- --> </a> <h3>Methods inherited from class java.util.<a href="../../../java/util/EventObject.html" title="class in java.util">EventObject</a></h3> <code><a href="../../../java/util/EventObject.html#getSource--">getSource</a>, <a href="../../../java/util/EventObject.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="HandshakeCompletedEvent-javax.net.ssl.SSLSocket-javax.net.ssl.SSLSession-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>HandshakeCompletedEvent</h4> <pre>public HandshakeCompletedEvent(<a href="../../../javax/net/ssl/SSLSocket.html" title="class in javax.net.ssl">SSLSocket</a> sock,
<a href="../../../javax/net/ssl/SSLSession.html" title="interface in javax.net.ssl">SSLSession</a> s)</pre>
<div class="block">
构造一个新的HandshakeCompletedEvent。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>sock</code> - SSLSocket作为事件的来源
</dd>
<dd>
<code>s</code> - 这个事件关联的SSLSession
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getSession--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getSession</h4> <pre>public <a href="../../../javax/net/ssl/SSLSession.html" title="interface in javax.net.ssl">SSLSession</a> getSession()</pre>
<div class="block">
返回触发此事件的会话。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
这个
<code>SSLSession</code>的SSLSession
</dd>
</dl> </li>
</ul> <a name="getCipherSuite--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getCipherSuite</h4> <pre>public <a href="../../../java/lang/String.html" title="class in java.lang">String</a> getCipherSuite()</pre>
<div class="block">
<span>返回由握手产生的会话使用的密码套件。</span>
<span>这是从SSLsession获取密码套件的便利方法。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
在此会话期间协商的密码套件的名称。
</dd>
</dl> </li>
</ul> <a name="getLocalCertificates--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getLocalCertificates</h4> <pre>public <a href="../../../java/security/cert/Certificate.html" title="class in java.security.cert">Certificate</a>[] getLocalCertificates()</pre>
<div class="block">
<span>返回在握手期间发送给对等体的证书。</span>
<span>注意:此方法仅在使用基于证书的密码套件时有用。</span>
<span>当多个证书可用于握手时,该实现将选择它认为“最佳”证书链可用,并将其传输到另一方。</span>
<span>该方法允许调用者知道实际使用哪个证书链。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>有序的证书阵列,本地证书首先跟随任何证书颁发机构。</span>
<span>如果没有发送证书则返回null。</span>
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getLocalPrincipal--"><code>getLocalPrincipal()</code></a>
</dd>
</dl> </li>
</ul> <a name="getPeerCertificates--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getPeerCertificates</h4> <pre>public <a href="../../../java/security/cert/Certificate.html" title="class in java.security.cert">Certificate</a>[] getPeerCertificates()
throws <a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></pre>
<div class="block">
<span>返回作为定义会话的一部分而建立的对等体的身份。</span>
<span>注意:此方法只能在使用基于证书的密码套件时使用;</span>
<span>与非基于证书的密码套件如Kerberos一起使用将抛出SSLPeerUnverifiedException异常。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
一个有序的对等证书阵列,首先是对等体自己的证书,然后是任何证书颁发机构。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></code> - 如果对等体未被验证。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerPrincipal--"><code>getPeerPrincipal()</code></a>
</dd>
</dl> </li>
</ul> <a name="getPeerCertificateChain--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getPeerCertificateChain</h4> <pre>public <a href="../../../javax/security/cert/X509Certificate.html" title="class in javax.security.cert">X509Certificate</a>[] getPeerCertificateChain()
throws <a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></pre>
<div class="block">
<span>返回被确定为定义会话一部分的对等体的身份。</span>
<span>注意:此方法只能在使用基于证书的密码套件时使用;</span>
<span>与非基于证书的密码套件如Kerberos一起使用将抛出SSLPeerUnverifiedException异常。</span>
<p> <span><em>注意:此方法与以前的版本兼容。</em></span> <span><em>新的应用程序应该使用<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerCertificates--"><code>getPeerCertificates()</code></a></em></span> </p>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>一个对等X.509证书的有序阵列,其中首先使用对等体自己的证书,然后是任何证书颁发机构。</span>
<span>证书是原始的JSSE <a href="../../../javax/security/cert/X509Certificate.html" title="javax.security.cert中的类"><code>X509Certificate</code></a>格式)。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></code> - 如果对等体未被验证。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerPrincipal--"><code>getPeerPrincipal()</code></a>
</dd>
</dl> </li>
</ul> <a name="getPeerPrincipal--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getPeerPrincipal</h4> <pre>public <a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a> getPeerPrincipal()
throws <a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></pre>
<div class="block">
返回作为定义会话的一部分而建立的对等体的身份。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>同行的校长。</span>
<span>返回基于X509的密码套件的终端实体认证的X500Principal以及Kerberos密码套件的KerberosPrincipal。</span>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../../javax/net/ssl/SSLPeerUnverifiedException.html" title="class in javax.net.ssl">SSLPeerUnverifiedException</a></code> - 如果对等体的身份未被验证
</dd>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.5
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerCertificates--"><code>getPeerCertificates()</code></a>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getLocalPrincipal--"><code>getLocalPrincipal()</code></a>
</dd>
</dl> </li>
</ul> <a name="getLocalPrincipal--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getLocalPrincipal</h4> <pre>public <a href="../../../java/security/Principal.html" title="interface in java.security">Principal</a> getLocalPrincipal()</pre>
<div class="block">
返回在握手期间发送给对等体的主体。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>校长发给同行。</span>
<span>返回基于X509的密码套件的终端实体证书的X500PrincipalKerberos密码套件的KerberosPrincipal。</span>
<span>如果没有发送主体则返回null。</span>
</dd>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.5
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getLocalCertificates--"><code>getLocalCertificates()</code></a>
<a href="../../../javax/net/ssl/HandshakeCompletedEvent.html#getPeerPrincipal--"><code>getPeerPrincipal()</code></a>
</dd>
</dl> </li>
</ul> <a name="getSocket--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getSocket</h4> <pre>public <a href="../../../javax/net/ssl/SSLSocket.html" title="class in javax.net.ssl">SSLSocket</a> getSocket()</pre>
<div class="block">
<span>返回作为此事件源的套接字。</span>
<span>(这是一个方便的功能,让应用程序编写没有类型转换的代码。)</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
连接在其上的插座。
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>