インターフェース ServerResponse.BodyBuilder

メソッドの詳細

• contentLength

  ServerResponse.BodyBuilder contentLength(long contentLength)

  Content-Length ヘッダーで指定されているように、本文の長さをバイト単位で設定します。

  パラメーター:

  contentLength - コンテンツの長さ

  戻り値:

  このビルダー

  関連事項:

  • HttpHeaders.setContentLength(long)

• contentType

  ServerResponse.BodyBuilder contentType(MediaType contentType)

  Content-Type ヘッダーで指定されているように、本文のメディア型を設定します。

  パラメーター:

  contentType - コンテンツ型

  戻り値:

  このビルダー

  関連事項:

  • HttpHeaders.setContentType(MediaType)

• hint

  ServerResponse.BodyBuilder hint(StringSE key, ObjectSE value)

  本体の直列化方法をカスタマイズするには、Jackson2CodecSupport.JSON_VIEW_HINT のような直列化のヒントを追加します。

  パラメーター:

  key - ヒントキー

  value - ヒント値

• hints

  ServerResponse.BodyBuilder hints(ConsumerSE<MapSE<StringSE,ObjectSE>> hintsConsumer)

  指定されたコンシューマーで直列化のヒントをカスタマイズします。

  パラメーター:

  hintsConsumer - ヒントを消費する関数

  戻り値:

  このビルダー

  導入:

  5.1.6

• bodyValue

  reactor.core.publisher.Mono<ServerResponse> bodyValue(ObjectSE body)

  レスポンスの本文を指定の Object に設定して返します。これは、値挿入機能を備えた body(BodyInserter) を使用するためのショートカットです。

  パラメーター:

  body - レスポンスの本文

  戻り値:

  構築されたレスポンス

  例外:

  IllegalArgumentExceptionSE - body が Publisher または ReactiveAdapterRegistry に知られているプロデューサーである場合

  導入:

  5.2

• bodyValue

  <T> reactor.core.publisher.Mono<ServerResponse> bodyValue(T body, ParameterizedTypeReference<T> bodyType)

  レスポンスの本文を指定の Object に設定して返します。これは、値挿入機能を備えた body(BodyInserter) を使用するためのショートカットです。

  型パラメーター:

  T - 体の種類

  パラメーター:

  body - レスポンスの本文

  bodyType - ジェネリクス型をキャプチャーするために使用されるボディの型

  戻り値:

  構築されたレスポンス

  例外:

  IllegalArgumentExceptionSE - body が Publisher または ReactiveAdapterRegistry に知られているプロデューサーである場合

  導入:

  6.2

• body

  <T, P extends Publisher<T>> reactor.core.publisher.Mono<ServerResponse> body(P publisher, ClassSE<T> elementClass)

  与えられた Publisher から本体を設定します。パブリッシャーインサーターを使用した body(BodyInserter) のショートカット。

  型パラメーター:

  T - パブリッシャーに含まれる要素の型

  P - Publisher の型

  パラメーター:

  publisher - レスポンスに書き込む Publisher 

  elementClass - 公開された要素の型

  戻り値:

  構築されたレスポンス

• body

  <T, P extends Publisher<T>> reactor.core.publisher.Mono<ServerResponse> body(P publisher, ParameterizedTypeReference<T> elementTypeRef)

  ReactiveAdapterRegistry を介して Publisher に解決できる任意のプロデューサーを使用できるようにする body(Publisher, Class) のバリアント。

  型パラメーター:

  T - パブリッシャーに含まれる要素の型

  P - Publisher の型

  パラメーター:

  publisher - レスポンスを書き込むために使用する Publisher 

  elementTypeRef - 生成される要素の型

  戻り値:

  構築されたレスポンス

• body

  reactor.core.publisher.Mono<ServerResponse> body(ObjectSE producer, ClassSE<?> elementClass)

  ReactiveAdapterRegistry を介して Publisher に解決できる任意のプロデューサーを使用できるようにする body(Publisher, Class) のバリアント。

  パラメーター:

  producer - リクエストに書き込むプロデューサー

  elementClass - 生成される要素の型

  戻り値:

  構築されたレスポンス

  導入:

  5.2

• body

  reactor.core.publisher.Mono<ServerResponse> body(ObjectSE producer, ParameterizedTypeReference<?> elementTypeRef)

  ReactiveAdapterRegistry を介して Publisher に解決できる任意のプロデューサーを使用できるようにする body(Publisher, ParameterizedTypeReference) のバリアント。

  パラメーター:

  producer - レスポンスに書き込むプロデューサー

  elementTypeRef - 生成される要素の型

  戻り値:

  構築されたレスポンス

  導入:

  5.2

• body

  reactor.core.publisher.Mono<ServerResponse> body(BodyInserter<?,? super ServerHttpResponse> inserter)

  レスポンスの本文を指定の BodyInserter に設定して返します。

  パラメーター:

  inserter - レスポンスに書き込む BodyInserter 

  戻り値:

  構築されたレスポンス

• syncBody

  @DeprecatedSE reactor.core.publisher.Mono<ServerResponse> syncBody(ObjectSE body)

  使用すべきではありません。

  Spring Framework 5.2 現在、bodyValue(Object) を推奨

  レスポンスの本文を指定された Object に設定して返します。5.2 以降、このメソッドは bodyValue(Object) に委譲されます。

• render

  reactor.core.publisher.Mono<ServerResponse> render(StringSE name, ObjectSE... modelAttributes)

  指定された modelAttributes を使用して、指定された name でテンプレートをレンダリングします。モデル属性は、生成された名前でマップされます。

  注: この方法を使用しても、実際の規則名を正しく判別できないため、空の CollectionsSE はモデルに追加されません。

  パラメーター:

  name - レンダリングされるテンプレートの名前

  modelAttributes - テンプレートをレンダリングするために使用された modelAttributes

  戻り値:

  構築されたレスポンス

• render

  reactor.core.publisher.Mono<ServerResponse> render(StringSE name, MapSE<StringSE,?> model)

  指定された model を使用して、指定された name でテンプレートをレンダリングします。

  パラメーター:

  name - レンダリングされるテンプレートの名前

  model - テンプレートのレンダリングに使用されるモデル

  戻り値:

  構築されたレスポンス