reactor.ipc.netty.http.client

Interface HttpClientRequest

All Superinterfaces:

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

public interface HttpClientRequest
extends NettyOutbound, HttpInfos

An Http Reactive client write contract for outgoing requests. It inherits several accessor related to HTTP flow : headers, params, URI, method, websocket...

Author:

Stephane Maldini, Simon Baslé

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpClientRequest.Form An HTTP Form builder

Field Summary

Fields inherited from interface reactor.ipc.netty.NettyOutbound

FILE_CHUNKED_STRATEGY_BUFFER

Method Summary

Modifier and Type	Method and Description
HttpClientRequest	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Add an outbound cookie
HttpClientRequest	addHeader(java.lang.CharSequence name, java.lang.CharSequence value) Add an outbound http header, appending the value if the header is already set.
HttpClientRequest	chunkedTransfer(boolean chunked) Set transfer-encoding header
default HttpClientRequest	context(java.util.function.Consumer<NettyContext> contextCallback) Immediately call the passed callback with a NettyContext to operate on the underlying Channel state.
HttpClientRequest	failOnClientError(boolean shouldFail) Toggle the request to fail in case of a client-side error.
HttpClientRequest	failOnServerError(boolean shouldFail) Toggle the request to fail in case of a server-side error.
HttpClientRequest	followRedirect() Enable http status 302 auto-redirect support
boolean	hasSentHeaders() Return true if headers and status have been sent to the client
HttpClientRequest	header(java.lang.CharSequence name, java.lang.CharSequence value) Set an outbound header, replacing any pre-existing value.
HttpClientRequest	headers(io.netty.handler.codec.http.HttpHeaders headers) Set outbound headers from the passed headers.
boolean	isFollowRedirect() Return true if redirected will be followed
HttpClientRequest	keepAlive(boolean keepAlive) set the request keepAlive if true otherwise remove the existing connection keep alive header
default HttpClientRequest	onWriteIdle(long idleTimeout, java.lang.Runnable onWriteIdle) Assign a Runnable to be invoked when writes have become idle for the given timeout.
default HttpClientRequest	options(java.util.function.Consumer<? super NettyPipeline.SendOptions> configurator) Provide a new NettyOutbound scoped configuration for sending.
java.lang.String[]	redirectedFrom() Return the previous redirections or empty array
io.netty.handler.codec.http.HttpHeaders	requestHeaders() Return outbound headers to be sent
default reactor.core.publisher.Mono<java.lang.Void>	send() Send headers and empty content thus delimiting a full empty body http request
reactor.core.publisher.Flux<java.lang.Long>	sendForm(java.util.function.Consumer<HttpClientRequest.Form> formCallback) Prepare to send an HTTP Form including Multipart encoded Form which support chunked file upload.
NettyOutbound	sendHeaders() Send the headers.
WebsocketOutbound	sendWebsocket() Upgrade connection to Websocket.
WebsocketOutbound	sendWebsocket(java.lang.String subprotocols) Upgrade connection to Websocket, negotiating one of the given subprotocol(s).

Methods inherited from interface reactor.ipc.netty.NettyOutbound

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

Methods inherited from interface reactor.ipc.netty.http.HttpInfos

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

Method Detail

addCookie

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

Add an outbound cookie

Returns:

this outbound

addHeader

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

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

Parameters:

name - header name

value - header value

Returns:

this outbound

context

default HttpClientRequest context(java.util.function.Consumer<NettyContext> contextCallback)

Description copied from interface: NettyOutbound

Immediately call the passed callback with a NettyContext to operate on the underlying Channel state. This allows for chaining outbound API.

Specified by:

context in interface NettyOutbound

Parameters:

contextCallback - context callback

Returns:

the NettyContext

chunkedTransfer

HttpClientRequest chunkedTransfer(boolean chunked)

Set transfer-encoding header

Parameters:

chunked - true if transfer-encoding:chunked

Returns:

this outbound

options

default HttpClientRequest 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

followRedirect

HttpClientRequest followRedirect()

Enable http status 302 auto-redirect support

Returns:

this

failOnClientError

HttpClientRequest failOnClientError(boolean shouldFail)

Toggle the request to fail in case of a client-side error.

Parameters:

shouldFail - true if the request should fail in case of client errors.

Returns:

this

failOnServerError

HttpClientRequest failOnServerError(boolean shouldFail)

Toggle the request to fail in case of a server-side error.

Parameters:

shouldFail - true if the request should fail in case of server errors.

Returns:

this

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

HttpClientRequest 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

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

Set outbound headers from the passed headers. It will however ignore HOST header key. Any pre-existing value for the passed headers will be replaced.

Parameters:

headers - a netty headers map

Returns:

this outbound

isFollowRedirect

boolean isFollowRedirect()

Return true if redirected will be followed

Returns:

true if redirected will be followed

keepAlive

HttpClientRequest keepAlive(boolean keepAlive)

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

Returns:

this outbound

onWriteIdle

default HttpClientRequest onWriteIdle(long idleTimeout,
                                      java.lang.Runnable onWriteIdle)

Description copied from interface: NettyOutbound

Assign a Runnable to be invoked when writes have become idle for the given timeout. This replaces any previously set idle callback.

Specified by:

onWriteIdle in interface NettyOutbound

Parameters:

idleTimeout - the idle timeout

onWriteIdle - the idle timeout handler

Returns:

this

redirectedFrom

java.lang.String[] redirectedFrom()

Return the previous redirections or empty array

Returns:

the previous redirections or empty array

requestHeaders

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

Return outbound headers to be sent

Returns:

outbound headers to be sent

send

default reactor.core.publisher.Mono<java.lang.Void> send()

Send headers and empty content thus delimiting a full empty body http request

Returns:

a Mono successful on committed response

See Also:

NettyOutbound.send(Publisher)

sendForm

reactor.core.publisher.Flux<java.lang.Long> sendForm(java.util.function.Consumer<HttpClientRequest.Form> formCallback)

Prepare to send an HTTP Form including Multipart encoded Form which support chunked file upload. It will by default be encoded as Multipart but can be adapted via HttpClientRequest.Form.multipart(boolean).

Parameters:

formCallback - called when form generator is created

Returns:

a Flux of latest in-flight or uploaded bytes,

sendHeaders

NettyOutbound sendHeaders()

Send the headers.

Returns:

a NettyOutbound completing when headers have been sent.

sendWebsocket

WebsocketOutbound sendWebsocket()

Upgrade connection to Websocket.

Returns:

a WebsocketOutbound completing when upgrade is confirmed

sendWebsocket

WebsocketOutbound sendWebsocket(java.lang.String subprotocols)

Upgrade connection to Websocket, negotiating one of the given subprotocol(s).

The negotiated subprotocol cannot be directly accessed on the returned outbound, as the negotiation hasn't yet occurred. However, the response to this request will usually allow access to that information (by upgrading it to a websocket outbound via HttpClientResponse.receiveWebsocket() then calling WebsocketOutbound.selectedSubprotocol()).

Parameters:

subprotocols - the subprotocol(s) to negotiate, comma-separated, or null if not relevant. Can be several protocols, separated by a comma, or null if no subprotocol is required.

Returns:

a WebsocketOutbound completing when upgrade is confirmed