reactor.netty.http.server

Class HttpToH2Operations

java.lang.Object

reactor.netty.channel.ChannelOperations<INBOUND,OUTBOUND>

reactor.netty.http.HttpOperations<HttpServerRequest,HttpServerResponse>

reactor.netty.http.server.HttpToH2Operations

All Implemented Interfaces:

Publisher<Void>, Subscriber<Void>, CoreSubscriber<Void>, Disposable, Connection, DisposableChannel, HttpInfos, HttpServerRequest, HttpServerResponse, NettyInbound, NettyOutbound

public class HttpToH2Operations
extends HttpOperations<HttpServerRequest,HttpServerResponse>

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from class reactor.netty.http.HttpOperations

HttpOperations.PostHeadersNettyOutbound

Nested classes/interfaces inherited from class reactor.netty.channel.ChannelOperations

ChannelOperations.OnSetup

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

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.
reactor.netty.http.server.HttpServerOperations	chunkedTransfer(boolean chunked) Sets Transfer-Encoding header
HttpServerResponse	compression(boolean compress) Enables/Disables compression handling (gzip/deflate) for the underlying response
Map<CharSequence,Set<Cookie>>	cookies() Returns resolved HTTP cookies
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.
InetSocketAddress	hostAddress() Returns the address of the host peer.
boolean	isKeepAlive() Is the request keep alive
boolean	isWebsocket() Returns true if websocket connection (upgraded)
HttpServerResponse	keepAlive(boolean keepAlive) Sets the request keepAlive if true otherwise remove the existing connection keep alive header
HttpMethod	method() Returns the resolved request method (HTTP 1.1 etc)
protected HttpMessage	newFullBodyMessage(ByteBuf body)
protected void	onInboundNext(ChannelHandlerContext ctx, Object msg) React on inbound Channel.read()
protected void	onOutboundComplete() React on inbound/outbound completion (last packet)
protected void	onOutboundError(Throwable err) There is no need of invoking ChannelOperations.discard(), the inbound will be canceled on channel inactive event if there is no subscriber available
reactor.netty.http.server.HttpServerOperations	options(java.util.function.Consumer<? super NettyPipeline.SendOptions> configurator) Provides a new NettyOutbound scoped configuration for sending.
protected HttpMessage	outboundHttpMessage() Outbound Netty HttpMessage
String	param(CharSequence key) URI parameter captured via {} "/test/{var}"
Map<String,String>	params() Returns the param captured key/value map
HttpServerRequest	paramsResolver(java.util.function.Function<? super String,Map<String,String>> headerResolver)
protected void	preSendHeadersAndStatus()
Flux<?>	receiveObject() a Object inbound Flux
InetSocketAddress	remoteAddress() Returns the address of the remote peer.
HttpHeaders	requestHeaders() Returns inbound HttpHeaders
HttpHeaders	responseHeaders() Returns the outbound HTTP headers, sent back to the clients
String	scheme() Returns the current protocol scheme
Mono<Void>	send() Sends the HTTP headers and empty content thus delimiting a full empty body http response.
NettyOutbound	sendFile(Path file) Sends content from given Path using FileChannel.transferTo(long, long, WritableByteChannel) support.
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.
Mono<Void>	sendWebsocket(String protocols, int maxFramePayloadLength, java.util.function.BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<Void>> websocketHandler) Upgrades the connection to websocket with optional subprotocol(s).
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
String	uri() Returns the resolved target address
HttpVersion	version() Returns the resolved request version (HTTP 1.1 etc)
reactor.netty.http.server.HttpServerOperations	withConnection(java.util.function.Consumer<? super Connection> withConnection) Calls the passed callback with a Connection to operate on the underlying Channel state.

Methods inherited from class reactor.netty.http.HttpOperations

addHandler, hasSentHeaders, markSentBody, markSentHeaderAndBody, markSentHeaders, send, sendFile, sendObject, then, toString

Methods inherited from class reactor.netty.channel.ChannelOperations

addReactiveBridge, alloc, as, channel, connection, currentContext, discard, dispose, disposeSubscriber, formatName, get, inbound, isDisposed, isInboundCancelled, isInboundDisposed, isPersistent, listener, onComplete, onDispose, onDispose, onError, onInboundCancel, onInboundClose, onInboundComplete, onInboundError, onNext, onSubscribe, onTerminate, outbound, receive, sendObject, sendUsing, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.netty.http.server.HttpServerRequest

receiveContent

Methods inherited from interface reactor.netty.NettyInbound

receive

Methods inherited from interface reactor.netty.http.server.HttpServerResponse

hasSentHeaders, sendWebsocket, sendWebsocket, status

Methods inherited from interface reactor.netty.NettyOutbound

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

Methods inherited from interface reactor.netty.http.HttpInfos

path

Methods inherited from interface reactor.netty.Connection

addHandler, addHandlerFirst, addHandlerFirst, addHandlerLast, addHandlerLast, bind, from, markPersistent, onReadIdle, onWriteIdle, rebind, removeHandler, replaceHandler

Methods inherited from interface reactor.netty.DisposableChannel

address, disposeNow, disposeNow

Method Detail

onInboundNext

protected void onInboundNext(ChannelHandlerContext ctx,
                             Object msg)

Description copied from class: ChannelOperations

React on inbound Channel.read()

Parameters:

ctx - the context

msg - the read payload

sendHeaders

public NettyOutbound sendHeaders()

Description copied from interface: HttpServerResponse

Returns a NettyOutbound successful on committed response

Specified by:

sendHeaders in interface HttpServerResponse

Returns:

a NettyOutbound successful on committed response

withConnection

public reactor.netty.http.server.HttpServerOperations withConnection(java.util.function.Consumer<? super Connection> withConnection)

Description copied from interface: NettyInbound

Calls the passed callback with a Connection to operate on the underlying Channel state. This allows for chaining inbound API.

Specified by:

withConnection in interface HttpServerRequest

Specified by:

withConnection in interface HttpServerResponse

Specified by:

withConnection in interface NettyInbound

Specified by:

withConnection in interface NettyOutbound

Overrides:

withConnection in class ChannelOperations<HttpServerRequest,HttpServerResponse>

Parameters:

withConnection - connection callback

Returns:

the Connection

newFullBodyMessage

protected HttpMessage newFullBodyMessage(ByteBuf body)

Specified by:

newFullBodyMessage in class HttpOperations<HttpServerRequest,HttpServerResponse>

addCookie

public HttpServerResponse addCookie(Cookie cookie)

Description copied from interface: HttpServerResponse

Adds an outbound cookie

Specified by:

addCookie in interface HttpServerResponse

Returns:

this HttpServerResponse

addHeader

public HttpServerResponse addHeader(CharSequence name,
                                    CharSequence value)

Description copied from interface: HttpServerResponse

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

Specified by:

addHeader in interface HttpServerResponse

Parameters:

name - header name

value - header value

Returns:

this HttpServerResponse

chunkedTransfer

public reactor.netty.http.server.HttpServerOperations chunkedTransfer(boolean chunked)

Description copied from interface: HttpServerResponse

Sets Transfer-Encoding header

Specified by:

chunkedTransfer in interface HttpServerResponse

Parameters:

chunked - true if Transfer-Encoding: chunked

Returns:

this HttpServerResponse

cookies

public Map<CharSequence,Set<Cookie>> cookies()

Description copied from interface: HttpInfos

Returns resolved HTTP cookies

Specified by:

cookies in interface HttpInfos

Returns:

Resolved HTTP cookies

header

public HttpServerResponse header(CharSequence name,
                                 CharSequence value)

Description copied from interface: HttpServerResponse

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

Specified by:

header in interface HttpServerResponse

Parameters:

name - headers key

value - header value

Returns:

this HttpServerResponse

headers

public HttpServerResponse headers(HttpHeaders headers)

Description copied from interface: HttpServerResponse

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

Specified by:

headers in interface HttpServerResponse

Parameters:

headers - netty headers map

Returns:

this HttpServerResponse

isKeepAlive

public boolean isKeepAlive()

Description copied from interface: HttpInfos

Is the request keep alive

Specified by:

isKeepAlive in interface HttpInfos

Returns:

is keep alive

isWebsocket

public boolean isWebsocket()

Description copied from interface: HttpInfos

Returns true if websocket connection (upgraded)

Specified by:

isWebsocket in interface HttpInfos

Overrides:

isWebsocket in class HttpOperations<HttpServerRequest,HttpServerResponse>

Returns:

true if websocket connection

keepAlive

public HttpServerResponse keepAlive(boolean keepAlive)

Description copied from interface: HttpServerResponse

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

Specified by:

keepAlive in interface HttpServerResponse

Returns:

this HttpServerResponse

method

public HttpMethod method()

Description copied from interface: HttpInfos

Returns the resolved request method (HTTP 1.1 etc)

Specified by:

method in interface HttpInfos

Returns:

the resolved request method (HTTP 1.1 etc)

param

@Nullable
public String param(CharSequence key)

Description copied from interface: HttpServerRequest

URI parameter captured via {} "/test/{var}"

Specified by:

param in interface HttpServerRequest

Parameters:

key - param var name

Returns:

the param captured value

params

@Nullable
public Map<String,String> params()

Description copied from interface: HttpServerRequest

Returns the param captured key/value map

Specified by:

params in interface HttpServerRequest

Returns:

the param captured key/value map

paramsResolver

public HttpServerRequest paramsResolver(java.util.function.Function<? super String,Map<String,String>> headerResolver)

Specified by:

paramsResolver in interface HttpServerRequest

Parameters:

headerResolver - provide a params

Returns:

this HttpServerRequest

receiveObject

public Flux<?> receiveObject()

Description copied from interface: NettyInbound

a Object inbound Flux

Specified by:

receiveObject in interface NettyInbound

Overrides:

receiveObject in class ChannelOperations<HttpServerRequest,HttpServerResponse>

Returns:

a Object inbound Flux

hostAddress

public InetSocketAddress hostAddress()

Description copied from interface: HttpServerRequest

Returns the address of the host peer.

Specified by:

hostAddress in interface HttpServerRequest

Returns:

the host's address

remoteAddress

public InetSocketAddress remoteAddress()

Description copied from interface: HttpServerRequest

Returns the address of the remote peer.

Specified by:

remoteAddress in interface HttpServerRequest

Returns:

the peer's address

requestHeaders

public HttpHeaders requestHeaders()

Description copied from interface: HttpServerRequest

Returns inbound HttpHeaders

Specified by:

requestHeaders in interface HttpServerRequest

Returns:

inbound HttpHeaders

options

public reactor.netty.http.server.HttpServerOperations options(java.util.function.Consumer<? super NettyPipeline.SendOptions> configurator)

Description copied from interface: NettyOutbound

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

Specified by:

options in interface HttpServerResponse

Specified by:

options in interface NettyOutbound

Overrides:

options in class ChannelOperations<HttpServerRequest,HttpServerResponse>

Parameters:

configurator - the callback invoked to retrieve send configuration

Returns:

this NettyOutbound

scheme

public String scheme()

Description copied from interface: HttpServerRequest

Returns the current protocol scheme

Specified by:

scheme in interface HttpServerRequest

Returns:

the protocol scheme

responseHeaders

public HttpHeaders responseHeaders()

Description copied from interface: HttpServerResponse

Returns the outbound HTTP headers, sent back to the clients

Specified by:

responseHeaders in interface HttpServerResponse

Returns:

headers sent back to the clients

send

public Mono<Void> send()

Description copied from interface: HttpServerResponse

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

Specified by:

send in interface HttpServerResponse

Returns:

a Mono successful on committed response

See Also:

NettyOutbound.send(Publisher)

sendFile

public NettyOutbound sendFile(Path file)

Description copied from interface: NettyOutbound

Sends content from given Path using FileChannel.transferTo(long, long, WritableByteChannel) support. If the system supports it and the path resolves to a local file system File then transfer will use zero-byte copy to the peer.

It will listen for any error on write and close on terminal signal (complete|error). If more than one publisher is attached (multiple calls to send()) completion occurs after all publishers complete.

Note: this will emit FileRegion in the outbound ChannelPipeline Note: Nesting any send* method is not supported.

Specified by:

sendFile in interface NettyOutbound

Parameters:

file - the file Path

Returns:

A Publisher to signal successful sequence write (e.g. after "flush") or any error during write

sendNotFound

public Mono<Void> sendNotFound()

Description copied from interface: HttpServerResponse

Sends 404 status HttpResponseStatus.NOT_FOUND.

Specified by:

sendNotFound in interface HttpServerResponse

Returns:

a Mono successful on flush confirmation

sendRedirect

public Mono<Void> sendRedirect(String location)

Description copied from interface: HttpServerResponse

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

Specified by:

sendRedirect in interface HttpServerResponse

Parameters:

location - the location to redirect to

Returns:

a Mono successful on flush confirmation

sse

public HttpServerResponse sse()

Description copied from interface: HttpServerResponse

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

Specified by:

sse in interface HttpServerResponse

Returns:

the Transfer setting SSE for this http connection (e.g. event-stream)

status

public HttpResponseStatus status()

Description copied from interface: HttpServerResponse

Returns the assigned HTTP status

Specified by:

status in interface HttpServerResponse

Returns:

the assigned HTTP status

status

public HttpServerResponse status(HttpResponseStatus status)

Description copied from interface: HttpServerResponse

Sets an HTTP status to be sent along with the headers

Specified by:

status in interface HttpServerResponse

Parameters:

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

Returns:

this HttpServerResponse

sendWebsocket

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

Description copied from interface: HttpServerResponse

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.

Specified by:

sendWebsocket in interface HttpServerResponse

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

uri

public String uri()

Description copied from interface: HttpInfos

Returns the resolved target address

Specified by:

uri in interface HttpInfos

Returns:

the resolved target address

version

public HttpVersion version()

Description copied from interface: HttpInfos

Returns the resolved request version (HTTP 1.1 etc)

Specified by:

version in interface HttpInfos

Returns:

the resolved request version (HTTP 1.1 etc)

compression

public HttpServerResponse compression(boolean compress)

Description copied from interface: HttpServerResponse

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

Specified by:

compression in interface HttpServerResponse

Parameters:

compress - should handle compression

Returns:

this HttpServerResponse

preSendHeadersAndStatus

protected void preSendHeadersAndStatus()

Specified by:

preSendHeadersAndStatus in class HttpOperations<HttpServerRequest,HttpServerResponse>

onOutboundComplete

protected void onOutboundComplete()

Description copied from class: ChannelOperations

React on inbound/outbound completion (last packet)

Overrides:

onOutboundComplete in class ChannelOperations<HttpServerRequest,HttpServerResponse>

onOutboundError

protected void onOutboundError(Throwable err)

There is no need of invoking ChannelOperations.discard(), the inbound will be canceled on channel inactive event if there is no subscriber available

Overrides:

onOutboundError in class ChannelOperations<HttpServerRequest,HttpServerResponse>

Parameters:

err - the Throwable cause

outboundHttpMessage

protected HttpMessage outboundHttpMessage()

Description copied from class: HttpOperations

Outbound Netty HttpMessage

Specified by:

outboundHttpMessage in class HttpOperations<HttpServerRequest,HttpServerResponse>

Returns:

Outbound Netty HttpMessage