パッケージ org.springframework.http

クラス HttpEntity<T>

java.lang.ObjectSE
org.springframework.http.HttpEntity<T>
型パラメーター:
T - ボディ型
既知の直属サブクラス
RequestEntityResponseEntity

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
関連事項:
  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final HttpEntity<?>
    本文またはヘッダーのない空の HttpEntity
  • コンストラクターのサマリー

    コンストラクター
    修飾子
    コンストラクター
    説明
    protected
    新しい空の HttpEntity を作成します。
    与えられたヘッダーを持ち、本文を持たない新しい HttpEntity を作成します。
    指定された本文を使用してヘッダーなしで新しい HttpEntity を作成します。
    指定されたボディとヘッダーで新しい HttpEntity を作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    boolean
    このエンティティの本体を返します。
    このエンティティのヘッダーを返します。
    boolean
    このエンティティにボディがあるかどうかを示します。
    int

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

    clone, finalize, getClass, notify, notifyAll, wait, 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)
      オーバーライド:
      クラス ObjectSEequalsSE 
    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSEhashCode 
    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSEtoString