Package reactor.netty.http.client

Interface HttpClient.RequestSender

All Superinterfaces:

HttpClient.ResponseReceiver<HttpClient.RequestSender>, HttpClient.UriConfiguration<HttpClient.RequestSender>

Enclosing class:

HttpClient

public static interface HttpClient.RequestSender
extends HttpClient.ResponseReceiver<HttpClient.RequestSender>

Allow a request body configuration before calling one of the terminal, Publisher based, HttpClient.ResponseReceiver API.

Method Summary

Modifier and Type	Method	Description
HttpClient.ResponseReceiver<?>	send(BiFunction<? super HttpClientRequest,? super NettyOutbound,? extends Publisher<Void>> sender)	Configure a body to send on request using the NettyOutbound sending builder and returning a Publisher to signal end of the request.
HttpClient.ResponseReceiver<?>	send(Publisher<? extends ByteBuf> body)	Configure a body to send on request.
default HttpClient.ResponseReceiver<?>	sendForm(BiConsumer<? super HttpClientRequest,HttpClientForm> formCallback)	Prepare to send an HTTP Form including Multipart encoded Form which support chunked file upload.
HttpClient.ResponseReceiver<?>	sendForm(BiConsumer<? super HttpClientRequest,HttpClientForm> formCallback, @Nullable Consumer<Flux<Long>> progress)	Prepare to send an HTTP Form including Multipart encoded Form which support chunked file upload.

Methods inherited from interface reactor.netty.http.client.HttpClient.ResponseReceiver

response, response, responseConnection, responseContent, responseSingle

Methods inherited from interface reactor.netty.http.client.HttpClient.UriConfiguration

uri, uri, uri

Method Details

send

HttpClient.ResponseReceiver<?> send(Publisher<? extends ByteBuf> body)

Configure a body to send on request.

Note: The body Publisher passed in will be invoked also for redirect requests when followRedirect is enabled. If you need to control what will be sent when followRedirect is enabled then use send(BiFunction).

Note: For redirect requests, sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added globally via HttpClient.followRedirect(boolean, Consumer)/HttpClient.followRedirect(BiPredicate, Consumer) or alternatively for full control per redirect request, consider using HttpClient.RedirectSendHandler with send(BiFunction)

Parameters:

body - a body publisher that will terminate the request on complete

Returns:

a new HttpClient.ResponseReceiver

send

HttpClient.ResponseReceiver<?> send(BiFunction<? super HttpClientRequest,? super NettyOutbound,? extends Publisher<Void>> sender)

Configure a body to send on request using the NettyOutbound sending builder and returning a Publisher to signal end of the request.

Note: The sender BiFunction passed in will be invoked also for redirect requests when followRedirect is enabled. For redirect requests, sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added globally via HttpClient.followRedirect(boolean, Consumer)/HttpClient.followRedirect(BiPredicate, Consumer) or alternatively for full control per redirect request, consider using HttpClient.RedirectSendHandler. HttpClient.RedirectSendHandler can be used to indicate explicitly that this BiFunction has special handling for redirect requests.

Parameters:

sender - a bifunction given the outgoing request and the sending NettyOutbound, returns a publisher that will terminate the request body on complete. Return Mono.empty() in case of a request without body.

Returns:

a new HttpClient.ResponseReceiver

sendForm

default HttpClient.ResponseReceiver<?> sendForm(BiConsumer<? super HttpClientRequest,HttpClientForm> 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 HttpClientForm.multipart(boolean).

Note: The HTTP Form passed in will be invoked also for redirect requests when followRedirect is enabled. If you need to control what will be sent when followRedirect is enabled use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress.

Note: For redirect requests, sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added globally via HttpClient.followRedirect(boolean, Consumer)/HttpClient.followRedirect(BiPredicate, Consumer).

Parameters:

formCallback - called when form generator is created

Returns:

a new HttpClient.ResponseReceiver

sendForm

HttpClient.ResponseReceiver<?> sendForm(BiConsumer<? super HttpClientRequest,HttpClientForm> formCallback,
 @Nullable Consumer<Flux<Long>> progress)

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 HttpClientForm.multipart(boolean).

Note: The HTTP Form passed in will be invoked also for redirect requests when followRedirect is enabled. If you need to control what will be sent when followRedirect is enabled use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress.

Note: For redirect requests, sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added globally via HttpClient.followRedirect(boolean, Consumer)/HttpClient.followRedirect(BiPredicate, Consumer).

Parameters:

formCallback - called when form generator is created

progress - called after form is being sent and passed with a Flux of the latest in-flight or uploaded bytes

Returns:

a new HttpClient.ResponseReceiver