HTTP functionality for the Reactor Netty library 2.0.0-M3 · reactor.netty5.http.server.HttpServerResponse

Method Summary

Modifier and Type	Method and Description
public HttpServerResponse	Returns: this `HttpServerResponse` addCookie(HttpSetCookie cookie) Adds an outbound cookie
public HttpServerResponse	Returns: this `HttpServerResponse` addHeader(CharSequence header name name, CharSequence header value value) Adds an outbound HTTP header, appending the value if the header already exist.
public HttpServerResponse	Returns: this `HttpServerResponse` chunkedTransfer(boolean true if Transfer-Encoding: chunked chunked) Sets Transfer-Encoding header
public HttpServerResponse	Returns: this `HttpServerResponse` compression(boolean should handle compression compress) Enables/Disables compression handling (gzip/deflate) for the underlying response
public boolean	Returns: true if headers and status have been sent to the client hasSentHeaders() Returns true if headers and status have been sent to the client
public HttpServerResponse	Returns: this `HttpServerResponse` header(CharSequence headers key name, CharSequence header value value) Sets an outbound HTTP header, replacing any pre-existing value.
public HttpServerResponse	Returns: this `HttpServerResponse` headers(HttpHeaders netty headers map headers) Sets outbound HTTP headers, replacing any pre-existing value for these headers.
public HttpServerResponse	Returns: this `HttpServerResponse` keepAlive(boolean keepAlive) Sets the request `keepAlive` if true otherwise remove the existing connection keep alive header
public HttpHeaders	Returns: headers sent back to the clients responseHeaders() Returns the outbound HTTP headers, sent back to the clients
public Mono<Void>	Returns: a `Mono` successful on committed response send() Sends the HTTP headers and empty content thus delimiting a full empty body http response.
public NettyOutbound	Returns: a `NettyOutbound` successful on committed response sendHeaders() Returns a `NettyOutbound` successful on committed response
public Mono<Void>	Returns: a `Mono` successful on flush confirmation sendNotFound() Sends 404 status `HttpResponseStatus#NOT_FOUND`.
public Mono<Void>	Returns: a `Mono` successful on flush confirmation sendRedirect(String the location to redirect to location) Sends redirect status `HttpResponseStatus#FOUND` along with a location header to the remote client.
public default Mono<Void>	Returns: a `Mono` completing when upgrade is confirmed, otherwise fails sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> the I/O handler for websocket transport websocketHandler) Upgrades the connection to websocket.
public Mono<Void>	Returns: a `Mono` completing when upgrade is confirmed, otherwise fails sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> the I/O handler for websocket transport websocketHandler, WebsocketServerSpec `WebsocketServerSpec` for websocket configuration websocketServerSpec) Upgrades the connection to websocket.
public HttpServerResponse	Returns: this `HttpServerResponse` sse() Adds "text/event-stream" content-type for Server-Sent Events
public HttpResponseStatus	Returns: the assigned HTTP status status() Returns the assigned HTTP status
public HttpServerResponse	Returns: this `HttpServerResponse` status(HttpResponseStatus an HTTP status to be sent along with the headers status) Sets an HTTP status to be sent along with the headers
public default HttpServerResponse	Returns: this `HttpServerResponse` status(int an HTTP status to be sent along with the headers status) Sets an HTTP status to be sent along with the headers
public HttpServerResponse	Returns: this `HttpServerResponse` trailerHeaders(Consumer<? super HttpHeaders> netty headers map trailerHeaders) Callback for setting outbound trailer headers.
public HttpServerResponse	withConnection(Consumer<? super Connection> connection callback withConnection) Redeclares reactor.netty5.NettyOutbound.withConnection. Call the passed callback with a `Connection` to operate on the underlying `Channel` state.

Method Detail

addCookie back to summary

public HttpServerResponse addCookie(HttpSetCookie cookie)

Adds an outbound cookie

Returns:HttpServerResponse: this HttpServerResponse

addHeader back to summary

addHeader	back to summary
public HttpServerResponse addHeader(CharSequence name, CharSequence value) Adds an outbound HTTP header, appending the value if the header already exist. Parameters name:CharSequence header name value:CharSequence header value Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse addHeader(CharSequence name, CharSequence value)

Adds an outbound HTTP header, appending the value if the header already exist.

Parameters

name:CharSequence: header name
value:CharSequence: header value

Returns:HttpServerResponse

this HttpServerResponse

chunkedTransfer back to summary

chunkedTransfer	back to summary
public HttpServerResponse chunkedTransfer(boolean chunked) Sets Transfer-Encoding header Parameters chunked:boolean true if Transfer-Encoding: chunked Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse chunkedTransfer(boolean chunked)

Sets Transfer-Encoding header

Parameters

chunked:boolean: true if Transfer-Encoding: chunked

Returns:HttpServerResponse

this HttpServerResponse

compression back to summary

compression	back to summary
public HttpServerResponse compression(boolean compress) Enables/Disables compression handling (gzip/deflate) for the underlying response Parameters compress:boolean should handle compression Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse compression(boolean compress)

Enables/Disables compression handling (gzip/deflate) for the underlying response

Parameters

compress:boolean: should handle compression

Returns:HttpServerResponse

this HttpServerResponse

hasSentHeaders	back to summary
public boolean hasSentHeaders() Returns true if headers and status have been sent to the client Returns:boolean true if headers and status have been sent to the client

hasSentHeaders

back to summary

public boolean hasSentHeaders()

Returns true if headers and status have been sent to the client

Returns:boolean: true if headers and status have been sent to the client

header back to summary

header	back to summary
public HttpServerResponse header(CharSequence name, CharSequence value) Sets an outbound HTTP header, replacing any pre-existing value. Parameters name:CharSequence headers key value:CharSequence header value Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse header(CharSequence name, CharSequence value)

Sets an outbound HTTP header, replacing any pre-existing value.

Parameters

name:CharSequence: headers key
value:CharSequence: header value

Returns:HttpServerResponse

this HttpServerResponse

headers back to summary

headers	back to summary
public HttpServerResponse headers(HttpHeaders headers) Sets outbound HTTP headers, replacing any pre-existing value for these headers. Parameters headers:HttpHeaders netty headers map Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse headers(HttpHeaders headers)

Sets outbound HTTP headers, replacing any pre-existing value for these headers.

Parameters

headers:HttpHeaders: netty headers map

Returns:HttpServerResponse

this HttpServerResponse

keepAlive back to summary

keepAlive	back to summary
public HttpServerResponse keepAlive(boolean keepAlive) Sets the request `keepAlive` if true otherwise remove the existing connection keep alive header Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse keepAlive(boolean keepAlive)

Sets the request keepAlive if true otherwise remove the existing connection keep alive header

Returns:HttpServerResponse: this HttpServerResponse

responseHeaders	back to summary
public HttpHeaders responseHeaders() Returns the outbound HTTP headers, sent back to the clients Returns:HttpHeaders headers sent back to the clients

responseHeaders

back to summary

public HttpHeaders responseHeaders()

Returns the outbound HTTP headers, sent back to the clients

Returns:HttpHeaders: headers sent back to the clients

send back to summary

send	back to summary
public Mono<Void> send() Sends the HTTP headers and empty content thus delimiting a full empty body http response. Returns:Mono<Void> a `Mono` successful on committed response See Also `send(Publisher)`

public Mono<Void> send()

Sends the HTTP headers and empty content thus delimiting a full empty body http response.

Returns:Mono<Void>: a Mono successful on committed response
See Also: send(Publisher)

sendHeaders back to summary

sendHeaders	back to summary
public NettyOutbound sendHeaders() Returns a `NettyOutbound` successful on committed response Returns:NettyOutbound a `NettyOutbound` successful on committed response

public NettyOutbound sendHeaders()

Returns a NettyOutbound successful on committed response

Returns:NettyOutbound: a NettyOutbound successful on committed response

sendNotFound back to summary

sendNotFound	back to summary
public Mono<Void> sendNotFound() Sends 404 status `HttpResponseStatus#NOT_FOUND`. Returns:Mono<Void> a `Mono` successful on flush confirmation

public Mono<Void> sendNotFound()

Sends 404 status HttpResponseStatus#NOT_FOUND.

Returns:Mono<Void>: a Mono successful on flush confirmation

sendRedirect back to summary

sendRedirect	back to summary
public Mono<Void> sendRedirect(String location) Sends redirect status `HttpResponseStatus#FOUND` along with a location header to the remote client. Parameters location:String the location to redirect to Returns:Mono<Void> a `Mono` successful on flush confirmation

public Mono<Void> sendRedirect(String location)

Sends redirect status HttpResponseStatus#FOUND along with a location header to the remote client.

Parameters

location:String: the location to redirect to

Returns:Mono<Void>

a Mono successful on flush confirmation

sendWebsocket back to summary

sendWebsocket	back to summary
public default Mono<Void> sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> websocketHandler) Upgrades the connection to websocket. A `Mono` completing when the upgrade is confirmed, then the provided callback is invoked, if the upgrade is not successful the returned `Mono` fails. Parameters websocketHandler:BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> the I/O handler for websocket transport Returns:Mono<Void> a `Mono` completing when upgrade is confirmed, otherwise fails

public default Mono<Void> sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> websocketHandler)

Upgrades the connection to websocket. A Mono completing when the upgrade is confirmed, then the provided callback is invoked, if the upgrade is not successful the returned Mono fails.

Parameters

websocketHandler:BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>>: the I/O handler for websocket transport

Returns:Mono<Void>

a Mono completing when upgrade is confirmed, otherwise fails

sendWebsocket back to summary

sendWebsocket	back to summary
public Mono<Void> sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> websocketHandler, WebsocketServerSpec websocketServerSpec) Upgrades the connection to websocket. A `Mono` completing when the upgrade is confirmed, then the provided callback is invoked, if the upgrade is not successful the returned `Mono` fails. Parameters websocketHandler:BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> the I/O handler for websocket transport websocketServerSpec:WebsocketServerSpec `WebsocketServerSpec` for websocket configuration Returns:Mono<Void> a `Mono` completing when upgrade is confirmed, otherwise fails Since 0.9.5

public Mono<Void> sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> websocketHandler, WebsocketServerSpec websocketServerSpec)

Upgrades the connection to websocket. A Mono completing when the upgrade is confirmed, then the provided callback is invoked, if the upgrade is not successful the returned Mono fails.

Parameters

websocketHandler:BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>>: the I/O handler for websocket transport
websocketServerSpec:WebsocketServerSpec: WebsocketServerSpec for websocket configuration

Returns:Mono<Void>

a Mono completing when upgrade is confirmed, otherwise fails

Since

0.9.5

sse back to summary

sse	back to summary
public HttpServerResponse sse() Adds "text/event-stream" content-type for Server-Sent Events Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse sse()

Adds "text/event-stream" content-type for Server-Sent Events

Returns:HttpServerResponse: this HttpServerResponse

status	back to summary
public HttpResponseStatus status() Returns the assigned HTTP status Returns:HttpResponseStatus the assigned HTTP status

status

back to summary

public HttpResponseStatus status()

Returns the assigned HTTP status

Returns:HttpResponseStatus: the assigned HTTP status

status back to summary

status	back to summary
public HttpServerResponse status(HttpResponseStatus status) Sets an HTTP status to be sent along with the headers Parameters status:HttpResponseStatus an HTTP status to be sent along with the headers Returns:HttpServerResponse this `HttpServerResponse`

public HttpServerResponse status(HttpResponseStatus status)

Sets an HTTP status to be sent along with the headers

Parameters

status:HttpResponseStatus: an HTTP status to be sent along with the headers

Returns:HttpServerResponse

this HttpServerResponse

status back to summary

status	back to summary
public default HttpServerResponse status(int status) Sets an HTTP status to be sent along with the headers Parameters status:int an HTTP status to be sent along with the headers Returns:HttpServerResponse this `HttpServerResponse`

public default HttpServerResponse status(int status)

Sets an HTTP status to be sent along with the headers

Parameters

status:int: an HTTP status to be sent along with the headers

Returns:HttpServerResponse

this HttpServerResponse

trailerHeaders back to summary

trailerHeaders	back to summary
public HttpServerResponse trailerHeaders(Consumer<? super HttpHeaders> trailerHeaders) Callback for setting outbound trailer headers. The callback is invoked when the response is about to be completed. Note Only headers names declared with `HttpHeaderNames#TRAILER` are accepted. Note Trailer headers are sent only when a message body is encoded with the chunked transfer coding Note:The headers below cannot be sent as trailer headers: Age Cache-Control Content-Encoding Content-Length Content-Range Content-Type Date Expires Location Retry-After Trailer Transfer-Encoding Vary Warning Parameters trailerHeaders:Consumer<? super HttpHeaders> netty headers map Returns:HttpServerResponse this `HttpServerResponse` Since 1.0.12

public HttpServerResponse trailerHeaders(Consumer<? super HttpHeaders> trailerHeaders)

Callback for setting outbound trailer headers. The callback is invoked when the response is about to be completed.

Note

Only headers names declared with HttpHeaderNames#TRAILER are accepted.

Note

Trailer headers are sent only when a message body is encoded with the chunked transfer coding

Note:The headers below cannot be sent as trailer headers:

Age
Cache-Control
Content-Encoding
Content-Length
Content-Range
Content-Type
Date
Expires
Location
Retry-After
Trailer
Transfer-Encoding
Vary
Warning

Parameters

trailerHeaders:Consumer<? super HttpHeaders>: netty headers map

Returns:HttpServerResponse

this HttpServerResponse

Since

1.0.12

withConnection back to summary

withConnection	back to summary
public HttpServerResponse withConnection(Consumer<? super Connection> withConnection) Redeclares reactor.netty5.NettyOutbound.withConnection. Doc from reactor.netty5.NettyOutbound.withConnection. Call the passed callback with a `Connection` to operate on the underlying `Channel` state. Parameters withConnection:Consumer<? super Connection> connection callback Returns:HttpServerResponse the `Connection` Annotations @Override

public HttpServerResponse withConnection(Consumer<? super Connection> withConnection)

Redeclares reactor.netty5.NettyOutbound.withConnection.

Doc from reactor.netty5.NettyOutbound.withConnection.

Call the passed callback with a Connection to operate on the underlying Channel state.

Parameters

withConnection:Consumer<? super Connection>: connection callback

Returns:HttpServerResponse

the Connection

Annotations

@Override

public Interface HttpServerResponse

Method Summary

Method Detail