ResponseEntity (Spring Framework API)

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

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

public class ResponseEntity<T>
extends HttpEntity<T>

HttpStatus ステータスコードを追加する 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
関連事項:: getStatusCode(), RestOperations.getForEntity(String, Class, Object...), RestOperations.getForEntity(String, Class, java.util.Map), RestOperations.getForEntity(URI, Class), RequestEntity

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

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

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

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ResponseEntity(HttpStatus status)` ステータスコードのみを使用して `ResponseEntity` を作成します。
`ResponseEntity(MultiValueMap<StringSE, StringSE> headers, HttpStatus status)` ヘッダーとステータスコードを使用して `ResponseEntity` を作成します。
`ResponseEntity(T body, HttpStatus status)` 本文とステータスコードを使用して `ResponseEntity` を作成します。
`ResponseEntity(T body, MultiValueMap<StringSE, StringSE> headers, HttpStatus status)` 本文、ヘッダー、ステータスコードを使用して `ResponseEntity` を作成します。
`ResponseEntity(T body, MultiValueMap<StringSE, StringSE> headers, int rawStatus)` 本文、ヘッダー、生のステータスコードを使用して `ResponseEntity` を作成します。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static ResponseEntity.BodyBuilder`	`accepted()` ACCEPTED ステータスのビルダーを作成します。
`static ResponseEntity.BodyBuilder`	`badRequest()` BAD_REQUEST ステータスのビルダーを作成します。
`static ResponseEntity.BodyBuilder`	`created(URISE location)` CREATED ステータスおよび指定された URI に設定された場所ヘッダーを使用して、新しいビルダーを作成します。
`boolean`	`equals(ObjectSE other)`
`HttpStatus`	`getStatusCode()` レスポンスの HTTP ステータスコードを返します。
`int`	`getStatusCodeValue()` レスポンスの HTTP ステータスコードを返します。
`int`	`hashCode()`
`static ResponseEntity.BodyBuilder`	`internalServerError()` INTERNAL_SERVER_ERROR ステータスのビルダーを作成します。
`static ResponseEntity.HeadersBuilder<?>`	`noContent()` NO_CONTENT ステータスのビルダーを作成します。
`static ResponseEntity.HeadersBuilder<?>`	`notFound()` NOT_FOUND ステータスのビルダーを作成します。
`static <T> ResponseEntity<T>`	`of(OptionalSE<T> body)` 指定された本体と OK ステータスで `ResponseEntity` を作成するためのショートカット、または Optional.empty()SE パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。
`static ResponseEntity.BodyBuilder`	`ok()` ステータスを OK に設定してビルダーを作成します。
`static <T> ResponseEntity<T>`	`ok(T body)` 指定された本体とステータスが OK に設定された `ResponseEntity` を作成するためのショートカット。
`static ResponseEntity.BodyBuilder`	`status(HttpStatus status)` 指定されたステータスでビルダーを作成します。
`static ResponseEntity.BodyBuilder`	`status(int status)` 指定されたステータスでビルダーを作成します。
`StringSE`	`toString()`
`static ResponseEntity.BodyBuilder`	`unprocessableEntity()` UNPROCESSABLE_ENTITY ステータスのビルダーを作成します。

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

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

- コンストラクターの詳細
  - ResponseEntity
```
public ResponseEntity(HttpStatus status)
```
    ステータスコードのみを使用して ResponseEntity を作成します。
    パラメーター:
    status - ステータスコード
  - ResponseEntity
```
public ResponseEntity(@Nullable
                      T body,
                      HttpStatus status)
```
    本文とステータスコードを使用して ResponseEntity を作成します。
    パラメーター:
    body - エンティティ本体
    status - ステータスコード
  - ResponseEntity
```
public ResponseEntity(MultiValueMap<StringSE,StringSE> headers,
                      HttpStatus status)
```
    ヘッダーとステータスコードを使用して ResponseEntity を作成します。
    パラメーター:
    headers - エンティティヘッダー
    status - ステータスコード
  - ResponseEntity
```
public ResponseEntity(@Nullable
                      T body,
                      @Nullable
                      MultiValueMap<StringSE,StringSE> headers,
                      HttpStatus status)
```
    本文、ヘッダー、ステータスコードを使用して ResponseEntity を作成します。
    パラメーター:
    body - エンティティ本体
    headers - エンティティヘッダー
    status - ステータスコード
  - ResponseEntity
```
public ResponseEntity(@Nullable
                      T body,
                      @Nullable
                      MultiValueMap<StringSE,StringSE> headers,
                      int rawStatus)
```
    本文、ヘッダー、生のステータスコードを使用して ResponseEntity を作成します。
    パラメーター:
    body - エンティティ本体
    headers - エンティティヘッダー
    rawStatus - ステータスコード値
    導入:
    5.3.2
- メソッドの詳細
  - getStatusCode
```
public HttpStatus getStatusCode()
```
    レスポンスの HTTP ステータスコードを返します。
    戻り値:
    HttpStatus enum エントリとしての HTTP ステータス
  - getStatusCodeValue
```
public int getStatusCodeValue()
```
    レスポンスの 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(HttpStatus 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()SE パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。
    戻り値:
    作成された ResponseEntity
    導入:
    5.1
  - 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

クラス ResponseEntity<T>

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

フィールドのサマリー

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

コンストラクターの概要

メソッドのサマリー

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

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

コンストラクターの詳細

ResponseEntity

ResponseEntity

ResponseEntity

ResponseEntity

ResponseEntity

メソッドの詳細

getStatusCode

getStatusCodeValue

equals

hashCode

toString

status

status

ok

ok

of

created

accepted

noContent

badRequest

notFound

unprocessableEntity

internalServerError