ClientBuilder (Jakarta EE 8 Specification API)

java.lang.ObjectSE
- javax.ws.rs.client.ClientBuilder

実装されたすべてのインターフェース:
Configurable<ClientBuilder>
```
public abstract class ClientBuilder
extends ObjectSE
implements Configurable<ClientBuilder>
```
Client インスタンスのブートストラップに使用されるクライアント API へのメインエントリポイント。
導入:
2.0
作成者:
Marek Potociar

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY` `newBuilder()` から返される `ClientBuilder` 実装を識別するプロパティの名前。

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected ClientBuilder()
カスタム実装が ClientBuilder クラスを継承できるようにします。

コンストラクター
修飾子	コンストラクターと説明
`protected`	`ClientBuilder()` カスタム実装が `ClientBuilder` クラスを継承できるようにします。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`abstract Client`	`build()` このクライアントビルダーで以前に指定したすべての構成を使用して、新しいクライアントインスタンスを構築します。
`abstract ClientBuilder`	`connectTimeout(long timeout, TimeUnitSE unit)` 接続タイムアウトを設定します。
`abstract ClientBuilder`	`executorService(ExecutorServiceSE executorService)` クライアント側の `ExecutorService`SE を設定します。
`abstract ClientBuilder`	`hostnameVerifier(HostnameVerifierSE verifier)` クライアントがエンドポイントのホスト名をその識別情報と照合するために使用するホスト名検証を設定します。
`abstract ClientBuilder`	`keyStore(KeyStoreSE keyStore, char[] password)` クライアント側のキーストアを設定します。
`ClientBuilder`	`keyStore(KeyStoreSE keyStore, StringSE password)` クライアント側のキーストアを設定します。
`static ClientBuilder`	`newBuilder()` 実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しい `ClientBuilder` インスタンスを作成します。
`static Client`	`newClient()` 実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しい `Client` インスタンスを作成します。
`static Client`	`newClient(Configuration configuration)` 実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しいカスタム構成の `Client` インスタンスを作成します。
`abstract ClientBuilder`	`readTimeout(long timeout, TimeUnitSE unit)` 読み取りタイムアウトを設定します。
`abstract ClientBuilder`	`scheduledExecutorService(ScheduledExecutorServiceSE scheduledExecutorService)` クライアント側の `ScheduledExecutorService`SE を設定します。
`abstract ClientBuilder`	`sslContext(SSLContextSE sslContext)` この SSL コンテキストを使用しているクライアントインスタンスによって作成された `web targets` からサーバーエンドポイントへの保護されたトランスポート接続を作成するときに使用される SSL コンテキストを設定します。
`abstract ClientBuilder`	`trustStore(KeyStoreSE trustStore)` クライアント側のトラストストアを設定します。
`abstract ClientBuilder`	`withConfig(Configuration config)` 内部構成状態を外部提供構成状態に設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース javax.ws.rs.core.Configurable から継承されたメソッド
getConfiguration, property, register, register, register, register, register, register, register, register

- フィールドの詳細
  - JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY
```
public static final StringSE JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY
```
    newBuilder() から返される ClientBuilder 実装を識別するプロパティの名前。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - ClientBuilder
```
protected ClientBuilder()
```
    カスタム実装が ClientBuilder クラスを継承できるようにします。
- メソッドの詳細
  - newBuilder
```
public static ClientBuilder newBuilder()
```
    実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しい ClientBuilder インスタンスを作成します。
    戻り値:
    新しいクライアントビルダーインスタンス。
  - newClient
```
public static Client newClient()
```
    実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しい Client インスタンスを作成します。
    戻り値:
    新しいクライアントインスタンス。
  - newClient
```
public static Client newClient(Configuration configuration)
```
    実装プロバイダーが提供するデフォルトのクライアントビルダー実装クラスを使用して、新しいカスタム構成の Client インスタンスを作成します。
    パラメーター:
    configuration - 新しいクライアントインスタンスの初期構成を提供するために使用されるデータ。
    戻り値:
    新しく構成されたクライアントインスタンス。
  - withConfig
```
public abstract ClientBuilder withConfig(Configuration config)
```
    内部構成状態を外部提供構成状態に設定します。
    パラメーター:
    config - この構成可能インスタンスの構成を置き換える外部構成状態。
    戻り値:
    更新されたクライアントビルダーインスタンス。
  - sslContext
```
public abstract ClientBuilder sslContext(SSLContextSE sslContext)
```
    この SSL コンテキストを使用しているクライアントインスタンスによって作成された web targets からサーバーエンドポイントへの保護されたトランスポート接続を作成するときに使用される SSL コンテキストを設定します。SSL コンテキストでは、キーマネージャーや信頼マネージャーなど、すべてのセキュリティインフラストラクチャが初期化されていることが期待されます。
    SSL コンテキストインスタンスを設定すると、以前に指定した key store または trust store 値がリセットされます。
    パラメーター:
    sslContext - セキュアソケットファクトリまたは SSL enginesSE のファクトリとして機能するセキュアソケットプロトコルの実装。null であってはなりません。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    NullPointerExceptionSE - sslContext パラメーターが null の場合。
    関連事項:
    keyStore(java.security.KeyStore, char[]), keyStore(java.security.KeyStore, String), trustStore(java.security.KeyStore)
  - keyStore
```
public abstract ClientBuilder keyStore(KeyStoreSE keyStore,
                                       char[] password)
```
    クライアント側のキーストアを設定します。鍵ストアには、クライアントの秘密鍵と、対応する公開鍵を持つ証明書が含まれています。
    キーストアインスタンスを設定すると、以前に指定された SSL context instance 値がリセットされます。
    カスタムキーストアは、双方向 SSL 接続（クライアント証明書認証）のカスタムセットアップを有効にする場合にのみ必要です。
    パラメーター:
    keyStore - クライアント側のキーストア。null であってはなりません。
    password - クライアントキーパスワード。null であってはなりません。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    NullPointerExceptionSE - 指定されたパラメーターのいずれかが null の場合。
    関連事項:
    sslContext(javax.net.ssl.SSLContext), keyStore(java.security.KeyStore, String), trustStore(java.security.KeyStore)
  - keyStore
```
public ClientBuilder keyStore(KeyStoreSE keyStore,
                              StringSE password)
```
    クライアント側のキーストアを設定します。鍵ストアには、クライアントの秘密鍵と、対応する公開鍵を持つ証明書が含まれています。
    キーストアインスタンスを設定すると、以前に指定された SSL context instance 値がリセットされます。
    パスワードデータの操作のセキュリティを向上させ、Java 文字列オブジェクトにパスワードを格納しないようにするために、メソッドの keyStore(java.security.KeyStore, char[]) バージョンを利用できます。また、カスタムキーストアは、双方向 SSL 接続（クライアント証明書認証）のカスタムセットアップを有効にする場合にのみ必要です。
    パラメーター:
    keyStore - クライアント側のキーストア。null であってはなりません。
    password - クライアントキーパスワード。null であってはなりません。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    NullPointerExceptionSE - 指定されたパラメーターのいずれかが null の場合。
    関連事項:
    sslContext(javax.net.ssl.SSLContext), keyStore(java.security.KeyStore, char[]), trustStore(java.security.KeyStore)
  - trustStore
```
public abstract ClientBuilder trustStore(KeyStoreSE trustStore)
```
    クライアント側のトラストストアを設定します。トラストストアには、クライアントが通信することを期待している他の当事者からの証明書、または他の当事者を識別することが信頼されている認証局からの証明書が含まれていることが期待されます。
    トラストストアインスタンスを設定すると、以前に指定された SSL context instance 値がリセットされます。
    カスタムトラストストアまたはカスタム SSL コンテキストが指定されていない場合、トラスト管理はデフォルトの Java ランタイム設定を使用するように構成されます。
    パラメーター:
    trustStore - クライアント側のトラストストア。null であってはなりません。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    NullPointerExceptionSE - 指定されたトラストストアパラメーターが null の場合。
    関連事項:
    sslContext(javax.net.ssl.SSLContext), keyStore(java.security.KeyStore, char[]), keyStore(java.security.KeyStore, String)
  - hostnameVerifier
```
public abstract ClientBuilder hostnameVerifier(HostnameVerifierSE verifier)
```
    クライアントがエンドポイントのホスト名をその識別情報と照合するために使用するホスト名検証を設定します。
    パラメーター:
    verifier - ホスト名検証。
    戻り値:
    更新されたクライアントビルダーインスタンス。
  - executorService
```
public abstract ClientBuilder executorService(ExecutorServiceSE executorService)
```
    クライアント側の ExecutorServiceSE を設定します。
    提供されたエグゼキューターサービスは、非同期タスクの実行に使用されます。
    Jakarta EE コンテナーで実行する場合、実装はデフォルトでコンテナー管理のエグゼキューターサービスを使用する必要があります。Java SE では、デフォルトは実装固有です。どちらの場合でも、このメソッドを呼び出すと、デフォルトがオーバーライドされます。
    パラメーター:
    executorService - 非同期呼び出しに使用されるエグゼキューターサービス。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    導入:
    2.1
    関連事項:
    Invocation.Builder.async(), Invocation.Builder.rx(), RxInvokerProvider.getRxInvoker(SyncInvoker, ExecutorService)
  - scheduledExecutorService
```
public abstract ClientBuilder scheduledExecutorService(ScheduledExecutorServiceSE scheduledExecutorService)
```
    クライアント側の ScheduledExecutorServiceSE を設定します。
    提供されたエグゼキューターサービスは、スケジュールされた非同期タスクの実行に使用されます。
    Jakarta EE コンテナーで実行する場合、実装は、デフォルトでコンテナー管理のスケジュール済み実行サービスを使用する必要があります。Java SE では、デフォルトは実装固有です。どちらの場合でも、このメソッドを呼び出すと、デフォルトがオーバーライドされます。
    パラメーター:
    scheduledExecutorService - スケジュールされた非同期呼び出しに使用されるエグゼキューターサービス。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    導入:
    2.1
    関連事項:
    SseEventSource.Builder.reconnectingEvery(long, TimeUnit)
  - connectTimeout
```
public abstract ClientBuilder connectTimeout(long timeout,
                                             TimeUnitSE unit)
```
    接続タイムアウトを設定します。
    値 0 は無限大を表します。負の値は許可されていません。
    パラメーター:
    timeout - 待機する最大時間。
    unit - タイムアウト引数の時間単位。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    IllegalArgumentExceptionSE - 値が負の場合。
    導入:
    2.1
  - readTimeout
```
public abstract ClientBuilder readTimeout(long timeout,
                                          TimeUnitSE unit)
```
    読み取りタイムアウトを設定します。
    値は、レスポンスを読み取るためのタイムアウトです。定義された時間内にサーバーがレスポンスしない場合は、TimeoutExceptionSE が原因として ProcessingException がスローされます。
    値 0 は無限大を表します。負の値は許可されていません。
    パラメーター:
    timeout - 待機する最大時間。
    unit - タイムアウト引数の時間単位。
    戻り値:
    更新されたクライアントビルダーインスタンス。
    例外:
    IllegalArgumentExceptionSE - 値が負の場合。
    導入:
    2.1
  - build
```
public abstract Client build()
```
    このクライアントビルダーで以前に指定したすべての構成を使用して、新しいクライアントインスタンスを構築します。
    戻り値:
    新しいクライアントインスタンス。

クラス ClientBuilder

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

インターフェース javax.ws.rs.core.Configurable から継承されたメソッド

フィールドの詳細

JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY

コンストラクターの詳細

ClientBuilder

メソッドの詳細

newBuilder

newClient

newClient

withConfig

sslContext

keyStore

keyStore

trustStore

hostnameVerifier

executorService

scheduledExecutorService

connectTimeout

readTimeout

build