JavaTM Platform
Standard Ed. 6

javax.net.ssl
类 HandshakeCompletedEvent

java.lang.Object
  继承者 java.util.EventObject
      继承者 javax.net.ssl.HandshakeCompletedEvent
所有已实现的接口:
Serializable

public class HandshakeCompletedEvent
extends EventObject

此事件指示在给定的 SSL 连接上 SSL 握手结束。所有关于该握手结果的核心信息都通过 "SSLSession" 对象捕获。出于方便的考虑,此事件类提供对一些重要会话属性的直接访问。

此事件的源是在其上刚刚结束握手的 SSLSocket。

从以下版本开始:
1.4
另请参见:
SSLSocket, HandshakeCompletedListener, SSLSession, 序列化表格

字段摘要
 
从类 java.util.EventObject 继承的字段
source
 
构造方法摘要
HandshakeCompletedEvent(SSLSocket sock, SSLSession s)
          构造一个新的 HandshakeCompletedEvent。
 
方法摘要
 String getCipherSuite()
          返回由握手产生的会话所使用的密码套件。
 Certificate[] getLocalCertificates()
          返回握手期间发送到同位体的证书。
 Principal getLocalPrincipal()
          返回握手期间发送到同位体的主体。
 X509Certificate[] getPeerCertificateChain()
          返回同位体的标识,同位体是作为定义会话的一部分而标识的。
 Certificate[] getPeerCertificates()
          返回同位体的标识,同位体是作为定义会话的一部分而建立的。
 Principal getPeerPrincipal()
          返回同位体的标识,同位体是作为定义会话的一部分而建立的。
 SSLSession getSession()
          返回触发此事件的会话。
 SSLSocket getSocket()
          返回作为此事件源的套接字。
 
从类 java.util.EventObject 继承的方法
getSource, toString
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

构造方法详细信息

HandshakeCompletedEvent

public HandshakeCompletedEvent(SSLSocket sock,
                               SSLSession s)
构造一个新的 HandshakeCompletedEvent。

参数:
sock - 作为事件源的 SSLSocket
s - 与此事件相关联的 SSLSession
方法详细信息

getSession

public SSLSession getSession()
返回触发此事件的会话。

返回:
此握手的 SSLSession

getCipherSuite

public String getCipherSuite()
返回由握手产生的会话所使用的密码套件。(这是从 SSLsession 获取密码套件的便捷方法。)

返回:
在此会话期间协商的密码套件名称。

getLocalCertificates

public Certificate[] getLocalCertificates()
返回握手期间发送到同位体的证书。注:仅当使用基于证书的密码套件时此方法才有用。 当在一次握手中有多个证书可供使用时,实现选择它认为是“最好的”可用证书链,并把它传输到另一方。此方法允许调用者知道实际所使用的证书链。

返回:
证书的有序数组,本地证书在前,后跟所有证书颁发机构。如果没有发送任何证书,则返回 null。
另请参见:
getLocalPrincipal()

getPeerCertificates

public Certificate[] getPeerCertificates()
                                  throws SSLPeerUnverifiedException
返回同位体的标识,同位体是作为定义会话的一部分而建立的。注:仅当使用基于证书的密码套件时才可以使用此方法;将它与非基于证书的密码套件(如 Kerberos)一起使用将抛出 SSLPeerUnverifiedException。

返回:
同位体证书的有序数组,同位体自己的证书在前,后跟所有证书颁发机构。
抛出:
SSLPeerUnverifiedException - 如果没有验证同位体。
另请参见:
getPeerPrincipal()

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()
                                          throws SSLPeerUnverifiedException
返回同位体的标识,同位体是作为定义会话的一部分而标识的。注:仅当使用基于证书的密码套件时才可以使用此方法;将它与非基于证书的密码套件(如 Kerberos)一起使用将抛出 SSLPeerUnverifiedException。

注:此方法存在是为了和以前的版本兼容。新的应用程序应该使用 getPeerCertificates()

返回:
同位体 X.509 证书的有序数组,同位体自己的证书在前,后跟所有证书颁发机构。(证书的格式是初始的 JSSE X509Certificate 格式。)
抛出:
SSLPeerUnverifiedException - 如果同位体未经验证。
另请参见:
getPeerPrincipal()

getPeerPrincipal

public Principal getPeerPrincipal()
                           throws SSLPeerUnverifiedException
返回同位体的标识,同位体是作为定义会话的一部分而建立的。

返回:
同位体的主体。返回基于 X509 的密码套件的最终实体证书的 X500Principal,以及 Kerberos 的密码套件的 KerberosPrincipal。
抛出:
SSLPeerUnverifiedException - 如果尚未验证同位体的标识
从以下版本开始:
1.5
另请参见:
getPeerCertificates(), getLocalPrincipal()

getLocalPrincipal

public Principal getLocalPrincipal()
返回握手期间发送到同位体的主体。

返回:
发送到同位体的主体。返回基于 X509 的密码套件的最终实体证书的 X500Principal,以及 Kerberos 的密码套件的 KerberosPrincipal。如果没有发送任何主体,则返回 null。
从以下版本开始:
1.5
另请参见:
getLocalCertificates(), getPeerPrincipal()

getSocket

public SSLSocket getSocket()
返回作为此事件源的套接字。(这是一个方便的功能,使应用程序无需进行强制类型转换即可写入代码。)

返回:
返回在其上进行连接的套接字。

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策