パッケージ org.springframework.http

クラス ResponseEntity<T>

java.lang.ObjectSE
org.springframework.http.HttpEntity<T>
org.springframework.http.ResponseEntity<T>
型パラメーター:
T - ボディ型
public class ResponseEntity<T> extends HttpEntity<T>
HttpStatusCode ステータスコードを追加する HttpEntity の拡張。RestTemplate および @Controller メソッドで使用されます。

RestTemplate では、このクラスは getForEntity() および exchange() によって返されます。

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

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

 @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   HttpHeaders responseHeaders = new HttpHeaders();
   responseHeaders.setLocation(location);
   responseHeaders.set("MyResponseHeader", "MyValue");
   return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED);
 }
または、静的メソッドを介してアクセス可能なビルダーを使用して:
 @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   return ResponseEntity.created(location).header("MyResponseHeader", "MyValue").body("Hello World");
 }
導入:
3.0.2
作成者:
Arjen Poutsma, Brian Clozel, Sebastien Deleuze
関連事項:

  • コンストラクターの詳細

    • ResponseEntity

      public ResponseEntity(HttpStatusCode status)
      ステータスコードのみを使用して ResponseEntity を作成します。
      パラメーター:
      status - ステータスコード

    • ResponseEntity

      public ResponseEntity(@Nullable T body, HttpStatusCode status)
      本文とステータスコードを使用して ResponseEntity を作成します。
      パラメーター:
      body - エンティティ本体
      status - ステータスコード

    • ResponseEntity

      public ResponseEntity(MultiValueMap<StringSE,StringSE> headers, HttpStatusCode status)
      ヘッダーとステータスコードを使用して ResponseEntity を作成します。
      パラメーター:
      headers - エンティティヘッダー
      status - ステータスコード

    • ResponseEntity

      public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<StringSE,StringSE> headers, int rawStatus)
      本文、ヘッダー、生のステータスコードを使用して ResponseEntity を作成します。
      パラメーター:
      body - エンティティ本体
      headers - エンティティヘッダー
      rawStatus - ステータスコード値
      導入:
      5.3.2

    • ResponseEntity

      public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<StringSE,StringSE> headers, HttpStatusCode statusCode)
      本文、ヘッダー、ステータスコードを使用して ResponseEntity を作成します。
      パラメーター:
      body - エンティティ本体
      headers - エンティティヘッダー
      statusCode - ステータスコード

  • メソッドの詳細

    • getStatusCode

      public HttpStatusCode getStatusCode()
      レスポンスの HTTP ステータスコードを返します。
      戻り値:
      HttpStatus enum エントリとしての HTTP ステータス

    • getStatusCodeValue

      @DeprecatedSE(since="6.0") public int getStatusCodeValue()
      使用すべきではありません。
      6.0 以降、getStatusCode() を推奨。7.0 で削除予定
      レスポンスの HTTP ステータスコードを返します。
      戻り値:
      int 値としての HTTP ステータス
      導入:
      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 

    • status

      public static ResponseEntity.BodyBuilder status(HttpStatusCode status)
      指定されたステータスでビルダーを作成します。
      パラメーター:
      status - レスポンスステータス
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • status

      public static ResponseEntity.BodyBuilder status(int status)
      指定されたステータスでビルダーを作成します。
      パラメーター:
      status - レスポンスステータス
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • ok

      public static ResponseEntity.BodyBuilder ok()
      ステータスを OK に設定してビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • ok

      public static <T> ResponseEntity<T> ok(@Nullable T body)
      指定された本体とステータスが OK に設定された ResponseEntity を作成するためのショートカット。
      パラメーター:
      body - レスポンスエンティティの本体 (空の可能性あり)
      戻り値:
      作成された ResponseEntity
      導入:
      4.1

    • of

      public static <T> ResponseEntity<T> of(OptionalSE<T> body)
      指定された本体と OK ステータスで ResponseEntity を作成するためのショートカット、または Optional.empty() パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。
      戻り値:
      作成された ResponseEntity
      導入:
      5.1

    • of

      public static ResponseEntity.HeadersBuilder<?> of(ProblemDetail body)
      ステータスを ProblemDetail.getStatus() に設定し、本体を ProblemDetail に設定して、新しい ResponseEntity.HeadersBuilder を作成します。

      注意 : 追加するヘッダーがない場合、通常、ResponseEntity を作成する必要はありません。これは、ProblemDetail もコントローラーメソッドからの戻り値としてサポートされているためです。

      パラメーター:
      body - 使用する問題の詳細
      戻り値:
      作成されたビルダー
      導入:
      6.0

    • ofNullable

      public static <T> ResponseEntity<T> ofNullable(@Nullable T body)
      指定された本体と OK ステータスを持つ ResponseEntity を作成するためのショートカット、または null パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。
      戻り値:
      作成された ResponseEntity
      導入:
      6.0.5

    • created

      public static ResponseEntity.BodyBuilder created(URISE location)
      CREATED ステータスおよび指定された URI に設定された場所ヘッダーを使用して、新しいビルダーを作成します。
      パラメーター:
      location - ロケーション URI
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • accepted

      public static ResponseEntity.BodyBuilder accepted()
      ACCEPTED ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • noContent

      public static ResponseEntity.HeadersBuilder<?> noContent()
      NO_CONTENT ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • badRequest

      public static ResponseEntity.BodyBuilder badRequest()
      BAD_REQUEST ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • notFound

      public static ResponseEntity.HeadersBuilder<?> notFound()
      NOT_FOUND ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1

    • unprocessableEntity

      public static ResponseEntity.BodyBuilder unprocessableEntity()
      UNPROCESSABLE_ENTITY ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      4.1.3

    • internalServerError

      public static ResponseEntity.BodyBuilder internalServerError()
      INTERNAL_SERVER_ERROR ステータスのビルダーを作成します。
      戻り値:
      作成されたビルダー
      導入:
      5.3.8