クラス TestRestTemplate

java.lang.ObjectSE
org.springframework.boot.test.web.client.TestRestTemplate

public class TestRestTemplate extends ObjectSE
統合テストに適した RestTemplate の便利な代替。TestRestTemplate はフォールトトレラントです。これは、4xx および 5xx がスローされる例外にはならず、代わりに response entity およびその status code を介して検出できることを意味します。

TestRestTemplate はオプションで Basic 認証ヘッダーを運ぶことができます。Apache Http クライアント 4.3.2 以上が利用可能な場合 (推奨)、それがクライアントとして使用され、デフォルトでは Cookie とリダイレクトを無視するように設定されます。

メモ: インジェクションの問題を防ぐため、このクラスは意図的に RestTemplate を継承しません。基礎となる RestTemplate にアクセスする必要がある場合は、getRestTemplate() を使用してください。

組み込みサーバーで @SpringBootTest アノテーションを使用している場合、TestRestTemplate は自動的に使用可能になり、テストに @Autowired にすることができます。カスタマイズが必要な場合(たとえば、メッセージコンバーターを追加する場合)、RestTemplateBuilder @Bean を使用します。

導入:
1.4.0
作成者:
Dave Syer, Phillip Webb, Andy Wilkinson, Kristine Jetzke, Dmytro Nosan
  • コンストラクターの詳細

    • TestRestTemplate

      public TestRestTemplate(RestTemplateBuilder restTemplateBuilder)
      新しい TestRestTemplate インスタンスを作成します。
      パラメーター:
      restTemplateBuilder - 基礎となる RestTemplate の構成に使用されるビルダー
      導入:
      1.4.1
    • TestRestTemplate

      public TestRestTemplate(TestRestTemplate.HttpClientOption... httpClientOptions)
      新しい TestRestTemplate インスタンスを作成します。
      パラメーター:
      httpClientOptions - Apache HTTP クライアントを使用する場合に使用するクライアントオプション
    • TestRestTemplate

      public TestRestTemplate(StringSE username, StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions)
      指定された資格情報で新しい TestRestTemplate インスタンスを作成します。
      パラメーター:
      username - 使用するユーザー名 (または null)
      password - パスワード (または null)
      httpClientOptions - Apache HTTP クライアントを使用する場合に使用するクライアントオプション
    • TestRestTemplate

      public TestRestTemplate(RestTemplateBuilder builder, StringSE username, StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions)
      指定された資格情報で新しい TestRestTemplate インスタンスを作成します。
      パラメーター:
      builder - 基礎となる RestTemplate の構成に使用されるビルダー
      username - 使用するユーザー名 (または null)
      password - パスワード (または null)
      httpClientOptions - Apache HTTP クライアントを使用する場合に使用するクライアントオプション
      導入:
      2.0.0
  • メソッドの詳細

    • setUriTemplateHandler

      public void setUriTemplateHandler(UriTemplateHandler handler)
      URI テンプレートを展開するために使用する UriTemplateHandler を構成します。デフォルトでは、Spring の URI テンプレートのサポートに依存する DefaultUriBuilderFactory が使用され、エンコードおよび共通ベース URL の先頭の動作をカスタマイズするいくつかの便利なプロパティを公開します。別の実装を使用して、外部 URI テンプレートライブラリをプラグインできます。
      パラメーター:
      handler - 使用する URI テンプレートハンドラー
    • getRootUri

      public StringSE getRootUri()
      ルート URI が適用されていない場合は、RestTemplateBuilder.rootUri(String) または "" によって適用されたルート URI を返します。
      戻り値:
      ルート URI
    • getForObject

      public <T> T getForObject(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables)
      指定された URL で GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      urlVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      関連事項:
    • getForObject

      public <T> T getForObject(StringSE url, ClassSE<T> responseType, MapSE<StringSE,?> urlVariables)
      URI テンプレートで GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      urlVariables - URI テンプレートの変数を含むマップ
      戻り値:
      変換されたオブジェクト
      関連事項:
    • getForObject

      public <T> T getForObject(URISE url, ClassSE<T> responseType)
      URL で GET を実行して表現を取得します。レスポンス(ある場合)が変換されて返されます。
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      関連事項:
    • getForEntity

      public <T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables)
      指定された URL で GET を実行して、エンティティを取得します。レスポンスは変換され、ResponseEntity に保存されます。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      urlVariables - テンプレートを展開する変数
      戻り値:
      エンティティ
      関連事項:
    • getForEntity

      public <T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, MapSE<StringSE,?> urlVariables)
      URI テンプレートで GET を実行して、表現を取得します。レスポンスは変換され、ResponseEntity に保存されます。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      urlVariables - URI テンプレートの変数を含むマップ
      戻り値:
      変換されたオブジェクト
      関連事項:
    • getForEntity

      public <T> ResponseEntity<T> getForEntity(URISE url, ClassSE<T> responseType)
      URL で GET を実行して表現を取得します。レスポンスは変換され、ResponseEntity に保存されます。
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      関連事項:
    • headForHeaders

      public HttpHeaders headForHeaders(StringSE url, ObjectSE... urlVariables)
      URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      パラメーター:
      url - URL
      urlVariables - テンプレートを展開する変数
      戻り値:
      そのリソースのすべての HTTP ヘッダー
      関連事項:
    • headForHeaders

      public HttpHeaders headForHeaders(StringSE url, MapSE<StringSE,?> urlVariables)
      URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      パラメーター:
      url - URL
      urlVariables - URI テンプレートの変数を含むマップ
      戻り値:
      そのリソースのすべての HTTP ヘッダー
      関連事項:
    • headForHeaders

      public HttpHeaders headForHeaders(URISE url)
      URL で指定されたリソースのすべてのヘッダーを取得します。
      パラメーター:
      url - URL
      戻り値:
      そのリソースのすべての HTTP ヘッダー
      関連事項:
    • postForLocation

      public URISE postForLocation(StringSE url, ObjectSE request, ObjectSE... urlVariables)
      指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Location ヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      urlVariables - テンプレートを展開する変数
      戻り値:
      Location ヘッダーの値
      関連事項:
    • postForLocation

      public URISE postForLocation(StringSE url, ObjectSE request, MapSE<StringSE,?> urlVariables)
      指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Location ヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      urlVariables - テンプレートを展開する変数
      戻り値:
      Location ヘッダーの値
      関連事項:
    • postForLocation

      public URISE postForLocation(URISE url, ObjectSE request)
      指定されたオブジェクトを URL に POST して新しいリソースを作成し、Location ヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      戻り値:
      Location ヘッダーの値
      関連事項:
    • postForObject

      public <T> T postForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables)
      指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 戻り値の型
      urlVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      関連事項:
    • postForObject

      public <T> T postForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE,?> urlVariables)
      指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 戻り値の型
      urlVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      関連事項:
    • postForObject

      public <T> T postForObject(URISE url, ObjectSE request, ClassSE<T> responseType)
      指定されたオブジェクトを URL に POST することで新しいリソースを作成し、レスポンスで見つかった表現を返します。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      関連事項:
    • postForEntity

      public <T> ResponseEntity<T> postForEntity(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables)
      指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスを ResponseEntity として返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 返すレスポンス型
      urlVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      関連事項:
    • postForEntity

      public <T> ResponseEntity<T> postForEntity(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE,?> urlVariables)
      指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスを HttpEntity として返します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 返すレスポンス型
      urlVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      関連事項:
    • postForEntity

      public <T> ResponseEntity<T> postForEntity(URISE url, ObjectSE request, ClassSE<T> responseType)
      指定されたオブジェクトを URL に POST して新しいリソースを作成し、レスポンスを ResponseEntity として返します。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 返すレスポンス型
      戻り値:
      変換されたオブジェクト
      関連事項:
    • put

      public void put(StringSE url, ObjectSE request, ObjectSE... urlVariables)
      指定されたオブジェクトを URI に PUT することにより、リソースを作成または更新します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      request - PUT するオブジェクト。null の場合もあります
      urlVariables - テンプレートを展開する変数
      関連事項:
    • put

      public void put(StringSE url, ObjectSE request, MapSE<StringSE,?> urlVariables)
      指定されたオブジェクトを URI テンプレートに PUT することにより、新しいリソースを作成します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      request - PUT するオブジェクト。null の場合もあります
      urlVariables - テンプレートを展開する変数
      関連事項:
    • put

      public void put(URISE url, ObjectSE request)
      指定されたオブジェクトを URL に PUT することにより、新しいリソースを作成します。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      request - PUT するオブジェクト。null の場合もあります
      関連事項:
    • patchForObject

      public <T> T patchForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... uriVariables)
      指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - パッチされるオブジェクト。null の場合があります
      responseType - 戻り値の型
      uriVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      導入:
      1.4.4
      関連事項:
    • patchForObject

      public <T> T patchForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE,?> uriVariables)
      指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - パッチされるオブジェクト。null の場合があります
      responseType - 戻り値の型
      uriVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      導入:
      1.4.4
      関連事項:
    • patchForObject

      public <T> T patchForObject(URISE url, ObjectSE request, ClassSE<T> responseType)
      指定されたオブジェクトを URL にパッチしてリソースを更新し、レスポンスで見つかった表現を返します。

      リクエストに追加の HTTP ヘッダーを追加するには、request パラメーターを HttpEntity にすることができます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      request - POST されるオブジェクト。null の場合があります
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      導入:
      1.4.4
      関連事項:
    • delete

      public void delete(StringSE url, ObjectSE... urlVariables)
      指定された URI のリソースを削除します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      urlVariables - テンプレートで展開する変数
      関連事項:
    • delete

      public void delete(StringSE url, MapSE<StringSE,?> urlVariables)
      指定された URI のリソースを削除します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      urlVariables - テンプレートを展開する変数
      関連事項:
    • delete

      public void delete(URISE url)
      指定された URL のリソースを削除します。

      リクエスト結果をアサートする必要がある場合は、exchange メソッドの使用を検討してください。

      パラメーター:
      url - URL
      関連事項:
    • optionsForAllow

      public SetSE<HttpMethod> optionsForAllow(StringSE url, ObjectSE... urlVariables)
      指定された URI の Allow ヘッダーの値を返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      パラメーター:
      url - URL
      urlVariables - テンプレートで展開する変数
      戻り値:
      Allow ヘッダーの値
      関連事項:
    • optionsForAllow

      public SetSE<HttpMethod> optionsForAllow(StringSE url, MapSE<StringSE,?> urlVariables)
      指定された URI の Allow ヘッダーの値を返します。

      URI テンプレート変数は、指定されたマップを使用して展開されます。

      パラメーター:
      url - URL
      urlVariables - テンプレートで展開する変数
      戻り値:
      Allow ヘッダーの値
      関連事項:
    • optionsForAllow

      public SetSE<HttpMethod> optionsForAllow(URISE url)
      指定された URL の Allow ヘッダーの値を返します。
      パラメーター:
      url - URL
      戻り値:
      Allow ヘッダーの値
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType, ObjectSE... urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      urlVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType, MapSE<StringSE,?> urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      urlVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, ObjectSE... urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。指定された ParameterizedTypeReference は、一般的な型情報を渡すために使用されます。
       ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
       ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
       
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      urlVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, MapSE<StringSE,?> urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。指定された ParameterizedTypeReference は、一般的な型情報を渡すために使用されます。
       ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
       ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
       
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      urlVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType)
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。指定された ParameterizedTypeReference は、一般的な型情報を渡すために使用されます。
       ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
       ResponseEntity<List<MyBean>> response = template.exchange("https://example.com",HttpMethod.GET, null, myBean);
       
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーやボディ)、null
      responseType - 戻り値の型
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ClassSE<T> responseType)
      指定された RequestEntity で指定されたリクエストを実行し、レスポンスを ResponseEntity として返します。通常、たとえば RequestEntity の静的ビルダーメソッドと組み合わせて使用されます。
       MyRequest body = ...
       RequestEntity request = RequestEntity.post(new URI("https://example.com/foo")).accept(MediaType.APPLICATION_JSON).body(body);
       ResponseEntity<MyResponse> response = template.exchange(request, MyResponse.class);
       
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      requestEntity - リクエストに書き込むエンティティ
      responseType - 戻り値の型
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • exchange

      public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType)
      指定された RequestEntity で指定されたリクエストを実行し、レスポンスを ResponseEntity として返します。指定された ParameterizedTypeReference は、一般的な型情報を渡すために使用されます。
       MyRequest body = ...
       RequestEntity request = RequestEntity.post(new URI("https://example.com/foo")).accept(MediaType.APPLICATION_JSON).body(body);
       ParameterizedTypeReference<List<MyResponse>> myBean = new ParameterizedTypeReference<List<MyResponse>>() {};
       ResponseEntity<List<MyResponse>> response = template.exchange(request, myBean);
       
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      requestEntity - リクエストに書き込むエンティティ
      responseType - 戻り値の型
      戻り値:
      エンティティとしてのレスポンス
      関連事項:
    • execute

      public <T> T execute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, ObjectSE... urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallback を使用してリクエストを準備し、ResponseExtractor を使用してレスポンスを読み取ります。

      URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestCallback - リクエストを準備するオブジェクト
      responseExtractor - レスポンスから戻り値を抽出するオブジェクト
      urlVariables - テンプレートで展開する変数
      戻り値:
      ResponseExtractor によって返される任意のオブジェクト
      関連事項:
    • execute

      public <T> T execute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, MapSE<StringSE,?> urlVariables)
      指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallback を使用してリクエストを準備し、ResponseExtractor を使用してレスポンスを読み取ります。

      URI テンプレート変数は、指定された URI 変数マップを使用して展開されます。

      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestCallback - リクエストを準備するオブジェクト
      responseExtractor - レスポンスから戻り値を抽出するオブジェクト
      urlVariables - テンプレートで展開する変数
      戻り値:
      ResponseExtractor によって返される任意のオブジェクト
      関連事項:
    • execute

      public <T> T execute(URISE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor)
      指定された URL に対して HTTP メソッドを実行し、RequestCallback を使用してリクエストを準備し、ResponseExtractor を使用してレスポンスを読み取ります。
      型パラメーター:
      T - 戻り値の型
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestCallback - リクエストを準備するオブジェクト
      responseExtractor - レスポンスから戻り値を抽出するオブジェクト
      戻り値:
      ResponseExtractor によって返される任意のオブジェクト
      関連事項:
    • getRestTemplate

      public RestTemplate getRestTemplate()
      REST 操作を実行するために実際に使用される、基礎となる RestTemplate を返します。
      戻り値:
      restTemplate
    • withBasicAuth

      public TestRestTemplate withBasicAuth(StringSE username, StringSE password)
      指定された username および password を使用して基本認証ヘッダーを送信することを除いて、これと同じ構成で新しい TestRestTemplate を作成します。使用されるリクエストファクトリは、基になる RestTemplate のリクエストファクトリ型の新しいインスタンスです(可能な場合)。
      パラメーター:
      username - ユーザー名
      password - パスワード
      戻り値:
      新しいテンプレート
      導入:
      1.4.1