SSLParameters (Java Platform SE 8)

java.lang.Object
- javax.net.ssl.SSLParameters

```
public class SSLParameters
extends Object
```
SSL/TLS接続のパラメータをカプセル化します。パラメータは、SSL/TLSハンドシェークで受け入れられる暗号化方式群のリスト、許可されるプロトコルのリスト、SSL/TLSハンドシェークでのエンドポイント識別アルゴリズム、Server Name Indication (SNI)、アルゴリズムの制約、およびSSL/TLSサーバーがクライアント認証を要求または必要とするかどうか、などです。
SSLParametersは、このクラスのコンストラクタを使用して作成することができます。オブジェクトは、SSLSocket、SSLServerSocket、およびSSLEngineのgetSSLParameters()メソッド、またはSSLContextのgetDefaultSSLParameters()メソッドとgetSupportedSSLParameters()メソッドを使用して取得することもできます。
SSLParametersは、SSLSocket.setSSLParameters()、SSLServerSocket.setSSLParameters()、およびSSLEngine.setSSLParameters()メソッドを使用して接続に適用できます。

導入されたバージョン:

1.6

関連項目:

SSLSocket, SSLEngine, SSLContext

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

コンストラクタ
コンストラクタと説明
`SSLParameters()` SSLParametersを構築します。
`SSLParameters(String[] cipherSuites)` 指定された暗号化方式群の配列からSSLParametersを構築します。
`SSLParameters(String[] cipherSuites, String[] protocols)` 指定された暗号化方式群とプロトコルの配列からSSLParametersを構築します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`AlgorithmConstraints`	`getAlgorithmConstraints()` 暗号化アルゴリズムの制約を返します。
`String[]`	`getCipherSuites()` 暗号化方式群の配列のコピーを返します。設定されていない場合はnullを返します。
`String`	`getEndpointIdentificationAlgorithm()` エンド・ポイント識別アルゴリズムを取得します。
`boolean`	`getNeedClientAuth()` クライアント認証を必須とするかどうかを返します。
`String[]`	`getProtocols()` プロトコルの配列のコピーを返します。設定されていない場合はnullを返します。
`List<SNIServerName>`	`getServerNames()` Server Name Indication (SNI)パラメータのすべての`SNIServerName`を含む`List`(何も設定されていない場合はnull)を返します。
`Collection<SNIMatcher>`	`getSNIMatchers()` Server Name Indication (SNI)パラメータのすべての`SNIMatcher`を含む`Collection`(何も設定されていない場合はnull)を返します。
`boolean`	`getUseCipherSuitesOrder()` 暗号化方式群のローカル設定を適用する必要があるかどうかを返します。
`boolean`	`getWantClientAuth()` クライアント認証を要求するかどうかを返します。
`void`	`setAlgorithmConstraints(AlgorithmConstraints constraints)` 実行環境によって構成された任意の制約に加えて使用される、暗号化アルゴリズムの制約を設定します。
`void`	`setCipherSuites(String[] cipherSuites)` 暗号化方式群の配列を設定します。
`void`	`setEndpointIdentificationAlgorithm(String algorithm)` エンド・ポイント識別アルゴリズムを設定します。
`void`	`setNeedClientAuth(boolean needClientAuth)` クライアント認証を必須とするかどうかを設定します。
`void`	`setProtocols(String[] protocols)` プロトコルの配列を設定します。
`void`	`setServerNames(List<SNIServerName> serverNames)` Server Name Indication (SNI)パラメータの必要な`SNIServerName`を設定します。
`void`	`setSNIMatchers(Collection<SNIMatcher> matchers)` Server Name Indication (SNI)パラメータの`SNIMatcher`を設定します。
`void`	`setUseCipherSuitesOrder(boolean honorOrder)` 暗号化方式群のローカル設定を適用する必要があるかどうかを設定します。
`void`	`setWantClientAuth(boolean wantClientAuth)` クライアント認証を要求するかどうかを設定します。

クラス java.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - SSLParameters
```
public SSLParameters()
```
    SSLParametersを構築します。
    暗号化方式群、プロトコル、暗号化アルゴリズム制約、エンドポイント識別アルゴリズム、およびサーバー名とサーバー名マッチャの値はnullに設定されます。useCipherSuitesOrder、wantClientAuth、およびneedClientAuthはfalseに設定されます。
  - SSLParameters
```
public SSLParameters(String[] cipherSuites)
```
    指定された暗号化方式群の配列からSSLParametersを構築します。
    このコンストラクタの呼出しは、引数なしのコンストラクタに続いてsetCipherSuites(cipherSuites);を呼び出すことと同じです。
    
    パラメータ:
    
    cipherSuites - 暗号化方式群の配列(nullも可)
  - SSLParameters
```
public SSLParameters(String[] cipherSuites,
                     String[] protocols)
```
    指定された暗号化方式群とプロトコルの配列からSSLParametersを構築します。
    このコンストラクタの呼出しは、引数なしのコンストラクタに続いてsetCipherSuites(cipherSuites); setProtocols(protocols);を呼び出すことと同じです。
    
    パラメータ:
    
    cipherSuites - 暗号化方式群の配列(nullも可)
    
    protocols - プロトコルの配列(nullも可)
- メソッドの詳細
  - getCipherSuites
```
public String[] getCipherSuites()
```
    暗号化方式群の配列のコピーを返します。設定されていない場合はnullを返します。
    
    戻り値:
    
    暗号化方式群の配列のコピー。設定されていない場合はnull。
  - setCipherSuites
```
public void setCipherSuites(String[] cipherSuites)
```
    暗号化方式群の配列を設定します。
    
    パラメータ:
    
    cipherSuites - 暗号化方式群の配列(nullも可)
  - getProtocols
```
public String[] getProtocols()
```
    プロトコルの配列のコピーを返します。設定されていない場合はnullを返します。
    
    戻り値:
    
    プロトコルの配列のコピー。設定されていない場合はnull。
  - setProtocols
```
public void setProtocols(String[] protocols)
```
    プロトコルの配列を設定します。
    
    パラメータ:
    
    protocols - プロトコルの配列(nullも可)
  - getWantClientAuth
```
public boolean getWantClientAuth()
```
    クライアント認証を要求するかどうかを返します。
    
    戻り値:
    
    クライアント認証を要求するかどうか。
  - setWantClientAuth
```
public void setWantClientAuth(boolean wantClientAuth)
```
    クライアント認証を要求するかどうかを設定します。このメソッドを呼び出すと、needClientAuthフラグがクリアされます。
    
    パラメータ:
    
    wantClientAuth - クライアント認証が要求されるかどうか
  - getNeedClientAuth
```
public boolean getNeedClientAuth()
```
    クライアント認証を必須とするかどうかを返します。
    
    戻り値:
    
    クライアント認証を必須とするかどうか。
  - setNeedClientAuth
```
public void setNeedClientAuth(boolean needClientAuth)
```
    クライアント認証を必須とするかどうかを設定します。このメソッドを呼び出すと、wantClientAuthフラグがクリアされます。
    
    パラメータ:
    
    needClientAuth - クライアント認証が必要かどうか
  - getAlgorithmConstraints
```
public AlgorithmConstraints getAlgorithmConstraints()
```
    暗号化アルゴリズムの制約を返します。
    
    戻り値:
    
    暗号化アルゴリズムの制約。制約が設定されていない場合はnull
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    
    setAlgorithmConstraints(AlgorithmConstraints)
  - setAlgorithmConstraints
```
public void setAlgorithmConstraints(AlgorithmConstraints constraints)
```
    実行環境によって構成された任意の制約に加えて使用される、暗号化アルゴリズムの制約を設定します。
    constraintsパラメータがnullではない場合は、SSL/TLSハンドシェークで使用されるすべての暗号化アルゴリズム、鍵およびアルゴリズム・パラメータが制約によって許容される必要があります。
    
    パラメータ:
    
    constraints - アルゴリズムの制約(またはnull)
    
    導入されたバージョン:
    
    1.7
  - getEndpointIdentificationAlgorithm
```
public String getEndpointIdentificationAlgorithm()
```
    エンド・ポイント識別アルゴリズムを取得します。
    
    戻り値:
    
    エンド・ポイント識別アルゴリズム。設定されていない場合はnull。
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    
    X509ExtendedTrustManager, setEndpointIdentificationAlgorithm(String)
  - setEndpointIdentificationAlgorithm
```
public void setEndpointIdentificationAlgorithm(String algorithm)
```
    エンド・ポイント識別アルゴリズムを設定します。
    algorithmパラメータがnullまたは空ではない場合は、SSL/TLSハンドシェークの際に、エンド・ポイント識別/検証プロシージャを実行する必要があります。これを行うのは、man-in-the-middle攻撃を回避するためです。
    
    パラメータ:
    
    algorithm - エンド・ポイント識別アルゴリズムの標準名を表す文字列(またはnull)。標準のアルゴリズム名については、「Java暗号化アーキテクチャAPIの仕様およびリファレンス」の「付録A」を参照してください。
    
    導入されたバージョン:
    
    1.7
    
    関連項目:
    
    X509ExtendedTrustManager
  - setServerNames
```
public final void setServerNames(List<SNIServerName> serverNames)
```
    Server Name Indication (SNI)パラメータの必要なSNIServerNameを設定します。
    このメソッドが役立つのは、クライアント・モードで動作するSSLSocketまたはSSLEngineの場合のみです。
    以後の変更から保護するために、serverNamesリストのクローンが作成されます。
    
    パラメータ:
    
    serverNames - 必要なSNIServerNameのリスト(またはnull)
    
    例外:
    
    NullPointerException - serverNamesにnull要素が含まれている場合
    
    IllegalArgumentException - serverNamesに同じ名前タイプの名前が複数個含まれている場合
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    SNIServerName, getServerNames()
  - getServerNames
```
public final List<SNIServerName> getServerNames()
```
    Server Name Indication (SNI)パラメータのすべてのSNIServerNameを含むList(何も設定されていない場合はnull)を返します。
    このメソッドが役立つのは、クライアント・モードで動作するSSLSocketまたはSSLEngineの場合のみです。
    SSL/TLS接続の場合、ベースとなるSSL/TLSプロバイダは特定のサーバー名タイプのデフォルト値を指定できます。クライアント・モードでは、サポート対象のサーバー名タイプでサーバーを特定可能な場合には常に、プロバイダはデフォルトでサーバー名表示を含めるようにすることをお薦めします。
    SSLSocket/SSLEngineの作成時にプロバイダがデフォルトのサーバー名表示を初期化することをお薦めします。次の例では、サーバー名は、ホスト名「www.example.com」とタイプStandardConstants.SNI_HOST_NAMEで初期化されたSNIHostNameのインスタンスとして表現できます。
```
     Socket socket =
         sslSocketFactory.createSocket("www.example.com", 443);
 
```
    または
```
     SSLEngine engine =
         sslContext.createSSLEngine("www.example.com", 443);
 
```
    戻り値:
    
    null、またはnull以外のSNIServerNameの不変なリスト
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    List, setServerNames(List)
  - setSNIMatchers
```
public final void setSNIMatchers(Collection<SNIMatcher> matchers)
```
    Server Name Indication (SNI)パラメータのSNIMatcherを設定します。
    このメソッドが役立つのは、サーバー・モードで動作するSSLSocketまたはSSLEngineの場合のみです。
    以後の変更から保護するために、matchersコレクションのクローンが作成されます。
    
    パラメータ:
    
    matchers - SNIMatcherのコレクション(またはnull)
    
    例外:
    
    NullPointerException - matchersにnull要素が含まれている場合
    
    IllegalArgumentException - matchersに同じ名前タイプの名前が複数個含まれている場合
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    Collection, SNIMatcher, getSNIMatchers()
  - getSNIMatchers
```
public final Collection<SNIMatcher> getSNIMatchers()
```
    Server Name Indication (SNI)パラメータのすべてのSNIMatcherを含むCollection(何も設定されていない場合はnull)を返します。
    このメソッドが役立つのは、サーバー・モードで動作するSSLSocketまたはSSLEngineの場合のみです。
    相互運用性を高めるため、プロバイダは一般にデフォルトのマッチャを定義しませんが、これは、サーバーがデフォルトでSNI拡張を無視してハンドシェークを続行するようにするためです。
    
    戻り値:
    
    null、またはnull以外のSNIMatcherの不変なコレクション
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    SNIMatcher, setSNIMatchers(Collection)
  - setUseCipherSuitesOrder
```
public final void setUseCipherSuitesOrder(boolean honorOrder)
```
    暗号化方式群のローカル設定を適用する必要があるかどうかを設定します。
    
    パラメータ:
    
    honorOrder - SSL/TLSハンドシェーク時に#getCipherSuitesで暗号化方式群のローカル順序を適用する必要があるかどうか。
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    getUseCipherSuitesOrder()
  - getUseCipherSuitesOrder
```
public final boolean getUseCipherSuitesOrder()
```
    暗号化方式群のローカル設定を適用する必要があるかどうかを返します。
    
    戻り値:
    
    SSL/TLSハンドシェーク時に#getCipherSuitesで暗号化方式群のローカル順序を適用する必要があるかどうか。
    
    導入されたバージョン:
    
    1.8
    
    関連項目:
    
    setUseCipherSuitesOrder(boolean)

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

クラスSSLParameters

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

メソッドのサマリー

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

コンストラクタの詳細

SSLParameters

SSLParameters

SSLParameters

メソッドの詳細

getCipherSuites

setCipherSuites

getProtocols

setProtocols

getWantClientAuth

setWantClientAuth

getNeedClientAuth

setNeedClientAuth

getAlgorithmConstraints

setAlgorithmConstraints

getEndpointIdentificationAlgorithm

setEndpointIdentificationAlgorithm

setServerNames

getServerNames

setSNIMatchers

getSNIMatchers

setUseCipherSuitesOrder

getUseCipherSuitesOrder