インターフェース RestClient.Builder

メソッドの詳細

• baseUrl

  RestClient.Builder baseUrl(StringSE 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 値は無視されます。

  戻り値:

  このビルダー

  関連事項:

  • DefaultUriBuilderFactory(String)
  • uriBuilderFactory(UriBuilderFactory)

• defaultUriVariables

  RestClient.Builder defaultUriVariables(MapSE<StringSE,?> defaultUriVariables)

  MapSE で URI テンプレートを展開するときに使用するデフォルトの URL 変数値を設定します。効果的には次のショートカットです。

   Map<String, ?> defaultVars = ...;
   DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
   factory.setDefaultVariables(defaultVars);
   RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
   

  注意 : このメソッドは uriBuilderFactory(UriBuilderFactory) と相互に排他的です。両方を使用した場合、ここで指定した defaultUriVariables 値は無視されます。

  戻り値:

  このビルダー

  関連事項:

  • DefaultUriBuilderFactory.setDefaultUriVariables(Map)
  • uriBuilderFactory(UriBuilderFactory)

• uriBuilderFactory

  RestClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

  事前構成済みの UriBuilderFactory インスタンスを提供します。これは、次のショートカットプロパティの代替であり、効果的にオーバーライドされます。

  • baseUrl(String)
  • defaultUriVariables(Map)。

  パラメーター:

  uriBuilderFactory - 使用する URI ビルダーファクトリ

  戻り値:

  このビルダー

  関連事項:

  • baseUrl(String)
  • defaultUriVariables(Map)

• defaultHeader

  RestClient.Builder defaultHeader(StringSE header, StringSE... values)

  リクエストにまだヘッダーが含まれていない場合、すべてのリクエストに追加するヘッダーを指定するグローバルオプション。

  パラメーター:

  header - ヘッダー名

  values - ヘッダー値

  戻り値:

  このビルダー

• defaultHeaders

  RestClient.Builder defaultHeaders(ConsumerSE<HttpHeaders> headersConsumer)

  これまでに宣言されたすべてのデフォルトヘッダーにアクセスし、追加、置換、削除できるようにコンシューマーを提供します。

  パラメーター:

  headersConsumer - コンシューマー

  戻り値:

  このビルダー

• defaultRequest

  RestClient.Builder defaultRequest(ConsumerSE<RestClient.RequestHeadersSpec<?>> defaultRequest)

  構築されるすべてのリクエストをカスタマイズするためのコンシューマーを提供します。

  パラメーター:

  defaultRequest - リクエストを変更するために使用するコンシューマー

  戻り値:

  このビルダー

• defaultStatusHandler

  RestClient.Builder defaultStatusHandler(PredicateSE<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)

  すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。

  パラメーター:

  statusPredicate - レスポンスを一致させる

  errorHandler - 必ずではありませんが、通常は例外をスローするハンドラー

  戻り値:

  このビルダー

• defaultStatusHandler

  RestClient.Builder defaultStatusHandler(ResponseErrorHandler errorHandler)

  すべてのレスポンスに適用するデフォルトのステータスハンドラーを登録します。このようなデフォルトのハンドラーは、登録された順序で適用され、特定のレスポンス用に登録された他のハンドラーの後に適用されます。

  パラメーター:

  errorHandler - 必ずではありませんが、通常は例外をスローするハンドラー

  戻り値:

  このビルダー

• requestInterceptor

  RestClient.Builder requestInterceptor(ClientHttpRequestInterceptor interceptor)

  指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。

  パラメーター:

  interceptor - チェーンに追加されるインターセプター

  戻り値:

  このビルダー

• requestInterceptors

  RestClient.Builder requestInterceptors(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer)

  指定されたコンシューマーを使用してインターセプタを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはインターセプタの削除、順序の変更などに使用できます。

  パラメーター:

  interceptorsConsumer - インターセプターのリストを使用する関数

  戻り値:

  このビルダー

• requestInitializer

  RestClient.Builder requestInitializer(ClientHttpRequestInitializer initializer)

  指定されたリクエスト初期化子を初期化子 チェーンの最後に追加します。

  パラメーター:

  initializer - チェーンに追加されるイニシャライザー

  戻り値:

  このビルダー

• requestInitializers

  RestClient.Builder requestInitializers(ConsumerSE<ListSE<ClientHttpRequestInitializer>> initializersConsumer)

  指定されたコンシューマーを使用してイニシャライザーを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはイニシャライザーの削除、順序の変更などに使用できます。

  パラメーター:

  initializersConsumer - 初期化子リストを使用する関数

  戻り値:

  このビルダー

• requestFactory

  RestClient.Builder requestFactory(ClientHttpRequestFactory requestFactory)

  使用する ClientHttpRequestFactory を構成します。これは、基盤となる HTTP クライアントライブラリ（SSL など）のプラグインやカスタマイズオプションに役立ちます。

  リクエストファクトリが指定されていない場合、RestClient は Apache Http クライアント、クラスパスで使用可能な場合は Jetty HTTP クライアントを使用し、java.net.http モジュールがロードされている場合はデフォルトの JDK HttpClient を、それ以外の場合は単純なデフォルトを使用します。

  パラメーター:

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

  戻り値:

  このビルダー

• messageConverters

  RestClient.Builder messageConverters(ConsumerSE<ListSE<HttpMessageConverter<?>>> configurer)

  RestClient が使用するメッセージコンバーターを構成します。

  パラメーター:

  configurer - 適用するコンフィギュレーター

  戻り値:

  このビルダー

• observationRegistry

  RestClient.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

  HTTP クライアント監視の記録に使用するように ObservationRegistry を構成します。

  パラメーター:

  observationRegistry - 使用する観測レジストリ

  戻り値:

  このビルダー

• observationConvention

  RestClient.Builder observationConvention(ClientRequestObservationConvention observationConvention)

  リクエスト監視のメタデータの収集に使用するように ObservationConvention を構成します。何も指定されていない場合は、DefaultClientRequestObservationConvention を使用します。

  パラメーター:

  observationConvention - 使用する観測規則

  戻り値:

  このビルダー

• apply

  RestClient.Builder apply(ConsumerSE<RestClient.Builder> builderConsumer)

  指定された Consumer をこのビルダーインスタンスに適用します。

  これは、事前にパッケージ化されたカスタマイズを適用できます。

  パラメーター:

  builderConsumer - 適用するコンシューマー

  戻り値:

  このビルダー

• clone

  RestClient.Builder clone()

  この RestClient.Builder を複製します。

• build

  RestClient build()

  RestClient インスタンスをビルドします。