クラス RestTemplateBuilder

メソッドの詳細

• detectRequestFactory

  public RestTemplateBuilder detectRequestFactory(boolean detectRequestFactory)

  ClientHttpRequestFactory をクラスパスに基づいて検出する必要がある場合に設定します。true の場合のデフォルト。

  パラメーター:

  detectRequestFactory - ClientHttpRequestFactory を検出する必要がある場合

  戻り値:

  新しいビルダーインスタンス

• rootUri

  public RestTemplateBuilder rootUri(StringSE rootUri)

  '/' で始まる各リクエストに適用するルート URL を設定します。ルート URL は、リクエスト URL の指定に RestTemplate メソッドの String バリアントが使用される場合にのみ適用されます。

  パラメーター:

  rootUri - ルート URI または null

  戻り値:

  新しいビルダーインスタンス

• messageConverters

  public RestTemplateBuilder messageConverters(HttpMessageConverter<?>... messageConverters)

  RestTemplate で使用する HttpMessageConverters を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。

  パラメーター:

  messageConverters - 設定するコンバーター

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • additionalMessageConverters(HttpMessageConverter...)

• messageConverters

  public RestTemplateBuilder messageConverters(CollectionSE<? extends HttpMessageConverter<?>> messageConverters)

  RestTemplate で使用する HttpMessageConverters を設定します。この値を設定すると、以前に構成されたコンバーターが置き換えられ、ビルダーで構成されたコンバーターは RestTemplate のデフォルトのコンバーターを置き換えます。

  パラメーター:

  messageConverters - 設定するコンバーター

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • additionalMessageConverters(HttpMessageConverter...)

• additionalMessageConverters

  public RestTemplateBuilder additionalMessageConverters(HttpMessageConverter<?>... messageConverters)

  RestTemplate で使用する必要がある HttpMessageConverters を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。

  パラメーター:

  messageConverters - 追加するコンバーター

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • messageConverters(HttpMessageConverter...)

• additionalMessageConverters

  public RestTemplateBuilder additionalMessageConverters(CollectionSE<? extends HttpMessageConverter<?>> messageConverters)

  RestTemplate で使用する必要がある HttpMessageConverters を追加します。ビルダーで構成されたコンバーターは、RestTemplate のデフォルトのコンバーターを置き換えます。

  パラメーター:

  messageConverters - 追加するコンバーター

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • messageConverters(HttpMessageConverter...)

• defaultMessageConverters

  public RestTemplateBuilder defaultMessageConverters()

  RestTemplate で使用する HttpMessageConverters をデフォルトセットに設定します。このメソッドを呼び出すと、以前に定義されたコンバーターが置き換えられます。

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • messageConverters(HttpMessageConverter...)

• interceptors

  public RestTemplateBuilder interceptors(ClientHttpRequestInterceptor... interceptors)

  RestTemplate で使用する ClientHttpRequestInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。

  パラメーター:

  interceptors - 設定するインターセプター

  戻り値:

  新しいビルダーインスタンス

  導入:

  1.4.1

  関連事項:

  • additionalInterceptors(ClientHttpRequestInterceptor...)

• interceptors

  public RestTemplateBuilder interceptors(CollectionSE<ClientHttpRequestInterceptor> interceptors)

  RestTemplate で使用する ClientHttpRequestInterceptors を設定します。この値を設定すると、以前に定義されたインターセプターが置き換えられます。

  パラメーター:

  interceptors - 設定するインターセプター

  戻り値:

  新しいビルダーインスタンス

  導入:

  1.4.1

  関連事項:

  • additionalInterceptors(ClientHttpRequestInterceptor...)

• additionalInterceptors

  public RestTemplateBuilder additionalInterceptors(ClientHttpRequestInterceptor... interceptors)

  RestTemplate で使用する必要がある ClientHttpRequestInterceptors を追加します。

  パラメーター:

  interceptors - 追加するインターセプター

  戻り値:

  新しいビルダーインスタンス

  導入:

  1.4.1

  関連事項:

  • interceptors(ClientHttpRequestInterceptor...)

• additionalInterceptors

  public RestTemplateBuilder additionalInterceptors(CollectionSE<? extends ClientHttpRequestInterceptor> interceptors)

  RestTemplate で使用する必要がある ClientHttpRequestInterceptors を追加します。

  パラメーター:

  interceptors - 追加するインターセプター

  戻り値:

  新しいビルダーインスタンス

  導入:

  1.4.1

  関連事項:

  • interceptors(ClientHttpRequestInterceptor...)

• requestFactory

  public RestTemplateBuilder requestFactory(ClassSE<? extends ClientHttpRequestFactory> requestFactoryType)

  RestTemplate で使用する ClientHttpRequestFactory クラスを設定します。

  パラメーター:

  requestFactoryType - 使用するリクエストファクトリ型

  戻り値:

  新しいビルダーインスタンス

• requestFactory

  public RestTemplateBuilder requestFactory(SupplierSE<ClientHttpRequestFactory> requestFactorySupplier)

  新しい RestTemplate インスタンスを build() するたびに呼び出される ClientHttpRequestFactory の Supplier を設定します。

  パラメーター:

  requestFactorySupplier - リクエストファクトリのサプライヤー

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.0.0

• requestFactory

  public RestTemplateBuilder requestFactory(FunctionSE<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactoryFunction)

  新しい RestTemplate インスタンスを build() するたびに ClientHttpRequestFactory を提供するために呼び出されるリクエストファクトリ関数を設定します。

  パラメーター:

  requestFactoryFunction - ファクトリ機能をリクエストするための設定

  戻り値:

  新しいビルダーインスタンス

  導入:

  3.0.0

  関連事項:

  • ClientHttpRequestFactories

• uriTemplateHandler

  public RestTemplateBuilder uriTemplateHandler(UriTemplateHandler uriTemplateHandler)

  RestTemplate で使用する UriTemplateHandler を設定します。

  パラメーター:

  uriTemplateHandler - 使用する URI テンプレートハンドラー

  戻り値:

  新しいビルダーインスタンス

• errorHandler

  public RestTemplateBuilder errorHandler(ResponseErrorHandler errorHandler)

  RestTemplate で使用する ResponseErrorHandler を設定します。

  パラメーター:

  errorHandler - 使用するエラーハンドラー

  戻り値:

  新しいビルダーインスタンス

• basicAuthentication

  public RestTemplateBuilder basicAuthentication(StringSE username, StringSE password)

  事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。

  パラメーター:

  username - ユーザー名

  password - パスワード

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.1.0

  関連事項:

  • basicAuthentication(String, String, Charset)

• basicAuthentication

  public RestTemplateBuilder basicAuthentication(StringSE username, StringSE password, CharsetSE charset)

  事前にカスタム認証ヘッダーが設定されていない限り、指定されたユーザー名 / パスワードのペアを持つリクエストに HTTP 基本認証を追加します。

  パラメーター:

  username - ユーザー名

  password - パスワード

  charset - 使用する文字セット

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

• defaultHeader

  public RestTemplateBuilder defaultHeader(StringSE name, StringSE... values)

  発信 ClientHttpRequest にまだ存在しない場合に設定されるデフォルトのヘッダーを追加します。

  パラメーター:

  name - ヘッダーの名前

  values - ヘッダー値

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

• setConnectTimeout

  public RestTemplateBuilder setConnectTimeout(DurationSE connectTimeout)

  基礎となる ClientHttpRequestFactory の接続タイムアウトを設定します。

  パラメーター:

  connectTimeout - 接続タイムアウト

  戻り値:

  新しいビルダーインスタンス。

  導入:

  2.1.0

• setReadTimeout

  public RestTemplateBuilder setReadTimeout(DurationSE readTimeout)

  基になる 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

  関連事項:

  • SimpleClientHttpRequestFactory.setBufferRequestBody(boolean)
  • HttpComponentsClientHttpRequestFactory.setBufferRequestBody(boolean)

• setSslBundle

  public RestTemplateBuilder setSslBundle(SslBundle sslBundle)

  基になる ClientHttpRequestFactory に SSL バンドルを設定します。

  パラメーター:

  sslBundle - SSL バンドル

  戻り値:

  新しいビルダーインスタンス

  導入:

  3.1.0

• customizers

  public RestTemplateBuilder customizers(RestTemplateCustomizer... customizers)

  RestTemplate に適用する RestTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。

  パラメーター:

  customizers - 設定するカスタマイザー

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • additionalCustomizers(RestTemplateCustomizer...)

• customizers

  public RestTemplateBuilder customizers(CollectionSE<? extends RestTemplateCustomizer> customizers)

  RestTemplate に適用する RestTemplateCustomizers を設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。

  パラメーター:

  customizers - 設定するカスタマイザー

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • additionalCustomizers(RestTemplateCustomizer...)

• additionalCustomizers

  public RestTemplateBuilder additionalCustomizers(RestTemplateCustomizer... customizers)

  RestTemplate に適用する必要がある RestTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。

  パラメーター:

  customizers - 追加するカスタマイザー

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • customizers(RestTemplateCustomizer...)

• additionalCustomizers

  public RestTemplateBuilder additionalCustomizers(CollectionSE<? extends RestTemplateCustomizer> customizers)

  RestTemplate に適用する必要がある RestTemplateCustomizers を追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。

  パラメーター:

  customizers - 追加するカスタマイザー

  戻り値:

  新しいビルダーインスタンス

  関連事項:

  • customizers(RestTemplateCustomizer...)

• requestCustomizers

  public RestTemplateBuilder requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)

  ClientHttpRequest に適用する RestTemplateRequestCustomizers を設定します。カスタマイザーは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザーが置き換えられます。

  パラメーター:

  requestCustomizers - 設定するリクエストカスタマイザ

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

  関連事項:

  • additionalRequestCustomizers(RestTemplateRequestCustomizer...)

• requestCustomizers

  public RestTemplateBuilder requestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)

  ClientHttpRequest に適用する RestTemplateRequestCustomizers を設定します。カスタマイザーは、追加された順に適用されます。この値を設定すると、以前に構成されたリクエストカスタマイザーが置き換えられます。

  パラメーター:

  requestCustomizers - 設定するリクエストカスタマイザ

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

  関連事項:

  • additionalRequestCustomizers(RestTemplateRequestCustomizer...)

• additionalRequestCustomizers

  public RestTemplateBuilder additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)

  ClientHttpRequest に適用する RestTemplateRequestCustomizers を追加します。カスタマイザーは、追加された順に適用されます。

  パラメーター:

  requestCustomizers - 追加するリクエストカスタマイザ

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

  関連事項:

  • requestCustomizers(RestTemplateRequestCustomizer...)

• additionalRequestCustomizers

  public RestTemplateBuilder additionalRequestCustomizers(CollectionSE<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)

  ClientHttpRequest に適用する RestTemplateRequestCustomizers を追加します。カスタマイザーは、追加された順に適用されます。

  パラメーター:

  requestCustomizers - 追加するリクエストカスタマイザ

  戻り値:

  新しいビルダーインスタンス

  導入:

  2.2.0

  関連事項:

  • requestCustomizers(Collection)

• build

  public RestTemplate build()

  新しい RestTemplate インスタンスをビルドし、このビルダーを使用して構成します。

  戻り値:

  構成済みの RestTemplate インスタンス。

  関連事項:

  • build(Class)
  • configure(RestTemplate)

• build

  public <T extends RestTemplate> T build(ClassSE<T> restTemplateClass)

  指定された型の新しい RestTemplate インスタンスをビルドし、このビルダーを使用して構成します。

  型パラメーター:

  T - rest テンプレートの型

  パラメーター:

  restTemplateClass - 作成するテンプレート型

  戻り値:

  構成済みの RestTemplate インスタンス。

  関連事項:

  • build()
  • configure(RestTemplate)

• configure

  public <T extends RestTemplate> T configure(T restTemplate)

  このビルダーを使用して、提供された RestTemplate インスタンスを構成します。

  型パラメーター:

  T - rest テンプレートの型

  パラメーター:

  restTemplate - 構成する RestTemplate

  戻り値:

  Rest テンプレートインスタンス

  関連事項:

  • build()
  • build(Class)

• buildRequestFactory

  public ClientHttpRequestFactory buildRequestFactory()

  このビルダーの設定を使用して、新しい ClientHttpRequestFactory インスタンスをビルドします。

  戻り値:

  ClientHttpRequestFactory または null

  導入:

  2.2.0