インターフェース ServerResponse

メソッドの詳細

• statusCode

  HttpStatusCode statusCode()

  このレスポンスのステータスコードを返します。

  戻り値:

  HttpStatusCode 値としてのステータス

• rawStatusCode

  @DeprecatedSE(since="6.0", forRemoval=true) int rawStatusCode()

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  statusCode() を推奨し、7.0 から削除

  このレスポンスのステータスコードを整数で返します。

  戻り値:

  整数としてのステータス

• headers

  HttpHeaders headers()

  このレスポンスのヘッダーを返します。

• cookies

  MultiValueMap<StringSE,CookieEE> cookies()

  このレスポンスの Cookie を返します。

• writeTo

  @Nullable ModelAndView writeTo(HttpServletRequestEE request, HttpServletResponseEE response, ServerResponse.Context context) throws ServletExceptionEE, IOExceptionSE

  このレスポンスを特定のサーブレットレスポンスに書き込みます。

  パラメーター:

  request - 現在のリクエスト

  response - 書き込むレスポンス

  context - 書くときに使用するコンテキスト

  戻り値:

  レンダリングする ModelAndView、または直接処理される場合は null 

  例外:

  ServletExceptionEE

  IOExceptionSE

• from

  static ServerResponse.BodyBuilder from(ServerResponse other)

  指定されたレスポンスのステータスコードとヘッダーを使用してビルダーを作成します。

  パラメーター:

  other - ステータスとヘッダーをコピーするレスポンス

  戻り値:

  作成されたビルダー

• from

  static ServerResponse from(ErrorResponse response)

  指定された ErrorResponse から ServerResponse を作成します。

  パラメーター:

  response - 初期化する ErrorResponse

  戻り値:

  構築されたレスポンス

  導入:

  6.0

• status

  static ServerResponse.BodyBuilder status(HttpStatusCode status)

  指定された HTTP ステータスでビルダーを作成します。

  パラメーター:

  status - レスポンスステータス

  戻り値:

  作成されたビルダー

• status

  static ServerResponse.BodyBuilder status(int status)

  指定された HTTP ステータスでビルダーを作成します。

  パラメーター:

  status - レスポンスステータス

  戻り値:

  作成されたビルダー

• ok

  static ServerResponse.BodyBuilder ok()

  ステータスを 200 OK に設定してビルダーを作成します。

  戻り値:

  作成されたビルダー

• created

  static ServerResponse.BodyBuilder created(URISE location)

  201 Created ステータスと特定の URI に設定されたロケーションヘッダーを使用してビルダーを作成します。

  パラメーター:

  location - ロケーション URI

  戻り値:

  作成されたビルダー

• accepted

  static ServerResponse.BodyBuilder accepted()

  202 Accepted ステータスのビルダーを作成します。

  戻り値:

  作成されたビルダー

• noContent

  static ServerResponse.HeadersBuilder<?> noContent()

  204 コンテンツなしステータスのビルダーを作成します。

  戻り値:

  作成されたビルダー

• seeOther

  static ServerResponse.BodyBuilder seeOther(URISE location)

  303 他を見るステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。

  パラメーター:

  location - ロケーション URI

  戻り値:

  作成されたビルダー

• temporaryRedirect

  static ServerResponse.BodyBuilder temporaryRedirect(URISE location)

  307 一時的なリダイレクトステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。

  パラメーター:

  location - ロケーション URI

  戻り値:

  作成されたビルダー

• permanentRedirect

  static ServerResponse.BodyBuilder permanentRedirect(URISE location)

  308 永久リダイレクトステータスと指定された URI に設定されたロケーションヘッダーを使用してビルダーを作成します。

  パラメーター:

  location - ロケーション URI

  戻り値:

  作成されたビルダー

• badRequest

  static ServerResponse.BodyBuilder badRequest()

  400 不正なリクエストステータスのビルダーを作成します。

  戻り値:

  作成されたビルダー

• notFound

  static ServerResponse.HeadersBuilder<?> notFound()

  404 お探しのページが見つかりませんでしたステータスのビルダーを作成します。

  戻り値:

  作成されたビルダー

• unprocessableEntity

  static ServerResponse.BodyBuilder unprocessableEntity()

  422 処理できないエンティティステータスのビルダーを作成します。

  戻り値:

  作成されたビルダー

• async

  static ServerResponse async(ObjectSE asyncResponse)

  指定された非同期レスポンスを使用して（構築された）レスポンスを作成します。パラメーター asyncResponse は、CompletableFuture<ServerResponse>SE または Publisher<ServerResponse>（または ReactiveAdapterRegistry を介して適合させることができる単一の ServerResponse の非同期プロデューサー）にすることができます。

  このメソッドを使用して、非同期の結果に基づいてレスポンスステータスコード、ヘッダー、本文を設定できます。本体のみが非同期の場合は、代わりに ServerResponse.BodyBuilder.body(Object) を使用できます。

  パラメーター:

  asyncResponse - CompletableFuture<ServerResponse> または Publisher<ServerResponse>

  戻り値:

  非同期レスポンス

  導入:

  5.3

• async

  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 - タイムアウトする前に待機する最大期間

  戻り値:

  非同期レスポンス

  導入:

  5.3.2

• sse

  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 - イベントビルダーが提供されるコンシューマー

  戻り値:

  サーバー側のイベントレスポンス

  導入:

  5.3.2

  関連事項:

  • サーバー送信イベント

• sse

  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 - タイムアウトするまで待機する最大時間

  戻り値:

  サーバー側のイベントレスポンス

  導入:

  5.3.2

  関連事項:

  • サーバー送信イベント