インターフェース RestOperations

すべての既知の実装クラス:
RestTemplate

public interface RestOperations
RESTful 操作の基本セットを指定するインターフェース。

RestTemplate によって実装されます。直接使用されることはあまりありませんが、簡単にモックまたはスタブできるため、テスト容易性を高めるための便利なオプションです。

導入:
3.0
作成者:
Arjen Poutsma, Juergen Hoeller
関連事項:
  • メソッドの詳細

    • getForObject

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

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

      パラメーター:
      url - URL
      responseType - 戻り値の型
      uriVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
    • getForObject

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

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

      パラメーター:
      url - URL
      responseType - 戻り値の型
      uriVariables - URI テンプレートの変数を含むマップ
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
    • getForObject

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

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

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

      パラメーター:
      url - URL
      responseType - 戻り値の型
      uriVariables - テンプレートを展開する変数
      戻り値:
      エンティティ
      例外:
      RestClientException
      導入:
      3.0.2
    • getForEntity

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

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

      パラメーター:
      url - URL
      responseType - 戻り値の型
      uriVariables - URI テンプレートの変数を含むマップ
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      3.0.2
    • getForEntity

      <T> ResponseEntity<T> getForEntity(URISE url, ClassSE<T> responseType) throws RestClientException
      URL で GET を実行して表現を取得します。レスポンスは変換され、ResponseEntity に格納されます。
      パラメーター:
      url - URL
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      3.0.2
    • headForHeaders

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

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

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

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

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

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

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

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

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

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

      パラメーター:
      url - URL
      request - POST されるオブジェクト (null の場合があります)
      uriVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      3.0.2
      関連事項:
    • postForEntity

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

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

      パラメーター:
      url - URL
      request - POST されるオブジェクト (null の場合があります)
      uriVariables - テンプレートを展開する変数
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      3.0.2
      関連事項:
    • postForEntity

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

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

      エンティティの本体、または request 自体は、マルチパートリクエストを作成するために MultiValueMap にすることができます。MultiValueMap の値は、パーツのボディを表す任意のオブジェクト、またはボディとヘッダーを持つパーツを表す HttpEntity のいずれかです。

      パラメーター:
      url - URL
      request - POST されるオブジェクト (null の場合があります)
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      3.0.2
      関連事項:
    • put

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

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

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

      パラメーター:
      url - URL
      request - PUT されるオブジェクト (null の場合があります)
      uriVariables - テンプレートを展開する変数
      例外:
      RestClientException
      関連事項:
    • put

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

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

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

      パラメーター:
      url - URL
      request - PUT されるオブジェクト (null の場合があります)
      uriVariables - テンプレートを展開する変数
      例外:
      RestClientException
      関連事項:
    • put

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

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

      パラメーター:
      url - URL
      request - PUT されるオブジェクト (null の場合があります)
      例外:
      RestClientException
      関連事項:
    • patchForObject

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

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

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

      NOTE: 標準の JDK HTTP ライブラリは HTTP PATCH をサポートしていません。たとえば、Apache HttpComponents リクエストファクトリを使用する必要があります。

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

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

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

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

      NOTE: 標準の JDK HTTP ライブラリは HTTP PATCH をサポートしていません。たとえば、Apache HttpComponents リクエストファクトリを使用する必要があります。

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

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

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

      NOTE: 標準の JDK HTTP ライブラリは HTTP PATCH をサポートしていません。たとえば、Apache HttpComponents リクエストファクトリを使用する必要があります。

      パラメーター:
      url - URL
      request - パッチされるオブジェクト (null の場合があります)
      responseType - 戻り値の型
      戻り値:
      変換されたオブジェクト
      例外:
      RestClientException
      導入:
      4.3.5
      関連事項:
    • delete

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

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

      パラメーター:
      url - URL
      uriVariables - テンプレートで展開する変数
      例外:
      RestClientException
    • delete

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

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

      パラメーター:
      url - URL
      uriVariables - テンプレートを展開する変数
      例外:
      RestClientException
    • delete

      void delete(URISE url) throws RestClientException
      指定された URL のリソースを削除します。
      パラメーター:
      url - URL
      例外:
      RestClientException
    • optionsForAllow

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

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

      パラメーター:
      url - URL
      uriVariables - テンプレートで展開する変数
      戻り値:
      Allow ヘッダーの値
      例外:
      RestClientException
    • optionsForAllow

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

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

      パラメーター:
      url - URL
      uriVariables - テンプレートで展開する変数
      戻り値:
      Allow ヘッダーの値
      例外:
      RestClientException
    • optionsForAllow

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

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

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

      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文)は null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      uriVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.0.2
    • exchange

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

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

      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文) (null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      uriVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.0.2
    • exchange

      <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType) throws RestClientException
      指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスを ResponseEntity として返します。
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文) (null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.0.2
    • exchange

      <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, ObjectSE... uriVariables) throws RestClientException
      指定された 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);
       
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文) (null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      uriVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.2
    • exchange

      <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, MapSE<StringSE,?> uriVariables) throws RestClientException
      指定された 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);
       
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文) (null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      uriVariables - テンプレートで展開する変数
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.2
    • exchange

      <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
      指定された 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);
       
      パラメーター:
      url - URL
      method - HTTP メソッド (GET、POST など)
      requestEntity - リクエストに書き込むエンティティ(ヘッダーおよび / または本文) (null の場合があります)
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      3.2
    • exchange

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

      <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException
      指定された RequestEntity で指定されたリクエストを実行し、レスポンスを ResponseEntity として返します。指定された ParameterizedTypeReference は、一般的な型情報を渡すために使用されます。
       MyRequest body = ...
       RequestEntity request = RequestEntity
           .post(URI.create("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);
       
      パラメーター:
      requestEntity - リクエストに書き込むエンティティ
      responseType - レスポンスを変換する型、または本体なしの場合は Void.class 
      戻り値:
      エンティティとしてのレスポンス
      例外:
      RestClientException
      導入:
      4.1
    • execute

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

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

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

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

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

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

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