JavaTM 2 Platform
Standard Ed. 5.0

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 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。