public interface ServerResponse
修飾子と型 | インターフェースと説明 |
---|---|
static interface | ServerResponse.BodyBuilder レスポンスに本文を追加するビルダーを定義します。 |
static interface | ServerResponse.Context writeTo(HttpServletRequest, HttpServletResponse, Context) 中に使用されるコンテキストを定義します。 |
static interface | ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>> レスポンスにヘッダーを追加するビルダーを定義します。 |
static interface | ServerResponse.SseBuilder サーバー送信イベントを送信するボディのビルダーを定義します。 |
修飾子と型 | メソッドと説明 |
---|---|
static ServerResponse.BodyBuilder | accepted() 202 Accepted ステータスのビルダーを作成します。 |
static ServerResponse | async(ObjectSE asyncResponse) 指定された非同期レスポンスを使用して(構築された)レスポンスを作成します。 |
static ServerResponse | async(ObjectSE asyncResponse, DurationSE timeout) 指定された非同期レスポンスを使用して(構築された)レスポンスを作成します。 |
static ServerResponse.BodyBuilder | badRequest() 400 不正なリクエストステータスのビルダーを作成します。 |
MultiValueMap<StringSE, CookieEE> | cookies() このレスポンスの Cookie を返します。 |
static ServerResponse.BodyBuilder | created(URISE location) 201 Created ステータスと特定の URI に設定されたロケーションヘッダーを使用してビルダーを作成します。 |
static ServerResponse.BodyBuilder | from(ServerResponse other) 指定されたレスポンスのステータスコードとヘッダーを使用してビルダーを作成します。 |
HttpHeaders | headers() このレスポンスのヘッダーを返します。 |
static ServerResponse.HeadersBuilder<?> | noContent() 204 コンテンツなしステータスのビルダーを作成します。 |
static ServerResponse.HeadersBuilder<?> | notFound() 404 お探しのページが見つかりませんでしたステータスのビルダーを作成します。 |
static ServerResponse.BodyBuilder | ok() ステータスを 200 OK に設定してビルダーを作成します。 |
static ServerResponse.BodyBuilder | permanentRedirect(URISE location) 308 永久リダイレクトステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。 |
int | rawStatusCode() このレスポンスの(潜在的に非標準の)ステータスコードを返します。 |
static ServerResponse.BodyBuilder | seeOther(URISE location) 303 他を見るステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。 |
static ServerResponse | sse(ConsumerSE<ServerResponse.SseBuilder> consumer) サーバー送信イベントレスポンスを作成します。 |
static ServerResponse | sse(ConsumerSE<ServerResponse.SseBuilder> consumer, DurationSE timeout) サーバー送信イベントレスポンスを作成します。 |
static ServerResponse.BodyBuilder | status(HttpStatus status) 指定された HTTP ステータスでビルダーを作成します。 |
static ServerResponse.BodyBuilder | status(int status) 指定された HTTP ステータスでビルダーを作成します。 |
HttpStatus | statusCode() このレスポンスのステータスコードを返します。 |
static ServerResponse.BodyBuilder | temporaryRedirect(URISE location) 307 一時的なリダイレクトステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。 |
static ServerResponse.BodyBuilder | unprocessableEntity() 422 処理できないエンティティステータスのビルダーを作成します。 |
ModelAndView | writeTo(HttpServletRequestEE request, HttpServletResponseEE response, ServerResponse.Context context) このレスポンスを特定のサーブレットレスポンスに書き込みます。 |
HttpStatus statusCode()
IllegalArgumentExceptionSE
- 不明な HTTP ステータスコードの場合 HttpStatus.valueOf(int)
int rawStatusCode()
statusCode()
, HttpStatus.valueOf(int)
HttpHeaders headers()
MultiValueMap<StringSE,CookieEE> cookies()
@Nullable ModelAndView writeTo(HttpServletRequestEE request, HttpServletResponseEE response, ServerResponse.Context context) throws ServletExceptionEE, IOExceptionSE
request
- 現在のリクエスト response
- 書き込むレスポンス context
- 書くときに使用するコンテキスト ModelAndView
、または直接処理される場合は null
ServletExceptionEE
IOExceptionSE
static ServerResponse.BodyBuilder from(ServerResponse other)
other
- ステータスとヘッダーをコピーするレスポンス static ServerResponse.BodyBuilder status(HttpStatus status)
status
- レスポンスステータス static ServerResponse.BodyBuilder status(int status)
status
- レスポンスステータス static ServerResponse.BodyBuilder ok()
static ServerResponse.BodyBuilder created(URISE location)
location
- ロケーション URIstatic ServerResponse.BodyBuilder accepted()
static ServerResponse.HeadersBuilder<?> noContent()
static ServerResponse.BodyBuilder seeOther(URISE location)
location
- ロケーション URIstatic ServerResponse.BodyBuilder temporaryRedirect(URISE location)
location
- ロケーション URIstatic ServerResponse.BodyBuilder permanentRedirect(URISE location)
location
- ロケーション URIstatic ServerResponse.BodyBuilder badRequest()
static ServerResponse.HeadersBuilder<?> notFound()
static ServerResponse.BodyBuilder unprocessableEntity()
static ServerResponse async(ObjectSE asyncResponse)
asyncResponse
は、CompletableFuture<ServerResponse>
SE または Publisher<ServerResponse>
(または ReactiveAdapterRegistry
を介して適合させることができる単一の ServerResponse
の非同期プロデューサー)にすることができます。 このメソッドを使用して、非同期の結果に基づいてレスポンスステータスコード、ヘッダー、本文を設定できます。本体のみが非同期の場合は、代わりに ServerResponse.BodyBuilder.body(Object)
を使用できます。
asyncResponse
- CompletableFuture<ServerResponse>
または Publisher<ServerResponse>
static ServerResponse async(ObjectSE asyncResponse, DurationSE timeout)
asyncResponse
は、CompletableFuture<ServerResponse>
SE または Publisher<ServerResponse>
(または ReactiveAdapterRegistry
を介して適合させることができる単一の ServerResponse
の非同期プロデューサー)にすることができます。 このメソッドを使用して、非同期の結果に基づいてレスポンスステータスコード、ヘッダー、本文を設定できます。本体のみが非同期の場合は、代わりに ServerResponse.BodyBuilder.body(Object)
を使用できます。
asyncResponse
- CompletableFuture<ServerResponse>
または Publisher<ServerResponse>
timeout
- タイムアウトする前に待機する最大期間 static ServerResponse sse(ConsumerSE<ServerResponse.SseBuilder> consumer)
consumer
に提供された ServerResponse.SseBuilder
は、イベントの作成と送信に使用できます。例:
public ServerResponse handleSse(ServerRequest request) { return ServerResponse.sse(sse -> sse.send("Hello World!")); }
または、ID とイベント型の両方を設定するには:
public ServerResponse handleSse(ServerRequest request) { return ServerResponse.sse(sse -> sse .id("42) .event("event") .send("Hello World!")); }
consumer
- イベントビルダーが提供されるコンシューマー static ServerResponse sse(ConsumerSE<ServerResponse.SseBuilder> consumer, DurationSE timeout)
consumer
に提供された ServerResponse.SseBuilder
は、イベントの作成と送信に使用できます。例:
public ServerResponse handleSse(ServerRequest request) { return ServerResponse.sse(sse -> sse.send("Hello World!")); }
または、ID とイベント型の両方を設定するには:
public ServerResponse handleSse(ServerRequest request) { return ServerResponse.sse(sse -> sse .id("42) .event("event") .send("Hello World!")); }
consumer
- イベントビルダーが提供されるコンシューマー timeout
- タイムアウトするまで待機する最大時間