reactor.netty.http.server

Interface HttpServerResponse

All Superinterfaces:

HttpInfos, NettyOutbound, Publisher<java.lang.Void>

All Known Implementing Classes:

HttpToH2Operations

public interface HttpServerResponse
extends NettyOutbound, HttpInfos

An Http Reactive Channel with several accessor 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(io.netty.handler.codec.http.cookie.Cookie cookie) Add an outbound cookie
HttpServerResponse	addHeader(java.lang.CharSequence name, java.lang.CharSequence value) Add an outbound http header, appending the value if the header already exist.
HttpServerResponse	chunkedTransfer(boolean chunked) Set transfer-encoding header
HttpServerResponse	compression(boolean compress) Enable/Disable compression handling (gzip/deflate) for the underlying response
boolean	hasSentHeaders() Return true if headers and status have been sent to the client
HttpServerResponse	header(java.lang.CharSequence name, java.lang.CharSequence value) Set an outbound header, replacing any pre-existing value.
HttpServerResponse	headers(io.netty.handler.codec.http.HttpHeaders headers) Set outbound headers, replacing any pre-existing value for these headers.
HttpServerResponse	keepAlive(boolean keepAlive) Set the request keepAlive if true otherwise remove the existing connection keep alive header
default HttpServerResponse	options(java.util.function.Consumer<? super NettyPipeline.SendOptions> configurator) Provide a new NettyOutbound scoped configuration for sending.
io.netty.handler.codec.http.HttpHeaders	responseHeaders() Return headers sent back to the clients
Mono<java.lang.Void>	send() Send headers and empty content thus delimiting a full empty body http response.
NettyOutbound	sendHeaders() Return a NettyOutbound successful on committed response
Mono<java.lang.Void>	sendNotFound() Send 404 status HttpResponseStatus.NOT_FOUND.
Mono<java.lang.Void>	sendRedirect(java.lang.String location) Send redirect status HttpResponseStatus.FOUND along with a location header to the remote client.
default Mono<java.lang.Void>	sendWebsocket(java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<java.lang.Void>> websocketHandler) Upgrade connection to Websocket.
default Mono<java.lang.Void>	sendWebsocket(java.lang.String protocols, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<java.lang.Void>> websocketHandler) Upgrade connection to Websocket with optional subprotocol(s).
Mono<java.lang.Void>	sendWebsocket(java.lang.String protocols, int maxFramePayloadLength, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<java.lang.Void>> websocketHandler) Upgrade connection to Websocket with optional subprotocol(s).
HttpServerResponse	sse() Add "text/event-stream" content-type for Server-Sent Events
io.netty.handler.codec.http.HttpResponseStatus	status() Return the assigned HTTP status
HttpServerResponse	status(io.netty.handler.codec.http.HttpResponseStatus status) Set an HTTP status to be sent along with the headers
default HttpServerResponse	status(int status) Set 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, sendByteArray, sendFile, sendFile, sendFileChunked, sendGroups, sendObject, sendObject, sendString, sendString, sendUsing, subscribe, then, then

Methods inherited from interface reactor.netty.http.HttpInfos

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

Method Detail

addCookie

HttpServerResponse addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)

Add an outbound cookie

Returns:

this outbound

addHeader

HttpServerResponse addHeader(java.lang.CharSequence name,
                             java.lang.CharSequence value)

Add an outbound http header, appending the value if the header already exist.

Parameters:

name - header name

value - header value

Returns:

this outbound

chunkedTransfer

HttpServerResponse chunkedTransfer(boolean chunked)

Set transfer-encoding header

Parameters:

chunked - true if transfer-encoding:chunked

Returns:

this outbound

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)

Enable/Disable compression handling (gzip/deflate) for the underlying response

Parameters:

compress - should handle compression

Returns:

this outbound

hasSentHeaders

boolean hasSentHeaders()

Return 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(java.lang.CharSequence name,
                          java.lang.CharSequence value)

Set an outbound header, replacing any pre-existing value.

Parameters:

name - headers key

value - header value

Returns:

this outbound

headers

HttpServerResponse headers(io.netty.handler.codec.http.HttpHeaders headers)

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

Parameters:

headers - netty headers map

Returns:

this outbound

keepAlive

HttpServerResponse keepAlive(boolean keepAlive)

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

Returns:

this outbound

options

default HttpServerResponse options(java.util.function.Consumer<? super NettyPipeline.SendOptions> configurator)

Description copied from interface: NettyOutbound

Provide a new NettyOutbound scoped configuration for sending. The NettyPipeline.SendOptions changes will apply to the next written object or Publisher.

Specified by:

options in interface NettyOutbound

Parameters:

configurator - the callback invoked to retrieve send configuration

Returns:

this instance

responseHeaders

io.netty.handler.codec.http.HttpHeaders responseHeaders()

Return headers sent back to the clients

Returns:

headers sent back to the clients

send

Mono<java.lang.Void> send()

Send 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()

Return a NettyOutbound successful on committed response

Returns:

a NettyOutbound successful on committed response

sendNotFound

Mono<java.lang.Void> sendNotFound()

Send 404 status HttpResponseStatus.NOT_FOUND.

Returns:

a Mono successful on flush confirmation

sendRedirect

Mono<java.lang.Void> sendRedirect(java.lang.String location)

Send 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<java.lang.Void> sendWebsocket(java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<java.lang.Void>> websocketHandler)

Upgrade connection to Websocket. Mono and Callback are invoked on handshake success, otherwise the returned Mono fails.

Parameters:

websocketHandler - the in/out handler for ws transport

Returns:

a Mono completing when upgrade is confirmed

sendWebsocket

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

Upgrade connection to Websocket with optional subprotocol(s). Mono and Callback are invoked on handshake success, otherwise the returned Mono fails.

Parameters:

protocols - optional sub-protocol

websocketHandler - the in/out handler for ws transport

Returns:

a Mono completing when upgrade is confirmed

sendWebsocket

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

Upgrade connection to Websocket with optional subprotocol(s). Mono and Callback are invoked on handshake success, otherwise the returned Mono fails.

Parameters:

protocols - optional sub-protocol

maxFramePayloadLength - maximum allowable frame payload length

websocketHandler - the in/out handler for ws transport

Returns:

a Mono completing when upgrade is confirmed

sse

HttpServerResponse sse()

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

Returns:

this response

status

io.netty.handler.codec.http.HttpResponseStatus status()

Return the assigned HTTP status

Returns:

the assigned HTTP status

status

HttpServerResponse status(io.netty.handler.codec.http.HttpResponseStatus status)

Set an HTTP status to be sent along with the headers

Parameters:

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

Returns:

this response

status

default HttpServerResponse status(int status)

Set an HTTP status to be sent along with the headers

Parameters:

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

Returns:

this response