org.springframework.web.reactive.function.server

Interface ServerResponse.BodyBuilder

All Superinterfaces:

ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

All Known Implementing Classes:

DefaultServerResponseBuilder

Enclosing interface:

ServerResponse

public static interface ServerResponse.BodyBuilder
extends ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

Defines a builder that adds a body to the response.

Method Summary

Modifier and Type	Method and Description
<any>	body(BodyInserter<?,? super ServerHttpResponse> inserter) Set the body of the response to the given BodyInserter and return it.
<T,P extends <any>> <any>	body(P publisher, java.lang.Class<T> elementClass) Set the body of the response to the given asynchronous Publisher and return it.
<T,P extends <any>> <any>	body(P publisher, ParameterizedTypeReference<T> typeReference) Set the body of the response to the given asynchronous Publisher and return it.
ServerResponse.BodyBuilder	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
ServerResponse.BodyBuilder	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
ServerResponse.BodyBuilder	hint(java.lang.String key, java.lang.Object value) Add a serialization hint like Jackson2CodecSupport.JSON_VIEW_HINT to customize how the body will be serialized.
ServerResponse.BodyBuilder	hints(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> hintsConsumer) Customize the serialization hints with the given consumer.
<any>	render(java.lang.String name, java.util.Map<java.lang.String,?> model) Render the template with the given name using the given model.
<any>	render(java.lang.String name, java.lang.Object... modelAttributes) Render the template with the given name using the given modelAttributes.
<any>	syncBody(java.lang.Object body) Set the body of the response to the given synchronous Object and return it.

Methods inherited from interface org.springframework.web.reactive.function.server.ServerResponse.HeadersBuilder

allow, allow, build, build, build, cacheControl, cookie, cookies, eTag, header, headers, lastModified, lastModified, location, varyBy

Method Detail

contentLength

ServerResponse.BodyBuilder contentLength(long contentLength)

Set the length of the body in bytes, as specified by the Content-Length header.

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

ServerResponse.BodyBuilder contentType(MediaType contentType)

Set the media type of the body, as specified by the Content-Type header.

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

hint

ServerResponse.BodyBuilder hint(java.lang.String key,
                                java.lang.Object value)

Add a serialization hint like Jackson2CodecSupport.JSON_VIEW_HINT to customize how the body will be serialized.

Parameters:

key - the hint key

value - the hint value

hints

ServerResponse.BodyBuilder hints(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> hintsConsumer)

Customize the serialization hints with the given consumer.

Parameters:

hintsConsumer - a function that consumes the hints

Returns:

this builder

Since:

5.1.6

body

<T,P extends <any>> <any> body(P publisher,
                               java.lang.Class<T> elementClass)

Set the body of the response to the given asynchronous Publisher and return it. This convenience method combines body(BodyInserter) and BodyInserters#fromPublisher(Publisher, Class).

Type Parameters:

T - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the response

elementClass - the class of elements contained in the publisher

Returns:

the built response

body

<T,P extends <any>> <any> body(P publisher,
                               ParameterizedTypeReference<T> typeReference)

Set the body of the response to the given asynchronous Publisher and return it. This convenience method combines body(BodyInserter) and BodyInserters#fromPublisher(Publisher, Class).

Type Parameters:

T - the type of the elements contained in the publisher

P - the type of the Publisher

Parameters:

publisher - the Publisher to write to the response

typeReference - a type reference describing the elements contained in the publisher

Returns:

the built response

syncBody

<any> syncBody(java.lang.Object body)

Set the body of the response to the given synchronous Object and return it. This convenience method combines body(BodyInserter) and BodyInserters.fromObject(Object).

Parameters:

body - the body of the response

Returns:

the built response

Throws:

java.lang.IllegalArgumentException - if body is a Publisher, for which #body(Publisher, Class) should be used.

body

<any> body(BodyInserter<?,? super ServerHttpResponse> inserter)

Set the body of the response to the given BodyInserter and return it.

Parameters:

inserter - the BodyInserter that writes to the response

Returns:

the built response

render

<any> render(java.lang.String name,
             java.lang.Object... modelAttributes)

Render the template with the given name using the given modelAttributes. The model attributes are mapped under a generated name.

Note: Empty Collections are not added to the model when using this method because we cannot correctly determine the true convention name.

Parameters:

name - the name of the template to be rendered

modelAttributes - the modelAttributes used to render the template

Returns:

the built response

render

<any> render(java.lang.String name,
             java.util.Map<java.lang.String,?> model)

Render the template with the given name using the given model.

Parameters:

name - the name of the template to be rendered

model - the model used to render the template

Returns:

the built response