RequestEntity (Spring Framework 5.2.4.RELEASE API)

java.lang.ObjectSE
- org.springframework.http.HttpEntity<T>
- - org.springframework.http.RequestEntity<T>

型パラメーター:: T - ボディ型

public class RequestEntity<T>
extends HttpEntity<T>

メソッドと URISE を追加する HttpEntity の拡張。RestTemplate および @Controller メソッドで使用されます。

RestTemplate では、このクラスは exchange() のパラメーターとして使用されます。

 MyRequest body = ...
 RequestEntity<MyRequest> request = RequestEntity
     .post(new URI("https://example.com/bar"))
     .accept(MediaType.APPLICATION_JSON)
     .body(body);
 ResponseEntity<MyResponse> response = template.exchange(request, MyResponse.class);

URI テンプレートに変数を提供する場合は、DefaultUriBuilderFactory の使用を検討してください。

 // Create shared factory
 UriBuilderFactory factory = new DefaultUriBuilderFactory();

 // Use factory to create URL from template
 URI uri = factory.uriString("https://example.com/{foo}").build("bar");
 RequestEntity<MyRequest> request = RequestEntity.post(uri).accept(MediaType.APPLICATION_JSON).body(body);

@Controller メソッドのパラメーターとして、Spring MVC でも使用できます。

 @RequestMapping("/handle")
 public void handle(RequestEntity<String> request) {
   HttpMethod method = request.getMethod();
   URI url = request.getUrl();
   String body = request.getBody();
 }

導入:: 4.1
作成者:: Arjen Poutsma, Sebastien Deleuze
関連事項:: getMethod(), getUrl()

ネストされたクラスの要約

ネストされたクラス
修飾子と型	クラスと説明
`static interface`	`RequestEntity.BodyBuilder` レスポンスエンティティに本文を追加するビルダーを定義します。
`static interface`	`RequestEntity.HeadersBuilder<B extends RequestEntity.HeadersBuilder<B>>` リクエストエンティティにヘッダーを追加するビルダーを定義します。

フィールドのサマリー
- クラス org.springframework.http.HttpEntity から継承されたフィールド
  EMPTY

コンストラクターの概要

コンストラクター
コンストラクターと説明
`RequestEntity(HttpMethod method, URISE url)` メソッドと URL はあるが、本文もヘッダーもないコンストラクター。
`RequestEntity(MultiValueMap<StringSE, StringSE> headers, HttpMethod method, URISE url)` メソッド、URL、ヘッダーはあるが本文はないコンストラクター。
`RequestEntity(T body, HttpMethod method, URISE url)` メソッド、URL、ボディはあるがヘッダーはないコンストラクター。
`RequestEntity(T body, HttpMethod method, URISE url, TypeSE type)` メソッド、URL、ボディ、型はあるがヘッダーはないコンストラクター。
`RequestEntity(T body, MultiValueMap<StringSE, StringSE> headers, HttpMethod method, URISE url)` メソッド、URL、ヘッダー、本文を含むコンストラクター。
`RequestEntity(T body, MultiValueMap<StringSE, StringSE> headers, HttpMethod method, URISE url, TypeSE type)` メソッド、URL、ヘッダー、ボディ、型を持つコンストラクター。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static RequestEntity.HeadersBuilder<?>`	`delete(URISE url)` 指定された URL で HTTP DELETE ビルダーを作成します。
`boolean`	`equals(ObjectSE other)`
`static RequestEntity.HeadersBuilder<?>`	`get(URISE url)` 指定された URL で HTTP GET ビルダーを作成します。
`HttpMethod`	`getMethod()` リクエストの HTTP メソッドを返します。
`TypeSE`	`getType()` リクエストのボディの型を返します。
`URISE`	`getUrl()` リクエストの URL を返します。
`int`	`hashCode()`
`static RequestEntity.HeadersBuilder<?>`	`head(URISE url)` 指定された URL で HTTP HEAD ビルダーを作成します。
`static RequestEntity.BodyBuilder`	`method(HttpMethod method, URISE url)` 指定されたメソッドと URL でビルダーを作成します。
`static RequestEntity.HeadersBuilder<?>`	`options(URISE url)` 指定された URL で HTTP OPTIONS ビルダーを作成します。
`static RequestEntity.BodyBuilder`	`patch(URISE url)` 指定された URL で HTTP PATCH ビルダーを作成します。
`static RequestEntity.BodyBuilder`	`post(URISE url)` 指定された URL で HTTP POST ビルダーを作成します。
`static RequestEntity.BodyBuilder`	`put(URISE url)` 指定された URL で HTTP PUT ビルダーを作成します。
`StringSE`	`toString()`

クラス org.springframework.http.HttpEntity から継承されたメソッド
getBody, getHeaders, hasBody

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, finalizeSE, getClassSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - RequestEntity
```
public RequestEntity(HttpMethod method,
                     URISE url)
```
    メソッドと URL はあるが、本文もヘッダーもないコンストラクター。
    パラメーター:
    method - メソッド
    url - URL
  - RequestEntity
```
public RequestEntity(@Nullable
                     T body,
                     HttpMethod method,
                     URISE url)
```
    メソッド、URL、ボディはあるがヘッダーはないコンストラクター。
    パラメーター:
    body - 体
    method - メソッド
    url - URL
  - RequestEntity
```
public RequestEntity(@Nullable
                     T body,
                     HttpMethod method,
                     URISE url,
                     TypeSE type)
```
    メソッド、URL、ボディ、型はあるがヘッダーはないコンストラクター。
    パラメーター:
    body - 体
    method - メソッド
    url - URL
    type - ジェネリクス型解決に使用される型
    導入:
    4.3
  - RequestEntity
```
public RequestEntity(MultiValueMap<StringSE,StringSE> headers,
                     HttpMethod method,
                     URISE url)
```
    メソッド、URL、ヘッダーはあるが本文はないコンストラクター。
    パラメーター:
    headers - ヘッダー
    method - メソッド
    url - URL
  - RequestEntity
```
public RequestEntity(@Nullable
                     T body,
                     @Nullable
                     MultiValueMap<StringSE,StringSE> headers,
                     @Nullable
                     HttpMethod method,
                     URISE url)
```
    メソッド、URL、ヘッダー、本文を含むコンストラクター。
    パラメーター:
    body - 体
    headers - ヘッダー
    method - メソッド
    url - URL
  - RequestEntity
```
public RequestEntity(@Nullable
                     T body,
                     @Nullable
                     MultiValueMap<StringSE,StringSE> headers,
                     @Nullable
                     HttpMethod method,
                     URISE url,
                     @Nullable
                     TypeSE type)
```
    メソッド、URL、ヘッダー、ボディ、型を持つコンストラクター。
    パラメーター:
    body - 体
    headers - ヘッダー
    method - メソッド
    url - URL
    type - ジェネリクス型解決に使用される型
    導入:
    4.3
- メソッドの詳細
  - getMethod
```
@Nullable
public HttpMethod getMethod()
```
    リクエストの HTTP メソッドを返します。
    戻り値:
    HttpMethod 列挙値としての HTTP メソッド
  - getUrl
```
public URISE getUrl()
```
    リクエストの URL を返します。
    戻り値:
    URI としての URL
  - getType
```
@Nullable
public TypeSE getType()
```
    リクエストのボディの型を返します。
    戻り値:
    リクエストのボディ型、または不明の場合は null
    導入:
    4.3
  - equals
```
public boolean equals(@Nullable
                      ObjectSE other)
```
    オーバーライド:
    クラス HttpEntity<T> の equals
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    クラス HttpEntity<T> の hashCode
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス HttpEntity<T> の toString
  - method
```
public static RequestEntity.BodyBuilder method(HttpMethod method,
                                               URISE url)
```
    指定されたメソッドと URL でビルダーを作成します。
    パラメーター:
    method - HTTP メソッド (GET、POST など)
    url - URL
    戻り値:
    作成されたビルダー
  - get
```
public static RequestEntity.HeadersBuilder<?> get(URISE url)
```
    指定された URL で HTTP GET ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - head
```
public static RequestEntity.HeadersBuilder<?> head(URISE url)
```
    指定された URL で HTTP HEAD ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - post
```
public static RequestEntity.BodyBuilder post(URISE url)
```
    指定された URL で HTTP POST ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - put
```
public static RequestEntity.BodyBuilder put(URISE url)
```
    指定された URL で HTTP PUT ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - patch
```
public static RequestEntity.BodyBuilder patch(URISE url)
```
    指定された URL で HTTP PATCH ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - delete
```
public static RequestEntity.HeadersBuilder<?> delete(URISE url)
```
    指定された URL で HTTP DELETE ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー
  - options
```
public static RequestEntity.HeadersBuilder<?> options(URISE url)
```
    指定された URL で HTTP OPTIONS ビルダーを作成します。
    パラメーター:
    url - URL
    戻り値:
    作成されたビルダー

クラス RequestEntity<T>

ネストされたクラスの要約

フィールドのサマリー

クラス org.springframework.http.HttpEntity から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.http.HttpEntity から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

RequestEntity

RequestEntity

RequestEntity

RequestEntity

RequestEntity

RequestEntity

メソッドの詳細

getMethod

getUrl

getType

equals

hashCode

toString

method

get

head

post

put

patch

delete

options