インターフェース RestClient.Builder
- 含まれているインターフェース:
- RestClient
RestClient
を作成するための可変ビルダー。方法の概要
修飾子と型メソッド説明apply
(ConsumerSE<RestClient.Builder> builderConsumer) 指定されたConsumer
をこのビルダーインスタンスに適用します。リクエストのベース URL を設定します。リクエスト用の基本URI
を構成します。build()
RestClient
インスタンスをビルドします。clone()
このRestClient.Builder
を複製します。defaultCookie
(StringSE cookie, StringSE... values) リクエストにまだそのような Cookie が含まれていない場合、すべてのリクエストに追加する Cookie を指定するグローバルオプション。defaultCookies
(ConsumerSE<MultiValueMap<StringSE, StringSE>> cookiesConsumer) これまでに宣言されたすべてのdefaultCookie(String, String...)
へのアクセスを提供し、追加、置換、削除する機能があります。defaultHeader
(StringSE header, StringSE... values) リクエストにまだヘッダーが含まれていない場合、すべてのリクエストに追加するヘッダーを指定するグローバルオプション。defaultHeaders
(ConsumerSE<HttpHeaders> headersConsumer) これまでに宣言されたすべてのデフォルトヘッダーにアクセスし、追加、置換、削除できるようにコンシューマーを提供します。defaultRequest
(ConsumerSE<RestClient.RequestHeadersSpec<?>> defaultRequest) 構築されるすべてのリクエストをカスタマイズするためのコンシューマーを提供します。defaultStatusHandler
(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。defaultStatusHandler
(ResponseErrorHandler errorHandler) すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。defaultUriVariables
(MapSE<StringSE, ?> defaultUriVariables) Map
SE で URI テンプレートを展開するときに使用するデフォルトの URL 変数値を設定します。messageConverters
(ConsumerSE<ListSE<HttpMessageConverter<?>>> configurer) RestClient
が使用するメッセージコンバーターを構成します。messageConverters
(ListSE<HttpMessageConverter<?>> messageConverters) RestClient
が使用するメッセージコンバーターを設定します。observationConvention
(ClientRequestObservationConvention observationConvention) リクエスト監視のメタデータの収集に使用するようにObservationConvention
を構成します。observationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) HTTP クライアント監視の記録に使用するようにObservationRegistry
を構成します。requestFactory
(ClientHttpRequestFactory requestFactory) 使用するClientHttpRequestFactory
を構成します。requestInitializer
(ClientHttpRequestInitializer initializer) 指定されたリクエスト初期化子を初期化子 チェーンの最後に追加します。requestInitializers
(ConsumerSE<ListSE<ClientHttpRequestInitializer>> initializersConsumer) 指定されたコンシューマーを使用してイニシャライザーを操作します。requestInterceptor
(ClientHttpRequestInterceptor interceptor) 指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。requestInterceptors
(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer) 指定されたコンシューマーを使用してインターセプタを操作します。uriBuilderFactory
(UriBuilderFactory uriBuilderFactory) 事前構成済みのUriBuilderFactory
インスタンスを提供します。
メソッドの詳細
baseUrl
リクエストのベース URL を設定します。効果的には次のショートカットです。String baseUrl = "https://abc.go.com/v1"; DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl); RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
DefaultUriBuilderFactory
は、指定された URL の URL リクエストが絶対である場合を除き、指定されたベース URL を持つすべてのリクエストの URL を準備するために使用されます。その場合、ベース URL は無視されます。注意 : このメソッドは
uriBuilderFactory(UriBuilderFactory)
と相互に排他的です。両方を使用した場合、ここで指定したbaseUrl
値は無視されます。- 戻り値:
- このビルダー
- 関連事項:
baseUrl
リクエスト用のベースURI
を構成します。実質的には次のショートカットになります:URI baseUrl = URI.create("https://abc.go.com/v1"); DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl.toString()); RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
DefaultUriBuilderFactory
は、指定された URL の URL リクエストが絶対である場合を除き、指定されたベース URL を持つすべてのリクエストの URL を準備するために使用されます。その場合、ベース URL は無視されます。注意 : このメソッドは
uriBuilderFactory(UriBuilderFactory)
と相互に排他的です。両方を使用した場合、ここで指定したbaseUrl
値は無視されます。- 戻り値:
- このビルダー
- 導入:
- 6.2
- 関連事項:
defaultUriVariables
Map
SE で URI テンプレートを展開するときに使用するデフォルトの URL 変数値を設定します。効果的には次のショートカットです。Map<String, ?> defaultVars = ...; DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(); factory.setDefaultVariables(defaultVars); RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
注意 : このメソッドは
uriBuilderFactory(UriBuilderFactory)
と相互に排他的です。両方を使用した場合、ここで指定したdefaultUriVariables
値は無視されます。uriBuilderFactory
事前構成済みのUriBuilderFactory
インスタンスを提供します。これは、次のショートカットプロパティの代替であり、効果的にオーバーライドされます。- パラメーター:
uriBuilderFactory
- 使用する URI ビルダーファクトリ- 戻り値:
- このビルダー
- 関連事項:
defaultHeader
リクエストにまだヘッダーが含まれていない場合、すべてのリクエストに追加するヘッダーを指定するグローバルオプション。- パラメーター:
header
- ヘッダー名values
- ヘッダー値- 戻り値:
- このビルダー
defaultHeaders
これまでに宣言されたすべてのデフォルトヘッダーにアクセスし、追加、置換、削除できるようにコンシューマーを提供します。- パラメーター:
headersConsumer
- コンシューマー- 戻り値:
- このビルダー
defaultCookie
リクエストにまだそのような Cookie が含まれていない場合、すべてのリクエストに追加する Cookie を指定するグローバルオプション。- パラメーター:
cookie
- クッキー名values
- クッキーの値- 導入:
- 6.2
defaultCookies
これまでに宣言されたすべてのdefaultCookie(String, String...)
へのアクセスを提供し、追加、置換、削除する機能があります。- パラメーター:
cookiesConsumer
- Cookie マップを使用する関数- 導入:
- 6.2
defaultRequest
構築されるすべてのリクエストをカスタマイズするためのコンシューマーを提供します。- パラメーター:
defaultRequest
- リクエストを変更するために使用するコンシューマー- 戻り値:
- このビルダー
defaultStatusHandler
RestClient.Builder defaultStatusHandler(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler) すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。- パラメーター:
statusPredicate
- レスポンスを一致させるerrorHandler
- 必ずではありませんが、通常は例外をスローするハンドラー- 戻り値:
- このビルダー
defaultStatusHandler
すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。レスポンスにエラーがあると主張する最初のステータスハンドラーが呼び出されます。他のデフォルトを無効にする場合は、すべてのステータスコードに一致する述語を持つ
defaultStatusHandler(Predicate, ResponseSpec.ErrorHandler)
の使用を検討してください。- パラメーター:
errorHandler
- 必ずではありませんが、通常は例外をスローするハンドラー- 戻り値:
- このビルダー
requestInterceptor
指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。- パラメーター:
interceptor
- チェーンに追加されるインターセプター- 戻り値:
- このビルダー
requestInterceptors
RestClient.Builder requestInterceptors(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer) 指定されたコンシューマーを使用してインターセプタを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはインターセプタの削除、順序の変更などに使用できます。- パラメーター:
interceptorsConsumer
- インターセプターのリストを使用する関数- 戻り値:
- このビルダー
requestInitializer
指定されたリクエスト初期化子を初期化子 チェーンの最後に追加します。- パラメーター:
initializer
- チェーンに追加されるイニシャライザー- 戻り値:
- このビルダー
requestInitializers
RestClient.Builder requestInitializers(ConsumerSE<ListSE<ClientHttpRequestInitializer>> initializersConsumer) 指定されたコンシューマーを使用してイニシャライザーを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはイニシャライザーの削除、順序の変更などに使用できます。- パラメーター:
initializersConsumer
- 初期化子リストを使用する関数- 戻り値:
- このビルダー
requestFactory
使用するClientHttpRequestFactory
を構成します。これは、基盤となる HTTP クライアントライブラリ (SSL など) のオプションをプラグインしたりカスタマイズしたりする場合に役立ちます。リクエストファクトリが指定されていない場合、
RestClient
は Apache Http クライアント、クラスパスで使用可能な場合は Jetty HTTP クライアントを使用し、java.net.http
モジュールがロードされている場合はデフォルトの JDK HttpClient を、それ以外の場合は単純なデフォルトを使用します。- パラメーター:
requestFactory
- 使用するリクエストファクトリ- 戻り値:
- このビルダー
messageConverters
RestClient
が使用するメッセージコンバーターを構成します。- パラメーター:
configurer
- デフォルトのHttpMessageConverter
のリストに適用するコンフィギュレータは、事前に初期化されています- 戻り値:
- このビルダー
- 関連事項:
messageConverters
RestClient
が使用するメッセージコンバーターを設定します。- パラメーター:
messageConverters
- 使用するHttpMessageConverter
のリスト- 戻り値:
- このビルダー
- 導入:
- 6.2
- 関連事項:
observationRegistry
RestClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) HTTP クライアント監視の記録に使用するようにObservationRegistry
を構成します。- パラメーター:
observationRegistry
- 使用する観測レジストリ- 戻り値:
- このビルダー
observationConvention
リクエスト監視のメタデータの収集に使用するようにObservationConvention
を構成します。何も指定されていない場合は、DefaultClientRequestObservationConvention
を使用します。- パラメーター:
observationConvention
- 使用する観察規則- 戻り値:
- このビルダー
apply
指定されたConsumer
をこのビルダーインスタンスに適用します。これは、事前にパッケージ化されたカスタマイズを適用できます。
- パラメーター:
builderConsumer
- 適用するコンシューマー- 戻り値:
- このビルダー
clone
RestClient.Builder clone()このRestClient.Builder
を複製します。build
RestClient build()RestClient
インスタンスをビルドします。