Top Description Inners Fields Constructors Methods
reactor.netty.http.server

pack-priv Class HttpServerOperations

extends HttpOperations<HttpServerRequest, HttpServerResponse>
implements HttpServerRequest, HttpServerResponse
Class Inheritance
All Implemented Interfaces
reactor.netty.http.server.HttpServerResponse, reactor.netty.http.server.HttpServerInfos, reactor.netty.http.server.ConnectionInformation, reactor.netty.http.HttpInfos, reactor.netty.NettyOutbound, org.reactivestreams.Publisher, reactor.netty.http.server.HttpServerRequest, reactor.netty.NettyInbound
Known Direct Subclasses
reactor.netty.http.server.HttpServerOperations.FailedHttpServerRequest, reactor.netty.http.server.WebsocketServerOperations
Imports
java.io.IOException, java.net.InetSocketAddress, .SocketAddress, java.nio.file.Files, .Path, java.time.Duration, .ZonedDateTime, java.util.HashSet, .List, .Locale, .Map, .Objects, .Set, java.util.concurrent.Future, .TimeUnit, java.util.concurrent.atomic.AtomicLong, java.util.function.BiFunction, .BiPredicate, .Consumer, .Function, io.netty.buffer.ByteBuf, .Unpooled, io.netty.channel.Channel, .ChannelFuture, .ChannelFutureListener, .ChannelHandlerContext, io.netty.handler.codec.DefaultHeaders, io.netty.handler.codec.http.DefaultFullHttpResponse, .DefaultHttpHeaders, .DefaultHttpResponse, .DefaultLastHttpContent, .FullHttpRequest, .FullHttpResponse, .HttpContent, .HttpHeaderNames, .HttpHeaderValues, .HttpHeaders, .HttpMessage, .HttpMethod, .HttpObject, .HttpRequest, .HttpResponse, .HttpResponseStatus, .HttpUtil, .HttpVersion, .LastHttpContent, .TooLongHttpHeaderException, .TooLongHttpLineException, io.netty.handler.codec.http.cookie.Cookie, .ServerCookieDecoder, .ServerCookieEncoder, io.netty.handler.codec.http.multipart.HttpData, .HttpPostRequestDecoder, io.netty.handler.codec.http.websocketx.CloseWebSocketFrame, .WebSocketCloseStatus, io.netty.handler.timeout.ReadTimeoutHandler, io.netty.util.AsciiString, .ReferenceCountUtil, org.reactivestreams.Publisher, .Subscription, reactor.core.CoreSubscriber, reactor.core.publisher.Flux, .Mono, reactor.netty.Connection, .ConnectionObserver, .FutureMono, .NettyOutbound, .NettyPipeline, .ReactorNetty, reactor.netty.channel.AbortedException, .ChannelOperations, reactor.netty.http.HttpOperations, reactor.netty.http.logging.HttpMessageArgProviderFactory, .HttpMessageLogFactory, reactor.netty.http.websocket.WebsocketInbound, .WebsocketOutbound, reactor.util.Logger, .Loggers, reactor.util.annotation.Nullable, reactor.util.context.Context
Conversion between Netty types and Reactor types (HttpOperations.
Author
Stephane Maldini1

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
HttpServerOperations.FailedHttpServerRequest

pack-priv class
HttpServerOperations.RequestTimeoutTask

pack-priv static class
HttpServerOperations.TrailerHeaders

pack-priv static class
HttpServerOperations.WebsocketSubscriber

Field Summary

Modifier and TypeField and Description
pack-priv static final BiPredicate<HttpServerRequest, HttpServerResponse>
COMPRESSION_DISABLED

pack-priv BiPredicate<HttpServerRequest, HttpServerResponse>
compressionPredicate

pack-priv final BiPredicate<HttpServerRequest, HttpServerResponse>
configuredCompressionPredicate

pack-priv final ConnectionInfo
connectionInfo

pack-priv static final FullHttpResponse
CONTINUE

pack-priv final ServerCookieDecoder
cookieDecoder

pack-priv final ServerCookieEncoder
cookieEncoder

pack-priv final ServerCookies
cookieHolder

pack-priv volatile Context
currentContext

pack-priv static final AsciiString
EVENT_STREAM

pack-priv final HttpServerFormDecoderProvider
formDecoderProvider

pack-priv final boolean
is100ContinueExpected

pack-priv final boolean
isHttp2

pack-priv static final Logger
log

Hides reactor.netty.http.HttpOperations.log.

pack-priv final BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>>
mapHandle

pack-priv final HttpRequest
nettyRequest

pack-priv final HttpResponse
nettyResponse

pack-priv Function<? super String, Map<String, String>>
paramsResolver

pack-priv String
path

pack-priv final Duration
readTimeout

pack-priv final Duration
requestTimeout

pack-priv Future<?>
requestTimeoutFuture

pack-priv final HttpHeaders
responseHeaders

pack-priv final String
scheme

pack-priv final ZonedDateTime
timestamp

pack-priv Consumer<? super HttpHeaders>
trailerHeadersConsumer

Constructor Summary

AccessConstructor and Description
pack-priv
HttpServerOperations(HttpServerOperations replaced)

pack-priv
HttpServerOperations(Connection c, ConnectionObserver listener, HttpRequest nettyRequest, BiPredicate<HttpServerRequest, HttpServerResponse> compressionPredicate, ConnectionInfo connectionInfo, ServerCookieDecoder decoder, ServerCookieEncoder encoder, HttpServerFormDecoderProvider formDecoderProvider, HttpMessageLogFactory httpMessageLogFactory, boolean isHttp2, BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>> mapHandle, Duration readTimeout, Duration requestTimeout, boolean secured, ZonedDateTime timestamp)

pack-priv
HttpServerOperations(Connection c, ConnectionObserver listener, HttpRequest nettyRequest, BiPredicate<HttpServerRequest, HttpServerResponse> compressionPredicate, ConnectionInfo connectionInfo, ServerCookieDecoder decoder, ServerCookieEncoder encoder, HttpServerFormDecoderProvider formDecoderProvider, HttpMessageLogFactory httpMessageLogFactory, boolean isHttp2, BiFunction<? super Mono<Void>, ? super Connection, ? extends Mono<Void>> mapHandle, Duration readTimeout, Duration requestTimeout, boolean resolvePath, boolean secured, ZonedDateTime timestamp)

Method Summary

Modifier and TypeMethod and Description
public HttpServerResponse
addCookie(Cookie cookie)

Implements reactor.netty.http.server.HttpServerResponse.addCookie.

Adds an outbound cookie.
public HttpServerResponse
addHeader(CharSequence
header name
name, CharSequence
header value
value)

Implements reactor.netty.http.server.HttpServerResponse.addHeader.

Adds an outbound HTTP header, appending the value if the header already exist.
protected void
afterMarkSentHeaders()

Implements abstract reactor.netty.http.HttpOperations.afterMarkSentHeaders.

public Map<CharSequence, List<Cookie>>
allCookies()

Implements reactor.netty.http.server.HttpServerInfos.allCookies.

Returns resolved HTTP cookies.
protected void
beforeMarkSentHeaders()

Implements abstract reactor.netty.http.HttpOperations.beforeMarkSentHeaders.

public HttpServerOperations
chunkedTransfer(boolean
true if Transfer-Encoding: chunked
chunked)

Implements reactor.netty.http.server.HttpServerResponse.chunkedTransfer.

Sets Transfer-Encoding header.
pack-priv static void
cleanHandlerTerminate(Channel ch)

public HttpServerResponse
compression(boolean
should handle compression
compress)

Implements reactor.netty.http.server.HttpServerResponse.compression.

Enables/Disables compression handling (gzip/deflate) for the underlying response.
public SocketAddress
connectionHostAddress()

Implements reactor.netty.http.server.ConnectionInformation.connectionHostAddress.

Returns the address of the host which received the request, possibly null in case of Unix Domain Sockets.
public SocketAddress
connectionRemoteAddress()

Implements reactor.netty.http.server.ConnectionInformation.connectionRemoteAddress.

Returns the address of the client that initiated the request, possibly null in case of Unix Domain Sockets.
public String
connectionScheme()

Implements reactor.netty.http.server.ConnectionInformation.connectionScheme.

Returns the current protocol scheme.
public Map<CharSequence, Set<Cookie>>
cookies()

Implements reactor.netty.http.HttpInfos.cookies.

Returns resolved HTTP cookies.
public Context
currentContext()

Overrides reactor.netty.channel.ChannelOperations.currentContext.

Overrides default reactor.core.CoreSubscriber.currentContext.

Request a Context from dependent components which can include downstream operators during subscribing or a terminal org.reactivestreams.Subscriber.
public String
fullPath()

Implements reactor.netty.http.HttpInfos.fullPath.

Returns the decoded path portion from the uri().
public HttpServerResponse
header(CharSequence
headers key
name, CharSequence
header value
value)

Implements reactor.netty.http.server.HttpServerResponse.header.

Sets an outbound HTTP header, replacing any pre-existing value.
public HttpServerResponse
headers(HttpHeaders
netty headers map
headers)

Implements reactor.netty.http.server.HttpServerResponse.headers.

Sets outbound HTTP headers, replacing any pre-existing value for these headers.
public InetSocketAddress
hostAddress()

Implements reactor.netty.http.server.HttpServerRequest.hostAddress, reactor.netty.http.server.ConnectionInformation.hostAddress.

Returns the address of the host which received the request, possibly null in case of Unix Domain Sockets.
public String
hostName()

Implements reactor.netty.http.server.ConnectionInformation.hostName.

Returns the host name derived from the Host/X-Forwarded-Host/Forwarded header associated with this request.
public int
hostPort()

Implements reactor.netty.http.server.ConnectionInformation.hostPort.

Returns the host port derived from the Host/X-Forwarded-*/Forwarded header associated with this request.
pack-priv final SocketAddress
hostSocketAddress()

protected boolean
isContentAlwaysEmpty()

Implements abstract reactor.netty.http.HttpOperations.isContentAlwaysEmpty.

public boolean
isFormUrlencoded()

Implements reactor.netty.http.server.HttpServerRequest.isFormUrlencoded.

Returns true if the request has Content-Type with value application/x-www-form-urlencoded.
pack-priv final boolean
isHttp2()

public boolean
isKeepAlive()

Implements reactor.netty.http.HttpInfos.isKeepAlive.

Is the request keep alive.
public boolean
isMultipart()

Implements reactor.netty.http.server.HttpServerRequest.isMultipart.

Returns true if the request has Content-Type with value multipart/form-data.
public boolean
isWebsocket()

Overrides reactor.netty.http.HttpOperations.isWebsocket.

Implements reactor.netty.http.HttpInfos.isWebsocket.

Returns true if websocket connection (upgraded).
public HttpServerResponse
keepAlive(boolean keepAlive)

Implements reactor.netty.http.server.HttpServerResponse.keepAlive.

Sets the request keepAlive if true otherwise remove the existing connection keep alive header.
public HttpMethod
method()

Implements reactor.netty.http.HttpInfos.method.

Returns the resolved request method (HTTP 1.1 etc.).
protected HttpMessage
newFullBodyMessage(ByteBuf body)

Implements abstract reactor.netty.http.HttpOperations.newFullBodyMessage.

protected void
onHeadersSent()

Implements abstract reactor.netty.http.HttpOperations.onHeadersSent.

protected void
onInboundClose()

Overrides reactor.netty.channel.ChannelOperations.onInboundClose.

React on inbound close (channel closed prematurely).
protected void
onInboundNext(ChannelHandlerContext
the context
ctx, Object
the read payload
msg)

Overrides reactor.netty.channel.ChannelOperations.onInboundNext.

React on inbound Channel#read.
protected void
onOutboundComplete()

Overrides reactor.netty.channel.ChannelOperations.onOutboundComplete.

React on inbound/outbound completion (last packet).
protected void
onOutboundError(Throwable
the Throwable cause
err)

Overrides reactor.netty.channel.ChannelOperations.onOutboundError.

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

Implements abstract reactor.netty.http.HttpOperations.outboundHttpMessage.

Outbound Netty HttpMessage.
public String
param(CharSequence
parameter name e.g. "param" in URI /test/{param}
key)

Implements reactor.netty.http.server.HttpServerRequest.param.

URI parameter captured via {} e.g. /test/{param}.
public Map<String, String>
params()

Implements reactor.netty.http.server.HttpServerRequest.params.

Returns all URI parameters captured via {} e.g. /test/{param1}/{param2} as key/value map.
public HttpServerRequest
paramsResolver(Function<? super String, Map<String, String>>
a params resolver
paramsResolver)

Implements reactor.netty.http.server.HttpServerRequest.paramsResolver.

Specifies a params resolver.
public String
protocol()

Implements reactor.netty.http.server.HttpServerRequest.protocol.

Returns the inbound protocol and version.
public Flux<HttpData>
receiveForm()

Implements reactor.netty.http.server.HttpServerRequest.receiveForm.

When the request is POST and have Content-Type with value application/x-www-form-urlencoded or multipart/form-data, returns a Flux of HttpData containing received Attribute/FileUpload.
public Flux<HttpData>
receiveForm(Consumer<HttpServerFormDecoderProvider.Builder>
HttpServerFormDecoderProvider.Builder for HTTP form decoder configuration
formDecoderBuilder)

Implements reactor.netty.http.server.HttpServerRequest.receiveForm.

When the request is POST and have Content-Type with value application/x-www-form-urlencoded or multipart/form-data, returns a Flux of HttpData containing received Attribute/FileUpload.
pack-priv final Flux<HttpData>
receiveFormInternal(HttpServerFormDecoderProvider config)

public Flux<?>
receiveObject()

Overrides reactor.netty.channel.ChannelOperations.receiveObject.

Implements reactor.netty.NettyInbound.receiveObject.

a Object inbound Flux.
public InetSocketAddress
remoteAddress()

Implements reactor.netty.http.server.HttpServerRequest.remoteAddress, reactor.netty.http.server.ConnectionInformation.remoteAddress.

Returns the address of the client that initiated the request, possibly null in case of Unix Domain Sockets.
pack-priv final SocketAddress
remoteSocketAddress()

public HttpHeaders
requestHeaders()

Implements reactor.netty.http.server.HttpServerRequest.requestHeaders.

Returns inbound HttpHeaders.
pack-priv static long
requestsCounter(Channel channel)

public HttpHeaders
responseHeaders()

Implements reactor.netty.http.server.HttpServerResponse.responseHeaders.

Returns the outbound HTTP headers, sent back to the clients.
public String
scheme()

Implements reactor.netty.http.server.ConnectionInformation.scheme.

Returns the current protocol scheme.
public Mono<Void>
send()

Implements reactor.netty.http.server.HttpServerResponse.send.

Sends the HTTP headers and empty content thus delimiting a full empty body http response.
pack-priv static void
sendDecodingFailures(ChannelHandlerContext ctx, ConnectionObserver listener, boolean secure, Throwable t, Object msg, HttpMessageLogFactory httpMessageLogFactory, ZonedDateTime timestamp, ConnectionInfo connectionInfo, SocketAddress remoteAddress)

pack-priv static void
sendDecodingFailures(ChannelHandlerContext ctx, ConnectionObserver listener, boolean secure, Throwable t, Object msg, HttpMessageLogFactory httpMessageLogFactory, boolean isHttp2, ZonedDateTime timestamp, ConnectionInfo connectionInfo, SocketAddress remoteAddress)

public NettyOutbound
sendFile(Path
the file Path
file)

Overrides default reactor.netty.NettyOutbound.sendFile.

Sends content from given Path using java.nio.channels.FileChannel#transferTo(long, long, WritableByteChannel) support.
public NettyOutbound
sendHeaders()

Implements reactor.netty.http.server.HttpServerResponse.sendHeaders.

Returns a NettyOutbound successful on committed response.
public Mono<Void>
sendNotFound()

Implements reactor.netty.http.server.HttpServerResponse.sendNotFound.

Sends 404 status HttpResponseStatus#NOT_FOUND.
public Mono<Void>
sendRedirect(String
the location to redirect to
location)

Implements reactor.netty.http.server.HttpServerResponse.sendRedirect.

Sends redirect status HttpResponseStatus#FOUND along with a location header to the remote client.
public Mono<Void>
sendWebsocket(BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>>
the I/O handler for websocket transport
websocketHandler, WebsocketServerSpec
WebsocketServerSpec for websocket configuration
configurer)

Implements reactor.netty.http.server.HttpServerResponse.sendWebsocket.

Upgrades the connection to websocket.
public HttpServerResponse

Returns:

the Content-Type setting SSE for this http connection (e.g. event-stream)
sse()

Implements reactor.netty.http.server.HttpServerResponse.sse.

The Content-Type setting SSE for this http connection (e.g. event-stream).
public HttpResponseStatus
status()

Implements reactor.netty.http.server.HttpServerResponse.status.

Returns the assigned HTTP status.
public HttpServerResponse
status(HttpResponseStatus
an HTTP status to be sent along with the headers
status)

Implements reactor.netty.http.server.HttpServerResponse.status.

Sets an HTTP status to be sent along with the headers.
public ZonedDateTime
timestamp()

Implements reactor.netty.http.server.HttpServerRequest.timestamp.

Returns the time when the request was received.
public HttpServerResponse
trailerHeaders(Consumer<? super HttpHeaders>
netty headers map
trailerHeaders)

Implements reactor.netty.http.server.HttpServerResponse.trailerHeaders.

Callback for setting outbound trailer headers.
public String
uri()

Implements reactor.netty.http.HttpInfos.uri.

Returns the resolved target address.
public HttpVersion
version()

Implements reactor.netty.http.HttpInfos.version.

Returns the resolved request version (HTTP 1.1 etc).
public HttpServerOperations
withConnection(Consumer<? super Connection>
connection callback
withConnection)

Overrides reactor.netty.channel.ChannelOperations.withConnection.

Implements reactor.netty.http.server.HttpServerRequest.withConnection, reactor.netty.http.server.HttpServerResponse.withConnection, reactor.netty.NettyInbound.withConnection, reactor.netty.NettyOutbound.withConnection.

Calls the passed callback with a Connection to operate on the underlying Channel state.
pack-priv final Mono<Void>
withWebsocketSupport(String url, WebsocketServerSpec websocketServerSpec, BiFunction<? super WebsocketInbound, ? super WebsocketOutbound, ? extends Publisher<Void>> websocketHandler)

Inherited from reactor.netty.http.HttpOperations:
addHandlerasDebugLogMessagehasSentBodyhasSentHeadershttpMessageLogFactoryinitShortIdmarkSentBodymarkSentHeaderAndBodymarkSentHeadersrequestIdresolvePathsendsendFilesendObjectthentoString