クラス TestRestTemplate
RestTemplate の便利な代替。TestRestTemplate はフォールトトレラントです。これは、4xx および 5xx がスローされる例外にはならず、代わりに response entity およびその status code を介して検出できることを意味します。TestRestTemplate はオプションで Basic 認証ヘッダーを運ぶことができます。Apache Http クライアント 4.3.2 以上が利用可能な場合(推奨)、それがクライアントとして使用され、デフォルトでは Cookie を無視するように設定されます。
メモ: インジェクションの問題を防ぐため、このクラスは意図的に RestTemplate を継承しません。基礎となる RestTemplate にアクセスする必要がある場合は、getRestTemplate() を使用してください。
If you are using the @SpringBootTest annotation with an embedded server, a TestRestTemplate can be auto-configured by adding @AutoConfigureTestRestTemplate to your test class. It can then be @Autowired into your test. If you need customizations (for example to adding additional message converters) use a RestTemplateBuilder @Bean.
- 導入:
- 4.0.0
- 作成者:
- Dave Syer, Phillip Webb, Andy Wilkinson, Kristine Jetzke, Dmytro Nosan, Yanming Zhou
ネストされたクラスの要約
ネストされたクラスコンストラクターの概要
コンストラクターコンストラクター説明TestRestTemplate(@Nullable StringSE username, @Nullable StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplateインスタンスを作成します。TestRestTemplate(RestTemplateBuilder restTemplateBuilder) 新しいTestRestTemplateインスタンスを作成します。TestRestTemplate(RestTemplateBuilder builder, @Nullable StringSE username, @Nullable StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplateインスタンスを作成します。TestRestTemplate(TestRestTemplate.HttpClientOption... httpClientOptions) 新しいTestRestTemplateインスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明void指定された URI のリソースを削除します。void指定された URI のリソースを削除します。void指定された URL のリソースを削除します。<T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ClassSE<T> responseType) 指定されたRequestEntityで指定されたリクエストを実行し、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) 指定されたRequestEntityで指定されたリクエストを実行し、レスポンスをResponseEntityとして返します。<T> @Nullable Texecute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。<T> @Nullable Texecute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。<T> @Nullable Texecute(URISE url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor) 指定された URL に対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。<T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URL で GET を実行して、エンティティを取得します。<T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) URI テンプレートで GET を実行して、表現を取得します。<T> ResponseEntity<T> getForEntity(URISE url, ClassSE<T> responseType) URL で GET を実行して表現を取得します。<T> @Nullable TgetForObject(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URL で GET を実行して、表現を取得します。<T> @Nullable TgetForObject(StringSE url, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) URI テンプレートで GET を実行して、表現を取得します。<T> @Nullable TgetForObject(URISE url, ClassSE<T> responseType) URL で GET を実行して表現を取得します。REST 操作を実行するために実際に使用される、基礎となるRestTemplateを返します。@Nullable StringSEルート URI が適用されていない場合は、RestTemplateBuilder.rootUri(String)または""によって適用されたルート URI を返します。headForHeaders(StringSE url, ObjectSE... urlVariables) URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。headForHeaders(StringSE url, MapSE<StringSE, ?> urlVariables) URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。headForHeaders(URISE url) URL で指定されたリソースのすべてのヘッダーを取得します。optionsForAllow(StringSE url, ObjectSE... urlVariables) 指定された URI のAllowヘッダーの値を返します。optionsForAllow(StringSE url, MapSE<StringSE, ?> urlVariables) 指定された URI のAllowヘッダーの値を返します。optionsForAllow(URISE url) 指定された URL のAllowヘッダーの値を返します。<T> @Nullable TpatchForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> @Nullable TpatchForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> @Nullable TpatchForObject(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL にパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> ResponseEntity<T> postForEntity(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをResponseEntityとして返します。<T> ResponseEntity<T> postForEntity(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをHttpEntityとして返します。<T> ResponseEntity<T> postForEntity(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST して新しいリソースを作成し、レスポンスをResponseEntityとして返します。@Nullable URISEpostForLocation(StringSE url, @Nullable ObjectSE request, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Locationヘッダーの値を返します。@Nullable URISEpostForLocation(StringSE url, @Nullable ObjectSE request, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Locationヘッダーの値を返します。@Nullable URISEpostForLocation(URISE url, @Nullable ObjectSE request) 指定されたオブジェクトを URL に POST して新しいリソースを作成し、Locationヘッダーの値を返します。<T> @Nullable TpostForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。<T> @Nullable TpostForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。<T> @Nullable TpostForObject(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST することで新しいリソースを作成し、レスポンスで見つかった表現を返します。void指定されたオブジェクトを URI に PUT することにより、リソースを作成または更新します。void指定されたオブジェクトを URI テンプレートに PUT することにより、新しいリソースを作成します。void指定されたオブジェクトを URL に PUT することにより、新しいリソースを作成します。voidsetUriTemplateHandler(UriTemplateHandler handler) URI テンプレートを展開するために使用するUriTemplateHandlerを構成します。withBasicAuth(@Nullable StringSE username, @Nullable StringSE password) 指定されたusernameおよびpasswordを使用して基本認証ヘッダーを送信することを除いて、これと同じ構成で新しいTestRestTemplateを作成します。withClientSettings(UnaryOperatorSE<HttpClientSettings> clientSettingsCustomizer) HttpClientSettingsをカスタマイズすることを除いて、これと同じ構成の新しいTestRestTemplateを作成します。withClientSettings(HttpClientSettings clientSettings) 指定されたHttpClientSettingsを適用する点を除いて、これと同じ構成の新しいTestRestTemplateを作成します。withRedirects(HttpRedirects redirects) 指定されたHttpRedirectsを適用する点を除いて、これと同じ構成の新しいTestRestTemplateを作成します。
コンストラクターの詳細
TestRestTemplate
新しいTestRestTemplateインスタンスを作成します。- パラメーター:
restTemplateBuilder- 基礎となるRestTemplateの構成に使用されるビルダー
TestRestTemplate
新しいTestRestTemplateインスタンスを作成します。- パラメーター:
httpClientOptions- Apache HTTP クライアントを使用する場合に使用するクライアントオプション
TestRestTemplate
public TestRestTemplate(@Nullable StringSE username, @Nullable StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplateインスタンスを作成します。- パラメーター:
username- 使用するユーザー名 (またはnull)password- パスワード (またはnull)httpClientOptions- Apache HTTP クライアントを使用する場合に使用するクライアントオプション
TestRestTemplate
public TestRestTemplate(RestTemplateBuilder builder, @Nullable StringSE username, @Nullable StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplateインスタンスを作成します。- パラメーター:
builder- 基礎となるRestTemplateの構成に使用されるビルダーusername- 使用するユーザー名 (またはnull)password- パスワード (またはnull)httpClientOptions- Apache HTTP クライアントを使用する場合に使用するクライアントオプション
メソッドの詳細
setUriTemplateHandler
URI テンプレートを展開するために使用するUriTemplateHandlerを構成します。デフォルトでは、Spring の URI テンプレートのサポートに依存するDefaultUriBuilderFactoryが使用され、エンコードおよび共通ベース URL の先頭の動作をカスタマイズするいくつかの便利なプロパティを公開します。別の実装を使用して、外部 URI テンプレートライブラリをプラグインできます。- パラメーター:
handler- 使用する URI テンプレートハンドラー
getRootUri
ルート URI が適用されていない場合は、RestTemplateBuilder.rootUri(String)または""によって適用されたルート URI を返します。- 戻り値:
- ルート URI
getForObject
public <T> @Nullable T getForObject(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URL で GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLresponseType- 戻り値の型urlVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
getForObject
public <T> @Nullable T getForObject(StringSE url, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) URI テンプレートで GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。URI テンプレート変数は、指定されたマップを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLresponseType- 戻り値の型urlVariables- URI テンプレートの変数を含むマップ- 戻り値:
- 変換されたオブジェクト
- 関連事項:
getForObject
getForEntity
public <T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URL で GET を実行して、エンティティを取得します。レスポンスは変換され、ResponseEntityに保存されます。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLresponseType- 戻り値の型urlVariables- テンプレートを展開する変数- 戻り値:
- エンティティ
- 関連事項:
getForEntity
public <T> ResponseEntity<T> getForEntity(StringSE url, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) URI テンプレートで GET を実行して、表現を取得します。レスポンスは変換され、ResponseEntityに保存されます。URI テンプレート変数は、指定されたマップを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLresponseType- 戻り値の型urlVariables- URI テンプレートの変数を含むマップ- 戻り値:
- 変換されたオブジェクト
- 関連事項:
getForEntity
URL で GET を実行して表現を取得します。レスポンスは変換され、ResponseEntityに保存されます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLresponseType- 戻り値の型- 戻り値:
- 変換されたオブジェクト
- 関連事項:
headForHeaders
URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- パラメーター:
url- URLurlVariables- テンプレートを展開する変数- 戻り値:
- そのリソースのすべての HTTP ヘッダー
- 関連事項:
headForHeaders
URI テンプレートで指定されたリソースのすべてのヘッダーを取得します。URI テンプレート変数は、指定されたマップを使用して展開されます。
- パラメーター:
url- URLurlVariables- URI テンプレートの変数を含むマップ- 戻り値:
- そのリソースのすべての HTTP ヘッダー
- 関連事項:
headForHeaders
URL で指定されたリソースのすべてのヘッダーを取得します。- パラメーター:
url- URL- 戻り値:
- そのリソースのすべての HTTP ヘッダー
- 関連事項:
postForLocation
public @Nullable URISE postForLocation(StringSE url, @Nullable ObjectSE request, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Locationヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますurlVariables- テンプレートを展開する変数- 戻り値:
Locationヘッダーの値- 関連事項:
postForLocation
public @Nullable URISE postForLocation(StringSE url, @Nullable ObjectSE request, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Locationヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますurlVariables- テンプレートを展開する変数- 戻り値:
Locationヘッダーの値- 関連事項:
postForLocation
指定されたオブジェクトを URL に POST して新しいリソースを作成し、Locationヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合があります- 戻り値:
Locationヘッダーの値- 関連事項:
postForObject
public <T> @Nullable T postForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 戻り値の型urlVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForObject
public <T> @Nullable T postForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 戻り値の型urlVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForObject
public <T> @Nullable T postForObject(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST することで新しいリソースを作成し、レスポンスで見つかった表現を返します。リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 戻り値の型- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForEntity
public <T> ResponseEntity<T> postForEntity(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをResponseEntityとして返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 返すレスポンス型urlVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForEntity
public <T> ResponseEntity<T> postForEntity(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをHttpEntityとして返します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 返すレスポンス型urlVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForEntity
public <T> ResponseEntity<T> postForEntity(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST して新しいリソースを作成し、レスポンスをResponseEntityとして返します。リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 返すレスポンス型- 戻り値:
- 変換されたオブジェクト
- 関連事項:
put
指定されたオブジェクトを URI に PUT することにより、リソースを作成または更新します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。リクエスト結果をアサートする必要がある場合は、
exchangeメソッドの使用を検討してください。- パラメーター:
url- URLrequest- PUT するオブジェクト。nullの場合もありますurlVariables- テンプレートを展開する変数- 関連事項:
put
指定されたオブジェクトを URI テンプレートに PUT することにより、新しいリソースを作成します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。リクエスト結果をアサートする必要がある場合は、
exchangeメソッドの使用を検討してください。- パラメーター:
url- URLrequest- PUT するオブジェクト。nullの場合もありますurlVariables- テンプレートを展開する変数- 関連事項:
put
指定されたオブジェクトを URL に PUT することにより、新しいリソースを作成します。リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。リクエスト結果をアサートする必要がある場合は、
exchangeメソッドの使用を検討してください。- パラメーター:
url- URLrequest- PUT するオブジェクト。nullの場合もあります- 関連事項:
patchForObject
public <T> @Nullable T patchForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, ObjectSE... uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- パッチされるオブジェクト。nullの場合がありますresponseType- 戻り値の型uriVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
patchForObject
public <T> @Nullable T patchForObject(StringSE url, @Nullable ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- パッチされるオブジェクト。nullの場合がありますresponseType- 戻り値の型uriVariables- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
patchForObject
public <T> @Nullable T patchForObject(URISE url, @Nullable ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL にパッチしてリソースを更新し、レスポンスで見つかった表現を返します。リクエストに追加の HTTP ヘッダーを追加するには、
requestパラメーターをHttpEntityにすることができます。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLrequest- POST されるオブジェクト。nullの場合がありますresponseType- 戻り値の型- 戻り値:
- 変換されたオブジェクト
- 関連事項:
delete
delete
delete
optionsForAllow
指定された URI のAllowヘッダーの値を返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- パラメーター:
url- URLurlVariables- テンプレートで展開する変数- 戻り値:
Allowヘッダーの値- 関連事項:
optionsForAllow
指定された URI のAllowヘッダーの値を返します。URI テンプレート変数は、指定されたマップを使用して展開されます。
- パラメーター:
url- URLurlVariables- テンプレートで展開する変数- 戻り値:
Allowヘッダーの値- 関連事項:
optionsForAllow
指定された URL のAllowヘッダーの値を返します。- パラメーター:
url- URL- 戻り値:
Allowヘッダーの値- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型urlVariables- テンプレートで展開する変数- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型urlVariables- テンプレートで展開する変数- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ClassSE<T> responseType) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntityとして返します。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable 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- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型urlVariables- テンプレートで展開する変数- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(StringSE url, HttpMethod method, @Nullable 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- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型urlVariables- テンプレートで展開する変数- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
public <T> ResponseEntity<T> exchange(URISE url, HttpMethod method, @Nullable 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- URLmethod- HTTP メソッド (GET、POST など)requestEntity- リクエストに書き込むエンティティ(ヘッダーやボディ)、nullresponseType- 戻り値の型- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
exchange
指定された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> @Nullable T execute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestCallback- リクエストを準備するオブジェクトresponseExtractor- レスポンスから戻り値を抽出するオブジェクトurlVariables- テンプレートで展開する変数- 戻り値:
ResponseExtractorによって返される任意のオブジェクト- 関連事項:
execute
public <T> @Nullable T execute(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。URI テンプレート変数は、指定された URI 変数マップを使用して展開されます。
- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestCallback- リクエストを準備するオブジェクトresponseExtractor- レスポンスから戻り値を抽出するオブジェクトurlVariables- テンプレートで展開する変数- 戻り値:
ResponseExtractorによって返される任意のオブジェクト- 関連事項:
execute
public <T> @Nullable T execute(URISE url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor) 指定された URL に対して HTTP メソッドを実行し、RequestCallbackを使用してリクエストを準備し、ResponseExtractorを使用してレスポンスを読み取ります。- 型パラメーター:
T- 戻り値の型- パラメーター:
url- URLmethod- HTTP メソッド (GET、POST など)requestCallback- リクエストを準備するオブジェクトresponseExtractor- レスポンスから戻り値を抽出するオブジェクト- 戻り値:
ResponseExtractorによって返される任意のオブジェクト- 関連事項:
getRestTemplate
REST 操作を実行するために実際に使用される、基礎となるRestTemplateを返します。- 戻り値:
- restTemplate
withBasicAuth
指定されたusernameおよびpasswordを使用して基本認証ヘッダーを送信することを除いて、これと同じ構成で新しいTestRestTemplateを作成します。使用されるリクエストファクトリは、基になるRestTemplateのリクエストファクトリ型の新しいインスタンスです(可能な場合)。- パラメーター:
username- ユーザー名password- パスワード- 戻り値:
- 新しいテンプレート
withRedirects
指定されたHttpRedirectsを適用する点を除いて、これと同じ構成の新しいTestRestTemplateを作成します。使用されるリクエストファクトリは、基礎となるRestTemplateのリクエストファクトリ型の新しいインスタンスです (可能な場合)。- パラメーター:
redirects- 新しいリダイレクト設定- 戻り値:
- 新しいテンプレート
withClientSettings
指定されたHttpClientSettingsを適用する点を除いて、これと同じ構成の新しいTestRestTemplateを作成します。使用されるリクエストファクトリは、基礎となるRestTemplateのリクエストファクトリ型の新しいインスタンスです (可能な場合)。- パラメーター:
clientSettings- the new client settings- 戻り値:
- 新しいテンプレート
withClientSettings
public TestRestTemplate withClientSettings(UnaryOperatorSE<HttpClientSettings> clientSettingsCustomizer) HttpClientSettingsをカスタマイズすることを除いて、これと同じ構成の新しいTestRestTemplateを作成します。使用されるリクエストファクトリは、基礎となるRestTemplateのリクエストファクトリ型の新しいインスタンスです (可能な場合)。- パラメーター:
clientSettingsCustomizer- 設定を更新するためのUnaryOperatorSE- 戻り値:
- 新しいテンプレート