JavaTM 2
Platform
Std. Ed. v1.4.0

javax.net.ssl
クラス SSLServerSocket

java.lang.Object
  |
  +--java.net.ServerSocket
        |
        +--javax.net.ssl.SSLServerSocket

public abstract class SSLServerSocket
extends ServerSocket

このクラスは ServerSocket を拡張し、Secure Sockets Layer (SSL) や Transport Layer Security (TLS) などのプロトコルを使用するセキュアサーバソケットを提供します。

このクラスのインスタンスを作成するときは、通常、SSLServerSocketFactory を使用します。SSLServerSocket は、接続を accept して SSLSocket を作成します。

SSLServerSocket の一部の状態データは、作成される SSLSocket に継承されます。たとえば、有効になっている符号化方式とプロトコル、クライアント認証が必要かどうか、このソケットがハンドシェークを開始するときのモード (クライアントモードまたはサーバモード)、などの情報が継承されます。作成された SSLSocket に継承された状態は、対応するメソッドを呼び出してオーバーライドできます。

導入されたバージョン:
1.4
関連項目:
ServerSocket, SSLSocket

コンストラクタの概要
protected SSLServerSocket()
          サブクラスだけで使用されます。
protected SSLServerSocket(int port)
          サブクラスだけで使用されます。
protected SSLServerSocket(int port, int backlog)
          サブクラスだけで使用されます。
protected SSLServerSocket(int port, int backlog, InetAddress address)
          サブクラスだけで使用されます。
 
メソッドの概要
abstract  String[] getEnabledCipherSuites()
          新しく受け入れた接続で現在使用可能になっている符号化方式のリストを返します。
abstract  String[] getEnabledProtocols()
          新しく受け入れた接続で現在使用可能になっているプロトコル名を返します。
abstract  boolean getEnableSessionCreation()
          このサーバソケットから作成されたソケットで、新しい SSL セッションを確立する場合は true を返します。
abstract  boolean getNeedClientAuth()
          新しく受け入れた接続がクライアント認証を必要とする場合は true を返します。
abstract  String[] getSupportedCipherSuites()
          SSL 接続で使用可能にできる符号化方式の名前を返します。
abstract  String[] getSupportedProtocols()
          使用可能にできるプロトコルの名前を返します。
abstract  boolean getUseClientMode()
          受け入れた接続が SSL クライアントモードになる場合は true を返します。
abstract  boolean getWantClientAuth()
          新しく受け入れた接続がクライアント認証を要求する場合は true を返します。
abstract  void setEnabledCipherSuites(String[] suites)
          受け入れた接続に対して使用可能にする SSL 符号化方式を制御します。
abstract  void setEnabledProtocols(String[] protocols)
          受け入れた接続で使用可能にするプロトコルを制御します。
abstract  void setEnableSessionCreation(boolean flag)
          このサーバソケットから作成されたソケットで、新しい SSL セッションを確立すかどうかを制御します。
abstract  void setNeedClientAuth(boolean flag)
          受け入れた接続がクライアント認証を要求するかどうかを制御します。
abstract  void setUseClientMode(boolean flag)
          受け入れられた接続が (デフォルトの) SSL サーバモードと SSL クライアントモードのどちらであるかを制御します。
abstract  void setWantClientAuth(boolean flag)
          受け入れた接続が、SSL ネゴシエーションを行うときに、クライアント認証を要求する必要があるかどうかを制御します。
 
クラス java.net.ServerSocket から継承したメソッド
accept, bind, bind, close, getChannel, getInetAddress, getLocalPort, getLocalSocketAddress, getReceiveBufferSize, getReuseAddress, getSoTimeout, implAccept, isBound, isClosed, setReceiveBufferSize, setReuseAddress, setSocketFactory, setSoTimeout, toString
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

SSLServerSocket

protected SSLServerSocket()
                   throws IOException
サブクラスだけで使用されます。デフォルトの認証コンテキストを使用して、バインドされていない TCP サーバソケットを作成します。

例外:
IOException - ソケットの生成中に入出力エラーが発生した場合

SSLServerSocket

protected SSLServerSocket(int port)
                   throws IOException
サブクラスだけで使用されます。デフォルトの認証コンテキストを使用して、ポート上に TCP サーバソケットを作成します。キューに格納される接続バックログの最大数は、デフォルトで 50 に設定されています。キュー内の接続要求が最大数を超えると、新しい接続要求は拒否されます。

パラメータ:
port - 待機するポート
例外:
IOException - ソケットの生成中に入出力エラーが発生した場合

SSLServerSocket

protected SSLServerSocket(int port,
                          int backlog)
                   throws IOException
サブクラスだけで使用されます。デフォルトの認証コンテキストと、指定された接続バックログを使用して、ポート上に TCP サーバソケットを作成します。

パラメータ:
port - 待機するポート
backlog - 最大保留接続数。この接続数を超えると、新しい要求が拒否される
例外:
IOException - ソケットの生成中に入出力エラーが発生した場合

SSLServerSocket

protected SSLServerSocket(int port,
                          int backlog,
                          InetAddress address)
                   throws IOException
サブクラスだけで使用されます。デフォルトの認証コンテキスト、指定された接続バックログ、および指定されたネットワークインタフェースを使用して、ポート上に TCP サーバソケットを作成します。このコンストラクタは、ファイアウォールやルータとして使用されるマルチホームホスト上で使用され、ネットワークサービスを提供するインタフェースを制御します。

パラメータ:
port - 待機するポート
backlog - 最大保留接続数。この接続数を超えると、新しい要求が拒否される
address - 接続を受け入れるネットワークインタフェースのアドレス
例外:
IOException - ソケットの生成中に入出力エラーが発生した場合
メソッドの詳細

getEnabledCipherSuites

public abstract String[] getEnabledCipherSuites()
新しく受け入れた接続で現在使用可能になっている符号化方式のリストを返します。このリストを明示的に変更しない限り、システムのデフォルト設定により、すべての使用可能な符号化方式で最小限のサービス品質が保証されます。

実際に使用する符号化方式は、要件に応じて適切に選択してください。たとえば、サーバソケットがなんらかの認証を要求するように設定されているときに、符号化方式で使用できる非公開鍵がサーバソケットに割り当てられていない場合、または符号化方式が匿名であるためクライアント認証を使用できない場合、それらの符号化方式は実際には使用できません。

戻り値:
使用可能な符号化方式の配列
関連項目:
getSupportedCipherSuites(), setEnabledCipherSuites(String [])

setEnabledCipherSuites

public abstract void setEnabledCipherSuites(String[] suites)
受け入れた接続に対して使用可能にする SSL 符号化方式を制御します。使用する符号化方式は、getSupportedCipherSuites() から返される符号化方式のリストで使用可能になっていなければなりません。使用可能になっている場合でも、この ServerSocket の認証コンテキストで使用できない認証情報を必要とする場合は、その符号化方式は使用できません。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
suites - 使用可能にするすべての符号化方式の名前
例外:
IllegalArgumentException - パラメータに指定された符号化方式の一部がサポートされない場合、またはパラメータが null の場合
関連項目:
getSupportedCipherSuites(), getEnabledCipherSuites()

getSupportedCipherSuites

public abstract String[] getSupportedCipherSuites()
SSL 接続で使用可能にできる符号化方式の名前を返します。通常は、その一部だけがデフォルトで使用可能になります。デフォルトのサービス品質要件を満たしていない符号化方式は、使用不可になります。それらの符号化方式は、特殊なアプリケーションで使用します。

戻り値:
符号化方式名の配列
関連項目:
getEnabledCipherSuites(), setEnabledCipherSuites(String [])

getSupportedProtocols

public abstract String[] getSupportedProtocols()
使用可能にできるプロトコルの名前を返します。

戻り値:
サポートされているプロトコル名の配列
関連項目:
getEnabledProtocols(), setEnabledProtocols(String [])

getEnabledProtocols

public abstract String[] getEnabledProtocols()
新しく受け入れた接続で現在使用可能になっているプロトコル名を返します。

戻り値:
プロトコル名の配列
関連項目:
getSupportedProtocols(), setEnabledProtocols(String [])

setEnabledProtocols

public abstract void setEnabledProtocols(String[] protocols)
受け入れた接続で使用可能にするプロトコルを制御します。使用可能にするプロトコルは、getSupportedProtocols() から返されるプロトコルのリストで使用可能になっていなければなりません。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
protocols - 使用可能にするすべてのプロトコルの名前
例外:
IllegalArgumentException - パラメータに指定されたプロトコルの一部がサポートされない場合、またはパラメータが null の場合
関連項目:
getEnabledProtocols(), getSupportedProtocols()

setNeedClientAuth

public abstract void setNeedClientAuth(boolean flag)
受け入れた接続がクライアント認証を要求するかどうかを制御します。このオプションは、サーバモードのソケットだけで使用します。

setWantClientAuth(boolean) と異なり、クライアント認証情報を提供しない場合は、ネゴシエーションが停止し、接続が切断されます。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
flag - クライアント認証が必要な場合は、true。このパラメータを true に設定すると、setWantClientAuth(boolean) の現在の設定がオーバーライドされる
関連項目:
getNeedClientAuth(), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)

getNeedClientAuth

public abstract boolean getNeedClientAuth()
新しく受け入れた接続がクライアント認証を必要とする場合は true を返します。このオプションは、サーバモードのソケットだけで使用できます。

戻り値:
クライアント認証が必要な場合は true
関連項目:
setNeedClientAuth(boolean), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)

setWantClientAuth

public abstract void setWantClientAuth(boolean flag)
受け入れた接続が、SSL ネゴシエーションを行うときに、クライアント認証を要求する必要があるかどうかを制御します。このオプションは、サーバモードのソケットだけで使用します。

setNeedClientAuth(boolean) と異なり、クライアント認証情報を提供しない場合でも、ネゴシエーションは継続されます。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
flag - クライアント認証が必要な場合は、true。このパラメータを true に設定すると、 setNeedClientAuth(boolean) の現在の設定がオーバーライドされる
関連項目:
getWantClientAuth(), setNeedClientAuth(boolean), getNeedClientAuth(), setUseClientMode(boolean)

getWantClientAuth

public abstract boolean getWantClientAuth()
新しく受け入れた接続がクライアント認証を要求する場合は true を返します。このオプションは、サーバモードのソケットだけで使用できます。

戻り値:
クライアント認証が必要な場合は true
関連項目:
setWantClientAuth(boolean), setNeedClientAuth(boolean), getNeedClientAuth(), setUseClientMode(boolean)

setUseClientMode

public abstract void setUseClientMode(boolean flag)
受け入れられた接続が (デフォルトの) SSL サーバモードと SSL クライアントモードのどちらであるかを制御します。通常、サーバは認証を行いますが、クライアントは認証する必要がありません。

新しく受け入れた接続が、SSL クライアントモードの TCP サーバを要求することがあります。たとえば、FTP クライアントは、サーバソケットを取得すると、そのソケット上でサーバからの接続を待機します。FTP クライアントは、サーバからの接続を受け入れるときに、クライアントモードの SSLServerSocket を使用します。FTP サーバは、接続を開始するときにクライアントモードを無効にした SSLSocket を使用します。この場合、ハンドシェークを行うときは、既存の SSL セッションが再利用されます。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
flag - 新しく受け入れた接続が SSL クライアントモードを使用する場合は true
関連項目:
getUseClientMode()

getUseClientMode

public abstract boolean getUseClientMode()
受け入れた接続が SSL クライアントモードになる場合は true を返します。

戻り値:
接続が SSL クライアントモードを使用する場合は true
関連項目:
setUseClientMode(boolean)

setEnableSessionCreation

public abstract void setEnableSessionCreation(boolean flag)
このサーバソケットから作成されたソケットで、新しい SSL セッションを確立すかどうかを制御します。

accept() から返される SSLSocket は、この設定を継承します。

パラメータ:
flag - セッションを作成する場合は true (デフォルト)。既存のセッションを再開する場合は false
関連項目:
getEnableSessionCreation()

getEnableSessionCreation

public abstract boolean getEnableSessionCreation()
このサーバソケットから作成されたソケットで、新しい SSL セッションを確立する場合は true を返します。

戻り値:
セッションを作成する場合は true (デフォルト)。既存のセッションを再開する場合は false
関連項目:
setEnableSessionCreation(boolean)

JavaTM 2
Platform
Std. Ed. v1.4.0

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

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.