クラス RestTemplateBuilder
java.lang.ObjectSE
org.springframework.boot.web.client.RestTemplateBuilder
RestTemplate
の構成および作成に使用できるビルダー。converters
、error handlers
および UriTemplateHandlers
を登録するための便利なメソッドを提供します。 デフォルトでは、ビルドされた RestTemplate
は最も適切な ClientHttpRequestFactory
を使用しようとします。デフォルトのままにしたい場合は detectRequestFactory(false)
を呼び出します。典型的な自動構成 Spring Boot アプリケーションでは、このビルダーは Bean として利用でき、RestTemplate
が必要なときはいつでも挿入できます。
- 導入:
- 1.4.0
- 作成者:
- Stephane Nicoll, Phillip Webb, Andy Wilkinson, Brian Clozel, Dmytro Nosan, Kevin Strijbos, Ilya Lukyanovich, Scott Frederick
コンストラクターのサマリー
コンストラクターコンストラクター説明RestTemplateBuilder
(RestTemplateCustomizer... customizers) 新しいRestTemplateBuilder
インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明additionalCustomizers
(CollectionSE<? extends RestTemplateCustomizer> customizers) RestTemplate
に適用する必要があるRestTemplateCustomizers
を追加します。additionalCustomizers
(RestTemplateCustomizer... customizers) RestTemplate
に適用する必要があるRestTemplateCustomizers
を追加します。additionalInterceptors
(CollectionSE<? extends ClientHttpRequestInterceptor> interceptors) RestTemplate
で使用する必要があるClientHttpRequestInterceptors
を追加します。additionalInterceptors
(ClientHttpRequestInterceptor... interceptors) RestTemplate
で使用する必要があるClientHttpRequestInterceptors
を追加します。additionalMessageConverters
(CollectionSE<? extends HttpMessageConverter<?>> messageConverters) RestTemplate
で使用する必要があるHttpMessageConverters
を追加します。additionalMessageConverters
(HttpMessageConverter<?>... messageConverters) RestTemplate
で使用する必要があるHttpMessageConverters
を追加します。additionalRequestCustomizers
(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を追加します。additionalRequestCustomizers
(RestTemplateRequestCustomizer<?>... requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を追加します。basicAuthentication
(StringSE username, StringSE password) 事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。basicAuthentication
(StringSE username, StringSE password, CharsetSE charset) 事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。build()
新しいRestTemplate
インスタンスをビルドし、このビルダーを使用して構成します。<T extends RestTemplate>
T指定された型の新しいRestTemplate
インスタンスをビルドし、このビルダーを使用して構成します。このビルダーの設定を使用して、新しいClientHttpRequestFactory
インスタンスをビルドします。<T extends RestTemplate>
Tconfigure
(T restTemplate) このビルダーを使用して、提供されたRestTemplate
インスタンスを構成します。customizers
(CollectionSE<? extends RestTemplateCustomizer> customizers) RestTemplate
に適用するRestTemplateCustomizers
を設定します。customizers
(RestTemplateCustomizer... customizers) RestTemplate
に適用するRestTemplateCustomizers
を設定します。defaultHeader
(StringSE name, StringSE... values) 発信ClientHttpRequest
にまだ存在しない場合に設定されるデフォルトのヘッダーを追加します。RestTemplate
で使用するHttpMessageConverters
をデフォルトセットに設定します。detectRequestFactory
(boolean detectRequestFactory) ClientHttpRequestFactory
をクラスパスに基づいて検出する必要がある場合に設定します。errorHandler
(ResponseErrorHandler errorHandler) RestTemplate
で使用するResponseErrorHandler
を設定します。interceptors
(CollectionSE<ClientHttpRequestInterceptor> interceptors) RestTemplate
で使用するClientHttpRequestInterceptors
を設定します。interceptors
(ClientHttpRequestInterceptor... interceptors) RestTemplate
で使用するClientHttpRequestInterceptors
を設定します。messageConverters
(CollectionSE<? extends HttpMessageConverter<?>> messageConverters) RestTemplate
で使用するHttpMessageConverters
を設定します。messageConverters
(HttpMessageConverter<?>... messageConverters) RestTemplate
で使用するHttpMessageConverters
を設定します。requestCustomizers
(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を設定します。requestCustomizers
(RestTemplateRequestCustomizer<?>... requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を設定します。requestFactory
(ClassSE<? extends ClientHttpRequestFactory> requestFactoryType) RestTemplate
で使用するClientHttpRequestFactory
クラスを設定します。requestFactory
(FunctionSE<ClientHttpRequestFactorySettings, ClientHttpRequestFactory> requestFactoryFunction) requestFactory
(SupplierSE<ClientHttpRequestFactory> requestFactorySupplier) '/'
で始まる各リクエストに適用されるルート URL を設定します。setBufferRequestBody
(boolean bufferRequestBody) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。3.2.0 以降、バッファリングのサポートは Spring Framework 6.1 で削除されたため、3.4.0 では削除されています。setConnectTimeout
(DurationSE connectTimeout) 基礎となるClientHttpRequestFactory
の接続タイムアウトを設定します。setReadTimeout
(DurationSE readTimeout) 基になるClientHttpRequestFactory
の読み取りタイムアウトを設定します。setSslBundle
(SslBundle sslBundle) 基になるClientHttpRequestFactory
に SSL バンドルを設定します。uriTemplateHandler
(UriTemplateHandler uriTemplateHandler) RestTemplate
で使用するUriTemplateHandler
を設定します。
コンストラクターの詳細
RestTemplateBuilder
新しいRestTemplateBuilder
インスタンスを作成します。- パラメーター:
customizers
-RestTemplate
の構築時に適用されるRestTemplateCustomizers
メソッドの詳細
detectRequestFactory
ClientHttpRequestFactory
をクラスパスに基づいて検出する必要がある場合に設定します。true
の場合のデフォルト。- パラメーター:
detectRequestFactory
-ClientHttpRequestFactory
を検出する必要がある場合- 戻り値:
- 新しいビルダーインスタンス
rootUri
'/'
で始まる各リクエストに適用されるルート URL を設定します。これはUriTemplateHandler
をRestTemplate
に追加することで機能するため、ルート URL は、RestTemplate
メソッドのString
バリアントがリクエスト URL の指定に使用される場合にのみ適用されます。詳細については、RootUriTemplateHandler
を参照してください。- パラメーター:
rootUri
- ルート URI またはnull
- 戻り値:
- 新しいビルダーインスタンス
messageConverters
RestTemplate
で使用するHttpMessageConverters
を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。- パラメーター:
messageConverters
- 設定するコンバーター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
messageConverters
public RestTemplateBuilder messageConverters(CollectionSE<? extends HttpMessageConverter<?>> messageConverters) RestTemplate
で使用するHttpMessageConverters
を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。- パラメーター:
messageConverters
- 設定するコンバーター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalMessageConverters
public RestTemplateBuilder additionalMessageConverters(HttpMessageConverter<?>... messageConverters) RestTemplate
で使用する必要があるHttpMessageConverters
を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。- パラメーター:
messageConverters
- 追加するコンバーター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalMessageConverters
public RestTemplateBuilder additionalMessageConverters(CollectionSE<? extends HttpMessageConverter<?>> messageConverters) RestTemplate
で使用する必要があるHttpMessageConverters
を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。- パラメーター:
messageConverters
- 追加するコンバーター- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
defaultMessageConverters
RestTemplate
で使用するHttpMessageConverters
をデフォルトセットに設定します。このメソッドを呼び出すと、以前に定義されたコンバーターが置き換えられます。- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
interceptors
RestTemplate
で使用するClientHttpRequestInterceptors
を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。- パラメーター:
interceptors
- 設定するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 1.4.1
- 関連事項:
interceptors
RestTemplate
で使用するClientHttpRequestInterceptors
を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。- パラメーター:
interceptors
- 設定するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 1.4.1
- 関連事項:
additionalInterceptors
RestTemplate
で使用する必要があるClientHttpRequestInterceptors
を追加します。- パラメーター:
interceptors
- 追加するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 1.4.1
- 関連事項:
additionalInterceptors
public RestTemplateBuilder additionalInterceptors(CollectionSE<? extends ClientHttpRequestInterceptor> interceptors) RestTemplate
で使用する必要があるClientHttpRequestInterceptors
を追加します。- パラメーター:
interceptors
- 追加するインターセプター- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 1.4.1
- 関連事項:
requestFactory
public RestTemplateBuilder requestFactory(ClassSE<? extends ClientHttpRequestFactory> requestFactoryType) RestTemplate
で使用するClientHttpRequestFactory
クラスを設定します。- パラメーター:
requestFactoryType
- 使用するリクエストファクトリ型- 戻り値:
- 新しいビルダーインスタンス
requestFactory
public RestTemplateBuilder requestFactory(SupplierSE<ClientHttpRequestFactory> requestFactorySupplier) - パラメーター:
requestFactorySupplier
- リクエストファクトリのサプライヤー- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.0.0
requestFactory
public RestTemplateBuilder requestFactory(FunctionSE<ClientHttpRequestFactorySettings, ClientHttpRequestFactory> requestFactoryFunction) - パラメーター:
requestFactoryFunction
- ファクトリ機能をリクエストするための設定- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 3.0.0
- 関連事項:
uriTemplateHandler
RestTemplate
で使用するUriTemplateHandler
を設定します。- パラメーター:
uriTemplateHandler
- 使用する URI テンプレートハンドラー- 戻り値:
- 新しいビルダーインスタンス
errorHandler
RestTemplate
で使用するResponseErrorHandler
を設定します。- パラメーター:
errorHandler
- 使用するエラーハンドラー- 戻り値:
- 新しいビルダーインスタンス
basicAuthentication
事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。- パラメーター:
username
- ユーザー名password
- パスワード- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.1.0
- 関連事項:
basicAuthentication
public RestTemplateBuilder basicAuthentication(StringSE username, StringSE password, CharsetSE charset) 事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。- パラメーター:
username
- ユーザー名password
- パスワードcharset
- 使用する文字セット- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
defaultHeader
発信ClientHttpRequest
にまだ存在しない場合に設定されるデフォルトのヘッダーを追加します。- パラメーター:
name
- ヘッダーの名前values
- ヘッダー値- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
setConnectTimeout
基礎となるClientHttpRequestFactory
の接続タイムアウトを設定します。- パラメーター:
connectTimeout
- 接続タイムアウト- 戻り値:
- 新しいビルダーインスタンス。
- 導入:
- 2.1.0
setReadTimeout
基になるClientHttpRequestFactory
の読み取りタイムアウトを設定します。- パラメーター:
readTimeout
- 読み取りタイムアウト- 戻り値:
- 新しいビルダーインスタンス。
- 導入:
- 2.1.0
setBufferRequestBody
@DeprecatedSE(since="3.2.0", forRemoval=true) public RestTemplateBuilder setBufferRequestBody(boolean bufferRequestBody) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。3.2.0 以降、バッファリングのサポートは Spring Framework 6.1 で削除されたため、3.4.0 では削除されています。Spring Framework 6.1 ではバッファリングのサポートが削除されているため、効果はありません。- パラメーター:
bufferRequestBody
- bufferRequestBody パラメーターの値- 戻り値:
- 新しいビルダーインスタンス。
- 導入:
- 2.2.0
- 関連事項:
setSslBundle
基になるClientHttpRequestFactory
に SSL バンドルを設定します。- パラメーター:
sslBundle
- SSL バンドル- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 3.1.0
customizers
RestTemplate
に適用するRestTemplateCustomizers
を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。- パラメーター:
customizers
- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
customizers
RestTemplate
に適用するRestTemplateCustomizers
を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。- パラメーター:
customizers
- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
RestTemplate
に適用する必要があるRestTemplateCustomizers
を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers
- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
public RestTemplateBuilder additionalCustomizers(CollectionSE<? extends RestTemplateCustomizer> customizers) RestTemplate
に適用する必要があるRestTemplateCustomizers
を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers
- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
requestCustomizers
public RestTemplateBuilder requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を設定します。カスタマイザーは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザーが置き換えられます。- パラメーター:
requestCustomizers
- 設定するリクエストカスタマイザ- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
- 関連事項:
requestCustomizers
public RestTemplateBuilder requestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を設定します。カスタマイザーは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザーが置き換えられます。- パラメーター:
requestCustomizers
- 設定するリクエストカスタマイザ- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
- 関連事項:
additionalRequestCustomizers
public RestTemplateBuilder additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を追加します。カスタマイザーは、追加された順に適用されます。- パラメーター:
requestCustomizers
- 追加するリクエストカスタマイザ- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
- 関連事項:
additionalRequestCustomizers
public RestTemplateBuilder additionalRequestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers) ClientHttpRequest
に適用するRestTemplateRequestCustomizers
を追加します。カスタマイザーは、追加された順に適用されます。- パラメーター:
requestCustomizers
- 追加するリクエストカスタマイザ- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 2.2.0
- 関連事項:
build
新しいRestTemplate
インスタンスをビルドし、このビルダーを使用して構成します。- 戻り値:
- 構成済みの
RestTemplate
インスタンス。 - 関連事項:
build
指定された型の新しいRestTemplate
インスタンスをビルドし、このビルダーを使用して構成します。- 型パラメーター:
T
- rest テンプレートの型- パラメーター:
restTemplateClass
- 作成するテンプレート型- 戻り値:
- 構成済みの
RestTemplate
インスタンス。 - 関連事項:
configure
このビルダーを使用して、提供されたRestTemplate
インスタンスを構成します。- 型パラメーター:
T
- rest テンプレートの型- パラメーター:
restTemplate
- 構成するRestTemplate
- 戻り値:
- Rest テンプレートインスタンス
- 関連事項:
buildRequestFactory
このビルダーの設定を使用して、新しいClientHttpRequestFactory
インスタンスをビルドします。- 戻り値:
ClientHttpRequestFactory
またはnull
- 導入:
- 2.2.0