クラス TestRestTemplate
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, Yanming Zhou
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明protected static class
HttpComponentsClientHttpRequestFactory
はカスタマイズを適用します。static enum
Apache HTTP クライアントをカスタマイズするために使用されるオプション。コンストラクターの概要
コンストラクターコンストラクター説明TestRestTemplate
(StringSE username, StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplate
インスタンスを作成します。TestRestTemplate
(TestRestTemplate.HttpClientOption... httpClientOptions) 新しいTestRestTemplate
インスタンスを作成します。TestRestTemplate
(RestTemplateBuilder restTemplateBuilder) 新しいTestRestTemplate
インスタンスを作成します。TestRestTemplate
(RestTemplateBuilder builder, StringSE username, StringSE password, TestRestTemplate.HttpClientOption... httpClientOptions) 指定された資格情報で新しいTestRestTemplate
インスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明void
指定された URI のリソースを削除します。void
指定された URI のリソースを削除します。void
指定された URL のリソースを削除します。<T> ResponseEntity<T>
exchange
(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
exchange
(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
exchange
(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
exchange
(StringSE url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
exchange
(URISE url, HttpMethod method, HttpEntity<?> requestEntity, ClassSE<T> responseType) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
exchange
(URISE url, HttpMethod method, 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> T
execute
(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallback
を使用してリクエストを準備し、ResponseExtractor
を使用してレスポンスを読み取ります。<T> T
execute
(StringSE url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, MapSE<StringSE, ?> urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、RequestCallback
を使用してリクエストを準備し、ResponseExtractor
を使用してレスポンスを読み取ります。<T> T
execute
(URISE url, HttpMethod method, RequestCallback requestCallback, 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> T
getForObject
(StringSE url, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URL で GET を実行して、表現を取得します。<T> T
getForObject
(StringSE url, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) URI テンプレートで GET を実行して、表現を取得します。<T> T
getForObject
(URISE url, ClassSE<T> responseType) URL で GET を実行して表現を取得します。REST 操作を実行するために実際に使用される、基礎となるRestTemplate
を返します。ルート 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> T
patchForObject
(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> T
patchForObject
(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> T
patchForObject
(URISE url, ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL にパッチしてリソースを更新し、レスポンスで見つかった表現を返します。<T> ResponseEntity<T>
postForEntity
(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをResponseEntity
として返します。<T> ResponseEntity<T>
postForEntity
(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスをHttpEntity
として返します。<T> ResponseEntity<T>
postForEntity
(URISE url, ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST して新しいリソースを作成し、レスポンスをResponseEntity
として返します。postForLocation
(StringSE url, ObjectSE request, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Location
ヘッダーの値を返します。postForLocation
(StringSE url, ObjectSE request, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Location
ヘッダーの値を返します。postForLocation
(URISE url, ObjectSE request) 指定されたオブジェクトを URL に POST して新しいリソースを作成し、Location
ヘッダーの値を返します。<T> T
postForObject
(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。<T> T
postForObject
(StringSE url, ObjectSE request, ClassSE<T> responseType, MapSE<StringSE, ?> urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。<T> T
postForObject
(URISE url, ObjectSE request, ClassSE<T> responseType) 指定されたオブジェクトを URL に POST することで新しいリソースを作成し、レスポンスで見つかった表現を返します。void
指定されたオブジェクトを URI に PUT することにより、リソースを作成または更新します。void
指定されたオブジェクトを URI テンプレートに PUT することにより、新しいリソースを作成します。void
指定されたオブジェクトを URL に PUT することにより、新しいリソースを作成します。void
setUriTemplateHandler
(UriTemplateHandler handler) URI テンプレートを展開するために使用するUriTemplateHandler
を構成します。withBasicAuth
(StringSE username, StringSE password) 指定されたusername
およびpassword
を使用して基本認証ヘッダーを送信することを除いて、これと同じ構成で新しいTestRestTemplate
を作成します。withRequestFactorySettings
(UnaryOperatorSE<ClientHttpRequestFactorySettings> requestFactorySettingsCustomizer) ClientHttpRequestFactorySettings
をカスタマイズすることを除いて、これと同じ構成の新しいTestRestTemplate
を作成します。withRequestFactorySettings
(ClientHttpRequestFactorySettings requestFactorySettings) 指定されたClientHttpRequestFactorySettings
を適用する点を除いて、これと同じ構成の新しいTestRestTemplate
を作成します。
コンストラクターの詳細
TestRestTemplate
新しいTestRestTemplate
インスタンスを作成します。- パラメーター:
restTemplateBuilder
- 基礎となるRestTemplate
の構成に使用されるビルダー- 導入:
- 1.4.1
TestRestTemplate
新しい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
URI テンプレートを展開するために使用するUriTemplateHandler
を構成します。デフォルトでは、Spring の URI テンプレートのサポートに依存するDefaultUriBuilderFactory
が使用され、エンコードおよび共通ベース URL の先頭の動作をカスタマイズするいくつかの便利なプロパティを公開します。別の実装を使用して、外部 URI テンプレートライブラリをプラグインできます。- パラメーター:
handler
- 使用する URI テンプレートハンドラー
getRootUri
ルート URI が適用されていない場合は、RestTemplateBuilder.rootUri(String)
または""
によって適用されたルート URI を返します。- 戻り値:
- ルート URI
getForObject
指定された URL で GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLresponseType
- 戻り値の型urlVariables
- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
getForObject
URI テンプレートで GET を実行して、表現を取得します。レスポンス(ある場合)が変換されて返されます。URI テンプレート変数は、指定されたマップを使用して展開されます。
- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLresponseType
- 戻り値の型urlVariables
- URI テンプレートの変数を含むマップ- 戻り値:
- 変換されたオブジェクト
- 関連事項:
getForObject
URL で GET を実行して表現を取得します。レスポンス(ある場合)が変換されて返されます。- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLresponseType
- 戻り値の型- 戻り値:
- 変換されたオブジェクト
- 関連事項:
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
指定されたオブジェクトを URI テンプレートに POST することにより新しいリソースを作成し、Location
ヘッダーの値を返します。このヘッダーは通常、新しいリソースが保存されている場所を示します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
request
パラメーターをHttpEntity
にすることができます。- パラメーター:
url
- URLrequest
- POST されるオブジェクト。null
の場合がありますurlVariables
- テンプレートを展開する変数- 戻り値:
Location
ヘッダーの値- 関連事項:
postForLocation
指定されたオブジェクトを 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> T postForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... urlVariables) 指定されたオブジェクトを URI テンプレートに POST して新しいリソースを作成し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
request
パラメーターをHttpEntity
にすることができます。- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLrequest
- 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
- URLrequest
- POST されるオブジェクト。null
の場合がありますresponseType
- 戻り値の型urlVariables
- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForObject
指定されたオブジェクトを URL に POST することで新しいリソースを作成し、レスポンスで見つかった表現を返します。リクエストに追加の HTTP ヘッダーを追加するには、
request
パラメーターをHttpEntity
にすることができます。- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLrequest
- 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
- URLrequest
- 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
- URLrequest
- POST されるオブジェクト。null
の場合がありますresponseType
- 返すレスポンス型urlVariables
- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 関連事項:
postForEntity
指定されたオブジェクトを 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> T patchForObject(StringSE url, ObjectSE request, ClassSE<T> responseType, ObjectSE... uriVariables) 指定されたオブジェクトを URI テンプレートにパッチしてリソースを更新し、レスポンスで見つかった表現を返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエストに追加の HTTP ヘッダーを追加するには、
request
パラメーターをHttpEntity
にすることができます。- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLrequest
- パッチされるオブジェクト。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
- URLrequest
- パッチされるオブジェクト。null
の場合がありますresponseType
- 戻り値の型uriVariables
- テンプレートを展開する変数- 戻り値:
- 変換されたオブジェクト
- 導入:
- 1.4.4
- 関連事項:
patchForObject
指定されたオブジェクトを URL にパッチしてリソースを更新し、レスポンスで見つかった表現を返します。リクエストに追加の HTTP ヘッダーを追加するには、
request
パラメーターをHttpEntity
にすることができます。- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLrequest
- POST されるオブジェクト。null
の場合がありますresponseType
- 戻り値の型- 戻り値:
- 変換されたオブジェクト
- 導入:
- 1.4.4
- 関連事項:
delete
指定された URI のリソースを削除します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
リクエスト結果をアサートする必要がある場合は、
exchange
メソッドの使用を検討してください。- パラメーター:
url
- URLurlVariables
- テンプレートで展開する変数- 関連事項:
delete
指定された URI のリソースを削除します。URI テンプレート変数は、指定されたマップを使用して展開されます。
リクエスト結果をアサートする必要がある場合は、
exchange
メソッドの使用を検討してください。- パラメーター:
url
- URLurlVariables
- テンプレートを展開する変数- 関連事項:
delete
指定された URL のリソースを削除します。リクエスト結果をアサートする必要がある場合は、
exchange
メソッドの使用を検討してください。- パラメーター:
url
- URL- 関連事項:
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, HttpEntity<?> requestEntity, ClassSE<T> responseType, ObjectSE... urlVariables) 指定された URI テンプレートに対して HTTP メソッドを実行し、指定されたリクエストエンティティをリクエストに書き込み、レスポンスをResponseEntity
として返します。URI テンプレート変数は、指定された URI 変数があればそれを使用して展開されます。
- 型パラメーター:
T
- 戻り値の型- パラメーター:
url
- URLmethod
- 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
- URLmethod
- 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
- URLmethod
- 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
- URLmethod
- 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
- URLmethod
- 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
- URLmethod
- HTTP メソッド (GET、POST など)requestEntity
- リクエストに書き込むエンティティ(ヘッダーやボディ)、null
responseType
- 戻り値の型- 戻り値:
- エンティティとしてのレスポンス
- 関連事項:
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> 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> 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> T execute(URISE url, HttpMethod method, RequestCallback requestCallback, 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
- パスワード- 戻り値:
- 新しいテンプレート
- 導入:
- 1.4.1
withRequestFactorySettings
public TestRestTemplate withRequestFactorySettings(ClientHttpRequestFactorySettings requestFactorySettings) 指定されたClientHttpRequestFactorySettings
を適用する点を除いて、これと同じ構成の新しいTestRestTemplate
を作成します。使用されるリクエストファクトリは、基礎となるRestTemplate
のリクエストファクトリ型の新しいインスタンスです (可能な場合)。- パラメーター:
requestFactorySettings
- 新しいリクエストファクトリ設定- 戻り値:
- 新しいテンプレート
- 導入:
- 3.4.1
withRequestFactorySettings
public TestRestTemplate withRequestFactorySettings(UnaryOperatorSE<ClientHttpRequestFactorySettings> requestFactorySettingsCustomizer) ClientHttpRequestFactorySettings
をカスタマイズすることを除いて、これと同じ構成の新しいTestRestTemplate
を作成します。使用されるリクエストファクトリは、基礎となるRestTemplate
のリクエストファクトリ型の新しいインスタンスです (可能な場合)。- パラメーター:
requestFactorySettingsCustomizer
- 設定を更新するためのUnaryOperator
SE- 戻り値:
- 新しいテンプレート
- 導入:
- 3.4.1