パッケージ org.springframework.http
クラス ResponseEntity<T>
java.lang.ObjectSE
org.springframework.http.HttpEntity<T>
org.springframework.http.ResponseEntity<T>
- 型パラメーター:
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
- 関連事項:
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static interface
レスポンスエンティティに本文を追加するビルダーを定義します。static interface
レスポンスエンティティにヘッダーを追加するビルダーを定義します。フィールドサマリー
クラス org.springframework.http.HttpEntity から継承されたフィールド
EMPTY
コンストラクターのサマリー
コンストラクターコンストラクター説明ResponseEntity
(HttpStatusCode status) ステータスコードのみを使用してResponseEntity
を作成します。ResponseEntity
(MultiValueMap<StringSE, StringSE> headers, HttpStatusCode status) ヘッダーとステータスコードを使用してResponseEntity
を作成します。ResponseEntity
(T body, HttpStatusCode status) 本文とステータスコードを使用してResponseEntity
を作成します。ResponseEntity
(T body, MultiValueMap<StringSE, StringSE> headers, int rawStatus) 本文、ヘッダー、生のステータスコードを使用してResponseEntity
を作成します。ResponseEntity
(T body, MultiValueMap<StringSE, StringSE> headers, HttpStatusCode status) 本文、ヘッダー、ステータスコードを使用してResponseEntity
を作成します。メソッドのサマリー
修飾子と型メソッド説明static ResponseEntity.BodyBuilder
accepted()
ACCEPTED ステータスのビルダーを作成します。static ResponseEntity.BodyBuilder
BAD_REQUEST ステータスのビルダーを作成します。static ResponseEntity.BodyBuilder
CREATED ステータスおよび指定された URI に設定された場所ヘッダーを使用して、新しいビルダーを作成します。boolean
レスポンスの HTTP ステータスコードを返します。int
使用すべきではありません。int
hashCode()
static ResponseEntity.BodyBuilder
INTERNAL_SERVER_ERROR ステータスのビルダーを作成します。static ResponseEntity.HeadersBuilder<?>
NO_CONTENT ステータスのビルダーを作成します。static ResponseEntity.HeadersBuilder<?>
notFound()
NOT_FOUND ステータスのビルダーを作成します。static <T> ResponseEntity<T>
of
(OptionalSE<T> body) 指定された本体と OK ステータスでResponseEntity
を作成するためのショートカット、または Optional.empty() パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。static ResponseEntity.HeadersBuilder<?>
of
(ProblemDetail body) ステータスをProblemDetail.getStatus()
に設定し、本体をProblemDetail
に設定して、新しいResponseEntity.HeadersBuilder
を作成します。static ResponseEntity.BodyBuilder
ok()
ステータスを OK に設定してビルダーを作成します。static <T> ResponseEntity<T>
ok
(T body) 指定された本体とステータスが OK に設定されたResponseEntity
を作成するためのショートカット。static ResponseEntity.BodyBuilder
status
(int status) 指定されたステータスでビルダーを作成します。static ResponseEntity.BodyBuilder
status
(HttpStatusCode status) 指定されたステータスでビルダーを作成します。toString()
static ResponseEntity.BodyBuilder
UNPROCESSABLE_ENTITY ステータスのビルダーを作成します。クラス org.springframework.http.HttpEntity から継承されたメソッド
getBody, getHeaders, hasBody
コンストラクターの詳細
ResponseEntity
ステータスコードのみを使用してResponseEntity
を作成します。- パラメーター:
status
- ステータスコード
ResponseEntity
本文とステータスコードを使用してResponseEntity
を作成します。- パラメーター:
body
- エンティティ本体status
- ステータスコード
ResponseEntity
ヘッダーとステータスコードを使用してResponseEntity
を作成します。- パラメーター:
headers
- エンティティヘッダーstatus
- ステータスコード
ResponseEntity
public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<StringSE, StringSE> headers, HttpStatusCode 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
レスポンスの HTTP ステータスコードを返します。- 戻り値:
- HttpStatus enum エントリとしての HTTP ステータス
getStatusCodeValue
使用すべきではありません。6.0 現在、getStatusCode()
を推奨レスポンスの HTTP ステータスコードを返します。- 戻り値:
- int 値としての HTTP ステータス
- 導入:
- 4.3
equals
- オーバーライド:
- クラス
HttpEntity<T>
のequals
hashCode
public int hashCode()- オーバーライド:
- クラス
HttpEntity<T>
のhashCode
toString
- オーバーライド:
- クラス
HttpEntity<T>
のtoString
status
指定されたステータスでビルダーを作成します。- パラメーター:
status
- レスポンスステータス- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
status
指定されたステータスでビルダーを作成します。- パラメーター:
status
- レスポンスステータス- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
ok
ステータスを OK に設定してビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
ok
指定された本体とステータスが OK に設定されたResponseEntity
を作成するためのショートカット。- パラメーター:
body
- レスポンスエンティティの本体 (空の可能性あり)- 戻り値:
- 作成された
ResponseEntity
- 導入:
- 4.1
of
指定された本体と OK ステータスでResponseEntity
を作成するためのショートカット、または Optional.empty() パラメーターの場合は空の本体と NOT FOUND ステータスを作成するためのショートカット。- 戻り値:
- 作成された
ResponseEntity
- 導入:
- 5.1
of
ステータスをProblemDetail.getStatus()
に設定し、本体をProblemDetail
に設定して、新しいResponseEntity.HeadersBuilder
を作成します。注意 : 追加するヘッダーがない場合、通常、
ResponseEntity
を作成する必要はありません。これは、ProblemDetail
もコントローラーメソッドからの戻り値としてサポートされているためです。- パラメーター:
body
- 使用する問題の詳細- 戻り値:
- 作成されたビルダー
- 導入:
- 6.0
created
CREATED ステータスおよび指定された URI に設定された場所ヘッダーを使用して、新しいビルダーを作成します。- パラメーター:
location
- ロケーション URI- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
accepted
ACCEPTED ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
noContent
NO_CONTENT ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
badRequest
BAD_REQUEST ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
notFound
NOT_FOUND ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1
unprocessableEntity
UNPROCESSABLE_ENTITY ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 4.1.3
internalServerError
INTERNAL_SERVER_ERROR ステータスのビルダーを作成します。- 戻り値:
- 作成されたビルダー
- 導入:
- 5.3.8
getStatusCode()
を推奨