HttpEntity (Spring Framework API)

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

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

既知の直属サブクラス: RequestEntity, ResponseEntity

public class HttpEntity<T>
extends ObjectSE

ヘッダーと本文で構成される HTTP リクエストまたはレスポンスエンティティを表します。

多くの場合、次のように RestTemplate と組み合わせて使用されます。

 HttpHeaders headers = new HttpHeaders();
 headers.setContentType(MediaType.TEXT_PLAIN);
 HttpEntity<String> entity = new HttpEntity<>("Hello World", headers);
 URI location = template.postForLocation("https://example.com", entity);

または

 HttpEntity<String> entity = template.getForEntity("https://example.com", String.class);
 String body = entity.getBody();
 MediaType contentType = entity.getHeaders().getContentType();

@Controller メソッドからの戻り値として、Spring MVC で使用することもできます。

 @GetMapping("/handle")
 public HttpEntity<String> handle() {
   HttpHeaders responseHeaders = new HttpHeaders();
   responseHeaders.set("MyResponseHeader", "MyValue");
   return new HttpEntity<>("Hello World", responseHeaders);
 }

導入:: 3.0.2
作成者:: Arjen Poutsma, Juergen Hoeller
関連事項:: RestTemplate, getBody(), getHeaders()

フィールドサマリー
フィールド
修飾子と型フィールドと説明
static HttpEntity<?> EMPTY
本文またはヘッダーのない空の HttpEntity。

フィールド
修飾子と型	フィールドと説明
`static HttpEntity<?>`	`EMPTY` 本文またはヘッダーのない空の `HttpEntity`。

コンストラクターのサマリー

コンストラクター
修飾子	コンストラクターと説明
`protected`	`HttpEntity()` 新しい空の `HttpEntity` を作成します。
	`HttpEntity(MultiValueMap<StringSE, StringSE> headers)` 与えられたヘッダーを持ち、本文を持たない新しい `HttpEntity` を作成します。
	`HttpEntity(T body)` 指定された本文を使用してヘッダーなしで新しい `HttpEntity` を作成します。
	`HttpEntity(T body, MultiValueMap<StringSE, StringSE> headers)` 指定されたボディとヘッダーで新しい `HttpEntity` を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`equals(ObjectSE other)`
`T`	`getBody()` このエンティティの本体を返します。
`HttpHeaders`	`getHeaders()` このエンティティのヘッダーを返します。
`boolean`	`hasBody()` このエンティティにボディがあるかどうかを示します。
`int`	`hashCode()`
`StringSE`	`toString()`

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

- フィールドの詳細
  - EMPTY
```
public static final HttpEntity<?> EMPTY
```
    本文またはヘッダーのない空の HttpEntity。
- コンストラクターの詳細
  - HttpEntity
```
protected HttpEntity()
```
    新しい空の HttpEntity を作成します。
  - HttpEntity
```
public HttpEntity(T body)
```
    指定された本文を使用してヘッダーなしで新しい HttpEntity を作成します。
    パラメーター:
    body - エンティティ本体
  - HttpEntity
```
public HttpEntity(MultiValueMap<StringSE,StringSE> headers)
```
    与えられたヘッダーを持ち、本文を持たない新しい HttpEntity を作成します。
    パラメーター:
    headers - エンティティヘッダー
  - HttpEntity
```
public HttpEntity(@Nullable
                  T body,
                  @Nullable
                  MultiValueMap<StringSE,StringSE> headers)
```
    指定されたボディとヘッダーで新しい HttpEntity を作成します。
    パラメーター:
    body - エンティティ本体
    headers - エンティティヘッダー
- メソッドの詳細
  - getHeaders
```
public HttpHeaders getHeaders()
```
    このエンティティのヘッダーを返します。
  - getBody
```
@Nullable
public T getBody()
```
    このエンティティの本体を返します。
  - hasBody
```
public boolean hasBody()
```
    このエンティティにボディがあるかどうかを示します。
  - equals
```
public boolean equals(@Nullable
                      ObjectSE other)
```
    オーバーライド:
    クラス ObjectSE の equalsSE
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    クラス ObjectSE の hashCodeSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス HttpEntity<T>

フィールドサマリー

コンストラクターのサマリー

メソッドのサマリー

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

フィールドの詳細

EMPTY

コンストラクターの詳細

HttpEntity

HttpEntity

HttpEntity

HttpEntity

メソッドの詳細

getHeaders

getBody

hasBody

equals

hashCode

toString