クラス RestTemplateBuilder

方法の詳細

• baseUri

  public RestTemplateBuilder baseUri(StringSE baseUri)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  これは uriTemplateHandler(UriTemplateHandler) の特殊化であり、以前に設定された URI テンプレートハンドラーをすべて上書きします。

  パラメーター:

  baseUri - ベース URI

  戻り値:

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

  導入:

  4.1.0

• detectRequestFactory

  public RestTemplateBuilder detectRequestFactory(boolean detectRequestFactory)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

• rootUri

  @DeprecatedSE(forRemoval=true, since="4.1.0") public RestTemplateBuilder rootUri(@Nullable StringSE rootUri)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  4.1.0 以降、4.3.0 で削除され baseUri(String) を推奨

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

  パラメーター:

  rootUri - ルート URI または null

  戻り値:

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

• messageConverters

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalMessageConverters(HttpMessageConverter...)

• messageConverters

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalMessageConverters(HttpMessageConverter...)

• additionalMessageConverters

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • messageConverters(HttpMessageConverter...)

• additionalMessageConverters

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • messageConverters(HttpMessageConverter...)

• defaultMessageConverters

  public RestTemplateBuilder defaultMessageConverters()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  戻り値:

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

  関連事項:

  • messageConverters(HttpMessageConverter...)

• interceptors

  public RestTemplateBuilder interceptors(ClientHttpRequestInterceptor... interceptors)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalInterceptors(ClientHttpRequestInterceptor...)

• interceptors

  public RestTemplateBuilder interceptors(CollectionSE<ClientHttpRequestInterceptor> interceptors)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalInterceptors(ClientHttpRequestInterceptor...)

• additionalInterceptors

  public RestTemplateBuilder additionalInterceptors(ClientHttpRequestInterceptor... interceptors)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • interceptors(ClientHttpRequestInterceptor...)

• additionalInterceptors

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • interceptors(ClientHttpRequestInterceptor...)

• requestFactory

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • ClientHttpRequestFactoryBuilder.of(Class)
  • requestFactoryBuilder(ClientHttpRequestFactoryBuilder)

• requestFactory

  public RestTemplateBuilder requestFactory(SupplierSE<ClientHttpRequestFactory> requestFactorySupplier)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • ClientHttpRequestFactoryBuilder.of(Supplier)
  • requestFactoryBuilder(ClientHttpRequestFactoryBuilder)

• requestFactoryBuilder

  public RestTemplateBuilder requestFactoryBuilder(ClientHttpRequestFactoryBuilder<?> requestFactoryBuilder)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  新しい RestTemplate インスタンスを build() するたびに使用する ClientHttpRequestFactoryBuilder を設定します。

  パラメーター:

  requestFactoryBuilder - 使用する ClientHttpRequestFactoryBuilder

  戻り値:

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

  関連事項:

  • ClientHttpRequestFactoryBuilder

• uriTemplateHandler

  public RestTemplateBuilder uriTemplateHandler(UriTemplateHandler uriTemplateHandler)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  このメソッドは、以前に設定された baseUri(String) の設定を上書きします。

  パラメーター:

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

  戻り値:

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

• errorHandler

  public RestTemplateBuilder errorHandler(ResponseErrorHandler errorHandler)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

• basicAuthentication

  public RestTemplateBuilder basicAuthentication(StringSE username, StringSE password)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

  username - ユーザー名

  password - パスワード

  戻り値:

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

  関連事項:

  • basicAuthentication(String, String, Charset)

• basicAuthentication

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

  username - ユーザー名

  password - パスワード

  charset - 使用する文字セット

  戻り値:

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

• defaultHeader

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

  name - ヘッダーの名前

  values - ヘッダー値

  戻り値:

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

• clientSettings

  public RestTemplateBuilder clientSettings(HttpClientSettings clientSettings)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  HttpClientSettings を設定します。これにより、以前に設定された connectTimeout、readTimeout、sslBundle の値が置き換えられます。

  パラメーター:

  clientSettings - クライアント設定

  戻り値:

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

• clientSettings

  public RestTemplateBuilder clientSettings(UnaryOperatorSE<HttpClientSettings> clientSettingsCustomizer)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  指定されたカスタマイザーを使用して HttpClientSettings を更新します。

  パラメーター:

  clientSettingsCustomizer - クライアントの提供時設定を更新するための UnaryOperatorSE

  戻り値:

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

• connectTimeout

  public RestTemplateBuilder connectTimeout(DurationSE connectTimeout)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

  connectTimeout - 接続タイムアウト

  戻り値:

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

• readTimeout

  public RestTemplateBuilder readTimeout(DurationSE readTimeout)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  基になる ClientHttpRequestFactory の読み取りタイムアウトを設定します。

  パラメーター:

  readTimeout - 読み取りタイムアウト

  戻り値:

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

• cookieHandling

  public RestTemplateBuilder cookieHandling(HttpCookieHandling cookieHandling)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  基盤となる ClientHttpRequestFactory の Cookie 処理戦略を設定します。

  パラメーター:

  cookieHandling - クッキー処理戦略

  戻り値:

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

  導入:

  4.1.0

• redirects

  public RestTemplateBuilder redirects(HttpRedirects redirects)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  基礎となる ClientHttpRequestFactory のリダイレクト戦略を設定します。

  パラメーター:

  redirects - リダイレクト戦略

  戻り値:

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

• sslBundle

  public RestTemplateBuilder sslBundle(SslBundle sslBundle)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

  sslBundle - SSL バンドル

  戻り値:

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

• customizers

  public RestTemplateBuilder customizers(RestTemplateCustomizer... customizers)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalCustomizers(RestTemplateCustomizer...)

• customizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalCustomizers(RestTemplateCustomizer...)

• additionalCustomizers

  public RestTemplateBuilder additionalCustomizers(RestTemplateCustomizer... customizers)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • customizers(RestTemplateCustomizer...)

• additionalCustomizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • customizers(RestTemplateCustomizer...)

• requestCustomizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalRequestCustomizers(RestTemplateRequestCustomizer...)

• requestCustomizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • additionalRequestCustomizers(RestTemplateRequestCustomizer...)

• additionalRequestCustomizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • requestCustomizers(RestTemplateRequestCustomizer...)

• additionalRequestCustomizers

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  パラメーター:

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

  戻り値:

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

  関連事項:

  • requestCustomizers(Collection)

• build

  public RestTemplate build()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  戻り値:

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

  関連事項:

  • build(Class)
  • configure(RestTemplate)

• build

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  型パラメーター:

  T - rest テンプレートの型

  パラメーター:

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

  戻り値:

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

  関連事項:

  • build()
  • configure(RestTemplate)

• configure

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

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  型パラメーター:

  T - rest テンプレートの型

  パラメーター:

  restTemplate - 構成する RestTemplate

  戻り値:

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

  関連事項:

  • build()
  • build(Class)

• buildRequestFactory

  public @Nullable ClientHttpRequestFactory buildRequestFactory()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

  戻り値:

  ClientHttpRequestFactory または null

• requestFactoryBuilder

  public @Nullable ClientHttpRequestFactoryBuilder<?> requestFactoryBuilder()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  このビルダーの設定を使用して ClientHttpRequestFactoryBuilder インスタンスを返します。

  戻り値:

  ClientHttpRequestFactoryBuilder または null