reactor.netty.http.server

Interface HttpServerResponse

All Superinterfaces:

HttpInfos, NettyOutbound, Publisher<Void>

public interface HttpServerResponse
extends NettyOutbound, HttpInfos

An Http Reactive Channel with several accessors related to HTTP flow: headers, params, URI, method, websocket...

Since:

0.5

Author:

Stephane Maldini

Method Summary

Modifier and Type	Method and Description
HttpServerResponse	addCookie(Cookie cookie) Adds an outbound cookie
HttpServerResponse	addHeader(CharSequence name, CharSequence value) Adds an outbound HTTP header, appending the value if the header already exist.
HttpServerResponse	chunkedTransfer(boolean chunked) Sets Transfer-Encoding header
HttpServerResponse	compression(boolean compress) Enables/Disables compression handling (gzip/deflate) for the underlying response
boolean	hasSentHeaders() Returns true if headers and status have been sent to the client
HttpServerResponse	header(CharSequence name, CharSequence value) Sets an outbound HTTP header, replacing any pre-existing value.
HttpServerResponse	headers(HttpHeaders headers) Sets outbound HTTP headers, replacing any pre-existing value for these headers.
HttpServerResponse	keepAlive(boolean keepAlive) Sets the request keepAlive if true otherwise remove the existing connection keep alive header
HttpHeaders	responseHeaders() Returns the outbound HTTP headers, sent back to the clients
Mono<Void>	send() Sends the HTTP headers and empty content thus delimiting a full empty body http response.
NettyOutbound	sendHeaders() Returns a NettyOutbound successful on committed response
Mono<Void>	sendNotFound() Sends 404 status HttpResponseStatus.NOT_FOUND.
Mono<Void>	sendRedirect(String location) Sends redirect status HttpResponseStatus.FOUND along with a location header to the remote client.
default Mono<Void>	sendWebsocket(java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Upgrades the connection to websocket.
Mono<Void>	sendWebsocket(java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler, WebsocketServerSpec websocketServerSpec) Upgrades the connection to websocket.
default Mono<Void>	sendWebsocket(boolean proxyPing, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)
default Mono<Void>	sendWebsocket(String protocols, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)
default Mono<Void>	sendWebsocket(String protocols, int maxFramePayloadLength, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)
default Mono<Void>	sendWebsocket(String protocols, int maxFramePayloadLength, boolean proxyPing, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)
HttpServerResponse	sse() Adds "text/event-stream" content-type for Server-Sent Events
HttpResponseStatus	status() Returns the assigned HTTP status
HttpServerResponse	status(HttpResponseStatus status) Sets an HTTP status to be sent along with the headers
default HttpServerResponse	status(int status) Sets an HTTP status to be sent along with the headers
HttpServerResponse	withConnection(java.util.function.Consumer<? super Connection> withConnection) Call the passed callback with a Connection to operate on the underlying Channel state.

Methods inherited from interface reactor.netty.NettyOutbound

alloc, neverComplete, send, send, sendByteArray, sendFile, sendFile, sendFileChunked, sendGroups, sendObject, sendObject, sendObject, sendString, sendString, sendUsing, subscribe, then, then, then

Methods inherited from interface reactor.netty.http.HttpInfos

cookies, fullPath, isKeepAlive, isWebsocket, method, path, uri, version

Method Detail

addCookie

HttpServerResponse addCookie(Cookie cookie)

Adds an outbound cookie

Returns:

this HttpServerResponse

addHeader

HttpServerResponse addHeader(CharSequence name,
                             CharSequence value)

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

Parameters:

name - header name

value - header value

Returns:

this HttpServerResponse

chunkedTransfer

HttpServerResponse chunkedTransfer(boolean chunked)

Sets Transfer-Encoding header

Parameters:

chunked - true if Transfer-Encoding: chunked

Returns:

this HttpServerResponse

withConnection

HttpServerResponse withConnection(java.util.function.Consumer<? super Connection> withConnection)

Description copied from interface: NettyOutbound

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

Specified by:

withConnection in interface NettyOutbound

Parameters:

withConnection - connection callback

Returns:

the Connection

compression

HttpServerResponse compression(boolean compress)

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

Parameters:

compress - should handle compression

Returns:

this HttpServerResponse

hasSentHeaders

boolean hasSentHeaders()

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

Returns:

true if headers and status have been sent to the client

header

HttpServerResponse header(CharSequence name,
                          CharSequence value)

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

Parameters:

name - headers key

value - header value

Returns:

this HttpServerResponse

headers

HttpServerResponse headers(HttpHeaders headers)

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

Parameters:

headers - netty headers map

Returns:

this HttpServerResponse

keepAlive

HttpServerResponse keepAlive(boolean keepAlive)

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

Returns:

this HttpServerResponse

responseHeaders

HttpHeaders responseHeaders()

Returns the outbound HTTP headers, sent back to the clients

Returns:

headers sent back to the clients

send

Mono<Void> send()

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

Returns:

a Mono successful on committed response

See Also:

NettyOutbound.send(Publisher)

sendHeaders

NettyOutbound sendHeaders()

Returns a NettyOutbound successful on committed response

Returns:

a NettyOutbound successful on committed response

sendNotFound

Mono<Void> sendNotFound()

Sends 404 status HttpResponseStatus.NOT_FOUND.

Returns:

a Mono successful on flush confirmation

sendRedirect

Mono<Void> sendRedirect(String location)

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

Parameters:

location - the location to redirect to

Returns:

a Mono successful on flush confirmation

sendWebsocket

default Mono<Void> sendWebsocket(java.util.function.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 - the I/O handler for websocket transport

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

sendWebsocket

@Deprecated
default Mono<Void> sendWebsocket(boolean proxyPing,
                                             java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler)

Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, 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:

proxyPing - whether to proxy websocket ping frames or respond to them

websocketHandler - the I/O handler for websocket transport

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

Since:

0.9.3

sendWebsocket

@Deprecated
default Mono<Void> sendWebsocket(@Nullable
                                             String protocols,
                                             java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler)

Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)

Upgrades the connection to websocket with optional subprotocol(s). 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:

protocols - optional sub-protocol

websocketHandler - the I/O handler for websocket transport

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

sendWebsocket

@Deprecated
default Mono<Void> sendWebsocket(@Nullable
                                             String protocols,
                                             int maxFramePayloadLength,
                                             java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler)

Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)

Upgrades the connection to websocket with optional subprotocol(s). 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:

protocols - optional sub-protocol

maxFramePayloadLength - maximum allowable frame payload length

websocketHandler - the I/O handler for websocket transport

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

sendWebsocket

@Deprecated
default Mono<Void> sendWebsocket(@Nullable
                                             String protocols,
                                             int maxFramePayloadLength,
                                             boolean proxyPing,
                                             java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler)

Deprecated. as of 0.9.5. Use sendWebsocket(BiFunction, WebsocketServerSpec)

Upgrades the connection to websocket with optional subprotocol(s). 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:

protocols - optional sub-protocol

maxFramePayloadLength - maximum allowable frame payload length

proxyPing - whether to proxy websocket ping frames or respond to them

websocketHandler - the I/O handler for websocket transport

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

Since:

0.9.3

sendWebsocket

Mono<Void> sendWebsocket(java.util.function.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 - the I/O handler for websocket transport

websocketServerSpec - WebsocketServerSpec for websocket configuration

Returns:

a Mono completing when upgrade is confirmed, otherwise fails

Since:

0.9.5

sse

HttpServerResponse sse()

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

Returns:

this HttpServerResponse

status

HttpResponseStatus status()

Returns the assigned HTTP status

Returns:

the assigned HTTP status

status

HttpServerResponse status(HttpResponseStatus status)

Sets an HTTP status to be sent along with the headers

Parameters:

status - an HTTP status to be sent along with the headers

Returns:

this HttpServerResponse

status

default HttpServerResponse status(int status)

Sets an HTTP status to be sent along with the headers

Parameters:

status - an HTTP status to be sent along with the headers

Returns:

this HttpServerResponse