SSLServerSocket (Java Platform SE 7)

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

すべての実装されたインタフェース:

Closeable, AutoCloseable
```
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()` 新しく `accept` されたサーバーモードの `SSLSocket` 上でクライアント認証が必要な場合は true を返します。
`SSLParameters`	`getSSLParameters()` 新しく受け入れられた接続で有効な SSLParameters を返します。
`abstract String[]`	`getSupportedCipherSuites()` SSL 接続で使用可能にできる暗号化方式群の名前を返します。
`abstract String[]`	`getSupportedProtocols()` 使用可能にできるプロトコルの名前を返します。
`abstract boolean`	`getUseClientMode()` 受け入れた接続が SSL クライアントモードになる場合は true を返します。
`abstract boolean`	`getWantClientAuth()` 新しく受け入れられたサーバーモードの接続上でクライアント認証が要求される場合は true を返します。
`abstract void`	`setEnabledCipherSuites(String[] suites)` 受け入れられた接続で使用可能な暗号化方式群を設定します。
`abstract void`	`setEnabledProtocols(String[] protocols)` 受け入れた接続で使用可能なプロトコルを制御します。
`abstract void`	`setEnableSessionCreation(boolean flag)` このサーバーソケットから作成されたソケットで、新しい SSL セッションを確立すかどうかを制御します。
`abstract void`	`setNeedClientAuth(boolean need)` `accept` されたサーバーモードの `SSLSockets` が、クライアント認証が必要なように初期構成されるかどうかを制御します。
`void`	`setSSLParameters(SSLParameters params)` 新しく受け入れられた接続に SSLParameters を適用します。
`abstract void`	`setUseClientMode(boolean mode)` 受け入れた接続がデフォルトで SSL サーバーモードになるか、SSL クライアントモードになるかを制御します。
`abstract void`	`setWantClientAuth(boolean want)` `accept` されたサーバーモードの `SSLSockets` が、クライアント認証を要求するように初期構成されるかどうかを制御します。

クラス java.net.ServerSocket から継承されたメソッド
accept, bind, bind, close, getChannel, getInetAddress, getLocalPort, getLocalSocketAddress, getReceiveBufferSize, getReuseAddress, getSoTimeout, implAccept, isBound, isClosed, setPerformancePreferences, 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 に設定されています。キュー内の接続要求が最大数を超えると、新しい接続要求は拒否されます。
    ポート番号に 0 を指定すると、いずれかの空いているポート上でソケットが作成されます。
    セキュリティーマネージャーが存在する場合、この操作が許可されるように、その checkListen メソッドが port 引数をその引数として指定して呼び出されます。この結果、SecurityException がスローされることがあります。
    
    パラメータ:
    port - 待機するポート
    
    例外:
    
    IOException - ソケットの作成時に入出力エラーが発生した場合
    
    SecurityException - セキュリティーマネージャーが存在し、その checkListen メソッドでこの操作が許可されていない場合。
    
    IllegalArgumentException - port パラメータが指定された有効なポート値の範囲 (0 から 65535) 外である場合。
    関連項目:
    SecurityManager.checkListen(int)
  - SSLServerSocket
```
protected SSLServerSocket(int port,
               int backlog)
                   throws IOException
```
    サブクラスでだけ使用されます。
    デフォルトの認証コンテキストと、指定された接続バックログを使用して、ポート上に TCP サーバーソケットを作成します。
    ポート番号に 0 を指定すると、いずれかの空いているポート上でソケットが作成されます。
    backlog 引数は、ソケットの保留されている接続の要求された最大数です。正確なセマンティクスは実装に固有です。たとえば、実装が最大長を規定していたり、パラメータをまったく無視したりする場合があります。指定される値は 0 より大きくなければいけません。0 以下の場合は、実装固有のデフォルトが使用されます。
    セキュリティーマネージャーが存在する場合、この操作が許可されるように、その checkListen メソッドが port 引数をその引数として指定して呼び出されます。この結果、SecurityException がスローされることがあります。
    
    パラメータ:
    port - 待機するポート
    backlog - 着信接続のキューの要求された最大長。
    
    例外:
    
    IOException - ソケットの作成時に入出力エラーが発生した場合
    
    SecurityException - セキュリティーマネージャーが存在し、その checkListen メソッドでこの操作が許可されていない場合。
    
    IllegalArgumentException - port パラメータが指定された有効なポート値の範囲 (0 から 65535) 外である場合。
    関連項目:
    SecurityManager.checkListen(int)
  - SSLServerSocket
```
protected SSLServerSocket(int port,
               int backlog,
               InetAddress address)
                   throws IOException
```
    サブクラスでだけ使用されます。
    デフォルトの認証コンテキスト、指定された接続バックログ、および指定されたネットワークインタフェースを使用して、ポート上に TCP サーバーソケットを作成します。このコンストラクタは、ファイアウォールやルータとして使用されるマルチホームホスト上で使用され、ネットワークサービスを提供するインタフェースを制御します。
    セキュリティーマネージャーが存在する場合、この操作が許可されるように、その checkListen メソッドが port 引数をその引数として指定して呼び出されます。この結果、SecurityException がスローされることがあります。
    ポート番号に 0 を指定すると、いずれかの空いているポート上でソケットが作成されます。
    backlog 引数は、ソケットの保留されている接続の要求された最大数です。正確なセマンティクスは実装に固有です。たとえば、実装が最大長を規定していたり、パラメータをまったく無視したりする場合があります。指定される値は 0 より大きくなければいけません。0 以下の場合は、実装固有のデフォルトが使用されます。
    address が null の場合、これはデフォルトで、任意の (すべての) ローカルアドレス上の接続を受け入れます。
    
    パラメータ:
    port - 待機するポート
    backlog - 着信接続のキューの要求された最大長。
    address - 接続を受け入れるネットワークインタフェースのアドレス
    
    例外:
    
    IOException - ソケットの作成時に入出力エラーが発生した場合
    
    SecurityException - セキュリティーマネージャーが存在し、その checkListen メソッドでこの操作が許可されていない場合。
    
    IllegalArgumentException - port パラメータが指定された有効なポート値の範囲 (0 から 65535) 外である場合。
    関連項目:
    SecurityManager.checkListen(int)
- メソッドの詳細
  - getEnabledCipherSuites
```
public abstract String[] getEnabledCipherSuites()
```
    新しく受け入れた接続で現在使用可能になっている暗号化方式群のリストを返します。
    このリストが明示的に変更されていない場合は、システムデフォルトにより、使用可能なすべての暗号化方式群で、最小限のサービス品質が保証されます。
    実際に使用する暗号化方式群は、要件に応じて適切に選択してください。たとえば、サーバーソケットがなんらかの認証を要求するように設定されているときに、暗号化方式群で使用できる非公開鍵がサーバーソケットに割り当てられていない場合、または暗号化方式群が匿名であるためクライアント認証を使用できない場合、それらの暗号化方式群は実際には使用できません。
    
    戻り値:
    使用可能な暗号化方式群の配列
    関連項目:
    getSupportedCipherSuites(), setEnabledCipherSuites(String [])
  - setEnabledCipherSuites
```
public abstract void setEnabledCipherSuites(String[] suites)
```
    受け入れられた接続で使用可能な暗号化方式群を設定します。
    暗号化方式群は、getSupportedCipherSuites() により、サポート対象としてリストされていなければいけません。このメソッドの呼び出しが成功したあと、suites パラメータに示されている暗号化方式群のみが使用可能になります。
    この 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() により、サポート対象としてリストされていなければいけません。このメソッドの呼び出しが成功したあと、protocols パラメータに示されているプロトコルのみが使用可能になります。
    accept() から返された SSLSocket は、この設定を継承します。
    
    パラメータ:
    protocols - 有効にするすべてのプロトコルの名前。
    
    例外:
    
    IllegalArgumentException - パラメータで指定されたプロトコルの 1 つ以上がサポートされていないか、または protocols パラメータが null である場合。
    関連項目:
    getEnabledProtocols(), getSupportedProtocols()
  - setNeedClientAuth
```
public abstract void setNeedClientAuth(boolean need)
```
    accept されたサーバーモードの SSLSockets が、クライアント認証が必要なように初期構成されるかどうかを制御します。
    ソケットのクライアント認証設定は、次のいずれかになります。
    - クライアント認証を必須にする
    - クライアント認証を要求する
    - クライアント認証を不要にする
    setWantClientAuth(boolean) と異なり、受け入れたソケットのオプションが設定されていて、かつクライアント認証情報が提供されない場合は、ネゴシエーションが停止し、接続が切断されます。
    このメソッドを呼び出すと、このメソッドまたは setWantClientAuth(boolean) によって行われた以前の設定がすべてオーバーライドされます。
    SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すことによって、継承された初期の設定がオーバーライドされる可能性があります。
    パラメータ:
    need - クライアント認証が必要な場合は true に、クライアント認証が不要な場合は false に設定される。
    関連項目:
    getNeedClientAuth(), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)
  - getNeedClientAuth
```
public abstract boolean getNeedClientAuth()
```
    新しく accept されたサーバーモードの SSLSocket 上でクライアント認証が必要な場合は true を返します。
    SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すことによって、継承された初期の設定がオーバーライドされる可能性があります。
    
    戻り値:
    クライアント認証が必須の場合は true、クライアント認証が不要な場合は false。
    関連項目:
    setNeedClientAuth(boolean), setWantClientAuth(boolean), getWantClientAuth(), setUseClientMode(boolean)
  - setWantClientAuth
```
public abstract void setWantClientAuth(boolean want)
```
    accept されたサーバーモードの SSLSockets が、クライアント認証を要求するように初期構成されるかどうかを制御します。
    ソケットのクライアント認証設定は、次のいずれかになります。
    - クライアント認証を必須にする
    - クライアント認証を要求する
    - クライアント認証を不要にする
    setNeedClientAuth(boolean) と異なり、受け入れたソケットのオプションが設定されていて、かつクライアント認証情報が提供されない場合でも、ネゴシエーションは続行されます。
    このメソッドを呼び出すと、このメソッドまたは setNeedClientAuth(boolean) によって行われた以前の設定がすべてオーバーライドされます。
    SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すことによって、継承された初期の設定がオーバーライドされる可能性があります。
    パラメータ:
    want - クライアント認証が要求されている場合は true に、クライアント認証が不要な場合は false に設定される。
    関連項目:
    getWantClientAuth(), setNeedClientAuth(boolean), getNeedClientAuth(), setUseClientMode(boolean)
  - getWantClientAuth
```
public abstract boolean getWantClientAuth()
```
    新しく受け入れられたサーバーモードの接続上でクライアント認証が要求される場合は true を返します。
    SSLSocket.setNeedClientAuth(boolean) または SSLSocket.setWantClientAuth(boolean) を呼び出すことによって、継承された初期の設定がオーバーライドされる可能性があります。
    
    戻り値:
    クライアント認証が要求された場合は true、クライアント認証が不要な場合は false。
    関連項目:
    setWantClientAuth(boolean), setNeedClientAuth(boolean), getNeedClientAuth(), setUseClientMode(boolean)
  - setUseClientMode
```
public abstract void setUseClientMode(boolean mode)
```
    受け入れた接続がデフォルトで SSL サーバーモードになるか、SSL クライアントモードになるかを制御します。
    通常、サーバーは自身を認証しますが、クライアントは必ずしもそうとはかぎりません。
    新しく受け入れた接続が、SSL クライアントモードの TCP サーバーを要求することがあります。たとえば、FTP クライアントは、サーバーソケットを取得すると、そのソケット上でサーバーからの接続を待機します。FTP クライアントは、サーバーからの接続を受け入れるときに、クライアントモードの SSLServerSocket を使用します。 FTP サーバーは、接続を開始するときにクライアントモードを無効にした SSLSocket を使用します。この場合、ハンドシェークを行うときは、既存の SSL セッションが再利用されます。
    accept() から返された SSLSocket は、この設定を継承します。
    
    パラメータ:
    mode - 新しく受け入れた接続が 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)
  - getSSLParameters
```
public SSLParameters getSSLParameters()
```
    新しく受け入れられた接続で有効な SSLParameters を返します。返される SSLParameters の暗号化方式群とプロトコルは、常に null 以外です。
    
    戻り値:
    新しく受け入れられた接続で有効な SSLParameters
    導入されたバージョン:
    
    1.7
    
    関連項目:
    setSSLParameters(SSLParameters)
  - setSSLParameters
```
public void setSSLParameters(SSLParameters params)
```
    新しく受け入れられた接続に SSLParameters を適用します。
    これは次のことを意味します。
    - params.getCipherSuites() が null 以外の場合は、その値を使用して setEnabledCipherSuites() が呼び出される
    - params.getProtocols() が null 以外の場合は、その値を使用して setEnabledProtocols() が呼び出される
    - params.getNeedClientAuth() または params.getWantClientAuth() が true を返した場合は、それぞれ setNeedClientAuth(true) と setWantClientAuth(true) が呼び出される。それ以外の場合は setWantClientAuth(false) が呼び出される。
    パラメータ:
    params - パラメータ
    
    例外:
    
    IllegalArgumentException - setEnabledCipherSuites() または setEnabledProtocols() の呼び出しが失敗した場合
    導入されたバージョン:
    
    1.7
    
    関連項目:
    getSSLParameters()

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス SSLServerSocket

コンストラクタのサマリー

メソッドのサマリー

クラス java.net.ServerSocket から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

SSLServerSocket

SSLServerSocket

SSLServerSocket

SSLServerSocket

メソッドの詳細

getEnabledCipherSuites

setEnabledCipherSuites

getSupportedCipherSuites

getSupportedProtocols

getEnabledProtocols

setEnabledProtocols

setNeedClientAuth

getNeedClientAuth

setWantClientAuth

getWantClientAuth

setUseClientMode

getUseClientMode

setEnableSessionCreation

getEnableSessionCreation

getSSLParameters

setSSLParameters