HttpClient (Reactor Netty 0.9.20.RELEASE)

java.lang.Object
- reactor.netty.http.client.HttpClient

public abstract class HttpClient
extends Object

An HttpClient allows to build in a safe immutable way an http client that is materialized and connecting when TcpClient.connect() is ultimately called.

Internally, materialization happens in three phases, first tcpConfiguration() is called to retrieve a ready to use TcpClient, then TcpClient.configure() retrieve a usable Bootstrap for the final TcpClient.connect() is called. Transfer-Encoding: chunked will be applied for those HTTP methods for which a request body is expected. Content-Length provided via request headers will disable Transfer-Encoding: chunked.

Examples:

 
 HttpClient.create()
           .baseUrl("https://example.com")
           .get()
           .response()
           .block();
 
 
 HttpClient.create()
           .post()
           .uri("https://example.com")
           .send(Flux.just(bb1, bb2, bb3))
           .responseSingle((res, content) -> Mono.just(res.status().code()))
           .block();
 
 
 HttpClient.create()
           .baseUri("https://example.com")
           .post()
           .send(ByteBufFlux.fromString(flux))
           .responseSingle((res, content) -> Mono.just(res.status().code()))
           .block();

Author:: Stephane Maldini, Violeta Georgieva

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HttpClient.RedirectSendHandler` Marker interface for use with `HttpClient.RequestSender.send(BiFunction)`.
`static interface`	`HttpClient.RequestSender` Allow a request body configuration before calling one of the terminal, `Publisher` based, `HttpClient.ResponseReceiver` API.
`static interface`	`HttpClient.ResponseReceiver<S extends HttpClient.ResponseReceiver<?>>` A response extractor for this configured `HttpClient`.
`static interface`	`HttpClient.UriConfiguration<S extends HttpClient.UriConfiguration<?>>` A URI configuration
`static interface`	`HttpClient.WebsocketReceiver<S extends HttpClient.WebsocketReceiver<?>>` Allow a websocket handling.
`static interface`	`HttpClient.WebsocketSender` Allow a request body configuration before calling one of the terminal, `Publisher` based, `HttpClient.WebsocketReceiver` API.

Field Summary

Fields
Modifier and Type Field and Description

static String USER_AGENT

Fields
Modifier and Type	Field and Description
`static String`	`USER_AGENT`

Constructor Summary

Constructors
Constructor and Description

HttpClient()

Constructors
Constructor and Description
`HttpClient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HttpClient`	`addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectAddressSupplier)` Deprecated. as of 0.9.7. Use `remoteAddress(Supplier)`
`HttpClient`	`baseUrl(String baseUrl)` Configure URI to use for this request/response.
`HttpClient`	`compress(boolean compressionEnabled)` Specifies whether GZip compression/websocket compression extension is enabled.
`HttpClient`	`cookie(Cookie cookie)` Apply cookies configuration.
`HttpClient`	`cookie(String name, java.util.function.Consumer<? super Cookie> cookieBuilder)` Apply cookies configuration.
`HttpClient`	`cookieCodec(ClientCookieEncoder encoder)` Configure the `ClientCookieEncoder`, `ClientCookieDecoder` will be chosen based on the encoder
`HttpClient`	`cookieCodec(ClientCookieEncoder encoder, ClientCookieDecoder decoder)` Configure the `ClientCookieEncoder` and `ClientCookieDecoder`
`HttpClient`	`cookiesWhen(String name, java.util.function.Function<? super Cookie,Mono<? extends Cookie>> cookieBuilder)` Apply cookies configuration emitted by the returned Mono before requesting.
`static HttpClient`	`create()` Prepare a pooled `HttpClient`.
`static HttpClient`	`create(ConnectionProvider connectionProvider)` Prepare an `HttpClient`.
`HttpClient.RequestSender`	`delete()` HTTP DELETE to connect the `HttpClient`.
`HttpClient`	`disableRetry(boolean disableRetry)` Option to disable `retry once` support for the outgoing requests that fail with `AbortedException.isConnectionReset(Throwable)`.
`HttpClient`	`doAfterRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doAfterRequest)` Setup a callback called when `HttpClientRequest` has been sent and `HttpClientState.REQUEST_SENT` has been emitted.
`HttpClient`	`doAfterResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponse)` Deprecated. as of 0.9.5. Consider using `doAfterResponseSuccess(BiConsumer)` or `doOnResponseError(BiConsumer)`
`HttpClient`	`doAfterResponseSuccess(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponseSuccess)` Setup a callback called after `HttpClientResponse` has been fully received and `HttpClientState.RESPONSE_COMPLETED` has been emitted.
`HttpClient`	`doOnError(java.util.function.BiConsumer<? super HttpClientRequest,? super Throwable> doOnRequest, java.util.function.BiConsumer<? super HttpClientResponse,? super Throwable> doOnResponse)` Setup a callback called when `HttpClientRequest` has not been sent and when `HttpClientResponse` has not been fully received.
`HttpClient`	`doOnRedirect(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doOnRedirect)` Setup a callback called after `HttpClientResponse` headers have been received and the request is about to be redirected.
`HttpClient`	`doOnRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doOnRequest)` Setup a callback called when `HttpClientRequest` is about to be sent and `HttpClientState.REQUEST_PREPARED` has been emitted.
`HttpClient`	`doOnRequestError(java.util.function.BiConsumer<? super HttpClientRequest,? super Throwable> doOnRequest)` Setup a callback called when `HttpClientRequest` has not been sent.
`HttpClient`	`doOnResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doOnResponse)` Setup a callback called after `HttpClientResponse` headers have been received and `HttpClientState.RESPONSE_RECEIVED` has been emitted.
`HttpClient`	`doOnResponseError(java.util.function.BiConsumer<? super HttpClientResponse,? super Throwable> doOnResponse)` Setup a callback called when `HttpClientResponse` has not been fully received, `HttpClientState.RESPONSE_INCOMPLETE` has been emitted.
`HttpClient`	`followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate)` Enables auto-redirect support if the passed `Predicate` matches.
`HttpClient`	`followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate, java.util.function.BiConsumer<HttpHeaders,HttpClientRequest> redirectRequestBiConsumer)` Variant of `followRedirect(BiPredicate)` that also accepts `BiConsumer` that provides the headers from the previous request and the current redirect request.
`HttpClient`	`followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate, java.util.function.Consumer<HttpClientRequest> redirectRequestConsumer)` Variant of `followRedirect(BiPredicate)` that also accepts a redirect request processor.
`HttpClient`	`followRedirect(boolean followRedirect)` Specifies whether HTTP status 301\|302\|307\|308 auto-redirect support is enabled.
`HttpClient`	`followRedirect(boolean followRedirect, java.util.function.BiConsumer<HttpHeaders,HttpClientRequest> redirectRequestBiConsumer)` Variant of `followRedirect(boolean)` that also accepts `BiConsumer` that provides the headers from the previous request and the current redirect request.
`HttpClient`	`followRedirect(boolean followRedirect, java.util.function.Consumer<HttpClientRequest> redirectRequestConsumer)` Variant of `followRedirect(boolean)` that also accepts a redirect request processor.
`static HttpClient`	`from(TcpClient tcpClient)` Prepare a pooled `HttpClient`
`HttpClient.ResponseReceiver<?>`	`get()` HTTP GET to connect the `HttpClient`.
`HttpClient.ResponseReceiver<?>`	`head()` HTTP HEAD to connect the `HttpClient`.
`HttpClient`	`headers(java.util.function.Consumer<? super HttpHeaders> headerBuilder)` Apply headers configuration.
`HttpClient`	`headersWhen(java.util.function.Function<? super HttpHeaders,Mono<? extends HttpHeaders>> headerBuilder)` Apply headers configuration emitted by the returned Mono before requesting.
`HttpClient`	`httpResponseDecoder(java.util.function.Function<HttpResponseDecoderSpec,HttpResponseDecoderSpec> responseDecoderOptions)` Configure the `HttpClientCodec`'s response decoding options.
`HttpClient`	`keepAlive(boolean keepAlive)` Enable or Disable Keep-Alive support for the outgoing request.
`HttpClient`	`mapConnect(java.util.function.BiFunction<? super Mono<? extends Connection>,? super Bootstrap,? extends Mono<? extends Connection>> connector)` Intercept the connection lifecycle and allows to delay, transform or inject a context.
`HttpClient`	`metrics(boolean metricsEnabled)` Deprecated. as of 0.9.7. Use `metrics(boolean, Function)`
`HttpClient`	`metrics(boolean metricsEnabled, java.util.function.Function<String,String> uriTagValue)` Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry` under the name `Metrics.HTTP_CLIENT_PREFIX`.
`HttpClient`	`metrics(boolean metricsEnabled, HttpClientMetricsRecorder recorder)` Deprecated. as of 0.9.7. Use `metrics(boolean, Supplier)`
`HttpClient`	`metrics(boolean metricsEnabled, java.util.function.Supplier<? extends HttpClientMetricsRecorder> recorder)` Specifies whether the metrics are enabled on the `HttpClient`.
`HttpClient`	`metrics(boolean metricsEnabled, java.util.function.Supplier<? extends HttpClientMetricsRecorder> recorder, java.util.function.Function<String,String> uriValue)` Specifies whether the metrics are enabled on the `HttpClient`.
`static HttpClient`	`newConnection()` Prepare an unpooled `HttpClient`.
`HttpClient`	`observe(ConnectionObserver observer)` Setup all lifecycle callbacks called on or after `Channel` has been connected and after it has been disconnected.
`HttpClient.ResponseReceiver<?>`	`options()` HTTP OPTIONS to connect the `HttpClient`.
`HttpClient.RequestSender`	`patch()` HTTP PATCH to connect the `HttpClient`.
`HttpClient`	`port(int port)` The port to which this client should connect.
`HttpClient.RequestSender`	`post()` HTTP POST to connect the `HttpClient`.
`HttpClient`	`protocol(HttpProtocol... supportedProtocols)` The HTTP protocol to support.
`HttpClient.RequestSender`	`put()` HTTP PUT to connect the `HttpClient`.
`HttpClient`	`remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier)` The address to which this client should connect for each subscribe.
`HttpClient.RequestSender`	`request(HttpMethod method)` Use the passed HTTP method to connect the `HttpClient`.
`HttpClient`	`responseTimeout(java.time.Duration timeout)` Specifies the response timeout duration in milliseconds.
`HttpClient`	`secure()` Enable default sslContext support.
`HttpClient`	`secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)` Apply an SSL configuration customization via the passed builder.
`protected TcpClient`	`tcpConfiguration()` Get a TcpClient from the parent `HttpClient` chain to use with `TcpClient.connect()`} or separately
`HttpClient`	`tcpConfiguration(java.util.function.Function<? super TcpClient,? extends TcpClient> tcpMapper)` Apply `Bootstrap` configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.
`HttpClient.WebsocketSender`	`websocket()` HTTP Websocket to connect the `HttpClient`.
`HttpClient.WebsocketSender`	`websocket(boolean proxyPing)` Deprecated. as of 0.9.7. Use `websocket(WebsocketClientSpec)`
`HttpClient.WebsocketSender`	`websocket(int maxFramePayloadLength)` Deprecated. as of 0.9.7. Use `websocket(WebsocketClientSpec)`
`HttpClient.WebsocketSender`	`websocket(String subprotocols)` Deprecated. as of 0.9.7. Use `websocket(WebsocketClientSpec)`
`HttpClient.WebsocketSender`	`websocket(String subprotocols, int maxFramePayloadLength)` Deprecated. as of 0.9.7. Use `websocket(WebsocketClientSpec)`
`HttpClient.WebsocketSender`	`websocket(String subprotocols, int maxFramePayloadLength, boolean handlePing)` Deprecated. as of 0.9.7. Use `websocket(WebsocketClientSpec)`
`HttpClient.WebsocketSender`	`websocket(WebsocketClientSpec websocketClientSpec)` HTTP Websocket to connect the `HttpClient`.
`HttpClient`	`wiretap(boolean enable)` Apply or remove a wire logger configuration using `HttpClient` category and `DEBUG` logger level

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER_AGENT
```
public static final String USER_AGENT
```
- Constructor Detail
  - HttpClient
```
public HttpClient()
```
- Method Detail
  - create
```
public static HttpClient create()
```
    Prepare a pooled HttpClient. HttpClient.UriConfiguration.uri(String) or baseUrl(String) should be invoked before a verb request(HttpMethod) is selected.
    
    Returns:
    
    a HttpClient
  - create
```
public static HttpClient create(ConnectionProvider connectionProvider)
```
    Prepare an HttpClient. HttpClient.UriConfiguration.uri(String) or baseUrl(String) should be invoked before a verb request(HttpMethod) is selected.
    
    Returns:
    
    a HttpClient
  - newConnection
```
public static HttpClient newConnection()
```
    Prepare an unpooled HttpClient. HttpClient.UriConfiguration.uri(String) or baseUrl(String) should be invoked after a verb request(HttpMethod) is selected.
    
    Returns:
    
    a HttpClient
  - from
```
public static HttpClient from(TcpClient tcpClient)
```
    Prepare a pooled HttpClient
    
    Returns:
    
    a HttpClient
  - baseUrl
```
public final HttpClient baseUrl(String baseUrl)
```
    Configure URI to use for this request/response.
    Note: Configured baseUrl only applies when used with HttpClient.UriConfiguration.uri(String) or HttpClient.UriConfiguration.uri(Mono).
    
    Parameters:
    
    baseUrl - a default base url that can be fully sufficient for request or can be used to prepend future HttpClient.UriConfiguration.uri(java.lang.String) calls.
    
    Returns:
    
    the appropriate sending or receiving contract
  - addressSupplier
```
@Deprecated
public final HttpClient addressSupplier(java.util.function.Supplier<? extends SocketAddress> connectAddressSupplier)
```
    Deprecated. as of 0.9.7. Use remoteAddress(Supplier)
    
    The address to which this client should connect for each subscribe.
    
    Parameters:
    
    connectAddressSupplier - A supplier of the address to connect to.
    
    Returns:
    
    a new HttpClient
  - remoteAddress
```
public final HttpClient remoteAddress(java.util.function.Supplier<? extends SocketAddress> remoteAddressSupplier)
```
    The address to which this client should connect for each subscribe.
    
    Parameters:
    
    remoteAddressSupplier - A supplier of the address to connect to.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.7
  - compress
```
public final HttpClient compress(boolean compressionEnabled)
```
    Specifies whether GZip compression/websocket compression extension is enabled.
    Note: Using this method for enabling websocket compression is strongly discouraged. As of 0.9.7, use WebsocketClientSpec.builder() for providing websocket compression configuration.
    In 0.9.x enabling compression for HTTP, implicitly enables the compression also for Websocket. In 1.0.x this behaviour will be changed and this method will enable the compression only for HTTP. Using WebsocketClientSpec.builder(), one will be able explicitly to enable the compression for Websocket.
    
    Parameters:
    
    compressionEnabled - if true GZip compression/websocket compression extension is enabled otherwise disabled (default: false)
    
    Returns:
    
    a new HttpClient
  - mapConnect
```
public final HttpClient mapConnect(java.util.function.BiFunction<? super Mono<? extends Connection>,? super Bootstrap,? extends Mono<? extends Connection>> connector)
```
    Intercept the connection lifecycle and allows to delay, transform or inject a context.
    
    Parameters:
    
    connector - A bi function mapping the default connection and configured bootstrap to a target connection.
    
    Returns:
    
    a new HttpClient
  - cookie
```
public final HttpClient cookie(Cookie cookie)
```
    Apply cookies configuration.
    
    Parameters:
    
    cookie - a cookie to append to the request(s)
    
    Returns:
    
    a new HttpClient
  - cookie
```
public final HttpClient cookie(String name,
                               java.util.function.Consumer<? super Cookie> cookieBuilder)
```
    Apply cookies configuration.
    
    Parameters:
    
    cookieBuilder - the header Consumer to invoke before requesting
    
    Returns:
    
    a new HttpClient
  - cookiesWhen
```
public final HttpClient cookiesWhen(String name,
                                    java.util.function.Function<? super Cookie,Mono<? extends Cookie>> cookieBuilder)
```
    Apply cookies configuration emitted by the returned Mono before requesting.
    
    Parameters:
    
    cookieBuilder - the cookies Function to invoke before sending
    
    Returns:
    
    a new HttpClient
  - cookieCodec
```
public final HttpClient cookieCodec(ClientCookieEncoder encoder)
```
    Configure the ClientCookieEncoder, ClientCookieDecoder will be chosen based on the encoder
    
    Parameters:
    
    encoder - the preferred ClientCookieEncoder
    
    Returns:
    
    a new HttpClient
  - cookieCodec
```
public final HttpClient cookieCodec(ClientCookieEncoder encoder,
                                    ClientCookieDecoder decoder)
```
    Configure the ClientCookieEncoder and ClientCookieDecoder
    
    Parameters:
    
    encoder - the preferred ClientCookieEncoder
    
    decoder - the preferred ClientCookieDecoder
    
    Returns:
    
    a new HttpClient
  - delete
```
public final HttpClient.RequestSender delete()
```
    HTTP DELETE to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to prepare the content for response
  - doOnError
```
public final HttpClient doOnError(java.util.function.BiConsumer<? super HttpClientRequest,? super Throwable> doOnRequest,
                                  java.util.function.BiConsumer<? super HttpClientResponse,? super Throwable> doOnResponse)
```
    Setup a callback called when HttpClientRequest has not been sent and when HttpClientResponse has not been fully received.
    Note that some mutation of HttpClientRequest performed late in lifecycle doOnRequest(BiConsumer) or HttpClient.RequestSender.send(BiFunction) might not be visible if the error results from a connection failure.
    
    Parameters:
    
    doOnRequest - a consumer observing request failures
    
    doOnResponse - a consumer observing response failures
    
    Returns:
    
    a new HttpClient
  - doOnRequest
```
public final HttpClient doOnRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doOnRequest)
```
    Setup a callback called when HttpClientRequest is about to be sent and HttpClientState.REQUEST_PREPARED has been emitted.
    
    Parameters:
    
    doOnRequest - a callback called when HttpClientRequest is about to be sent
    
    Returns:
    
    a new HttpClient
  - doOnRequestError
```
public final HttpClient doOnRequestError(java.util.function.BiConsumer<? super HttpClientRequest,? super Throwable> doOnRequest)
```
    Setup a callback called when HttpClientRequest has not been sent. Note that some mutation of HttpClientRequest performed late in lifecycle doOnRequest(BiConsumer) or HttpClient.RequestSender.send(BiFunction) might not be visible if the error results from a connection failure.
    
    Parameters:
    
    doOnRequest - a consumer observing request failures
    
    Returns:
    
    a new HttpClient
  - doAfterRequest
```
public final HttpClient doAfterRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doAfterRequest)
```
    Setup a callback called when HttpClientRequest has been sent and HttpClientState.REQUEST_SENT has been emitted.
    
    Parameters:
    
    doAfterRequest - a callback called when HttpClientRequest has been sent
    
    Returns:
    
    a new HttpClient
  - doOnResponse
```
public final HttpClient doOnResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doOnResponse)
```
    Setup a callback called after HttpClientResponse headers have been received and HttpClientState.RESPONSE_RECEIVED has been emitted.
    
    Parameters:
    
    doOnResponse - a callback called after HttpClientResponse headers have been received
    
    Returns:
    
    a new HttpClient
  - doOnRedirect
```
public final HttpClient doOnRedirect(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doOnRedirect)
```
    Setup a callback called after HttpClientResponse headers have been received and the request is about to be redirected.
    Note: This callback applies only if auto-redirect is enabled, e.g. via followRedirect(boolean).
    
    Parameters:
    
    doOnRedirect - a callback called after HttpClientResponse headers have been received and the request is about to be redirected
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.6
  - doOnResponseError
```
public final HttpClient doOnResponseError(java.util.function.BiConsumer<? super HttpClientResponse,? super Throwable> doOnResponse)
```
    Setup a callback called when HttpClientResponse has not been fully received, HttpClientState.RESPONSE_INCOMPLETE has been emitted.
    
    Parameters:
    
    doOnResponse - a consumer observing response failures
    
    Returns:
    
    a new HttpClient
  - doAfterResponse
```
@Deprecated
public final HttpClient doAfterResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponse)
```
    Deprecated. as of 0.9.5. Consider using doAfterResponseSuccess(BiConsumer) or doOnResponseError(BiConsumer)
    
    Setup a callback called after HttpClientState.RESPONSE_RECEIVED has been emitted and the connection is returned to the pool or closed. The callback is invoked in both cases when the response is successful/there are errors.
    
    Parameters:
    
    doAfterResponse - a callback called after HttpClientState.RESPONSE_RECEIVED has been emitted and the connection is returned to the pool or closed. The callback is invoked in both cases when the response is successful/there are errors.
    
    Returns:
    
    a new HttpClient
  - doAfterResponseSuccess
```
public final HttpClient doAfterResponseSuccess(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponseSuccess)
```
    Setup a callback called after HttpClientResponse has been fully received and HttpClientState.RESPONSE_COMPLETED has been emitted.
    
    Parameters:
    
    doAfterResponseSuccess - a callback called after HttpClientResponse has been fully received and HttpClientState.RESPONSE_COMPLETED has been emitted.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.5
  - get
```
public final HttpClient.ResponseReceiver<?> get()
```
    HTTP GET to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to consume for response
  - head
```
public final HttpClient.ResponseReceiver<?> head()
```
    HTTP HEAD to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to consume for response
  - headers
```
public final HttpClient headers(java.util.function.Consumer<? super HttpHeaders> headerBuilder)
```
    Apply headers configuration.
    
    Parameters:
    
    headerBuilder - the header Consumer to invoke before requesting
    
    Returns:
    
    a new HttpClient
  - headersWhen
```
public final HttpClient headersWhen(java.util.function.Function<? super HttpHeaders,Mono<? extends HttpHeaders>> headerBuilder)
```
    Apply headers configuration emitted by the returned Mono before requesting.
    
    Parameters:
    
    headerBuilder - the header Function to invoke before sending
    
    Returns:
    
    a new HttpClient
  - keepAlive
```
public final HttpClient keepAlive(boolean keepAlive)
```
    Enable or Disable Keep-Alive support for the outgoing request.
    
    Parameters:
    
    keepAlive - true if keepAlive should be enabled (default: true)
    
    Returns:
    
    a new HttpClient
  - disableRetry
```
public final HttpClient disableRetry(boolean disableRetry)
```
    Option to disable retry once support for the outgoing requests that fail with AbortedException.isConnectionReset(Throwable).
    By default this is set to false in which case retry once is enabled.
    
    Parameters:
    
    disableRetry - true to disable retry once, false to enable it
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.6
  - followRedirect
```
public final HttpClient followRedirect(boolean followRedirect)
```
    Specifies whether HTTP status 301|302|307|308 auto-redirect support is enabled.
    Note: The sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added via followRedirect(boolean, Consumer).
    
    Parameters:
    
    followRedirect - if true HTTP status 301|302|307|308 auto-redirect support is enabled, otherwise disabled (default: false).
    
    Returns:
    
    a new HttpClient
  - followRedirect
```
public final HttpClient followRedirect(boolean followRedirect,
                                       @Nullable
                                       java.util.function.BiConsumer<HttpHeaders,HttpClientRequest> redirectRequestBiConsumer)
```
    Variant of followRedirect(boolean) that also accepts BiConsumer that provides the headers from the previous request and the current redirect request.
    Note: The sensitive headers:
    - Expect
    - Cookie
    - Authorization
    - Proxy-Authorization
    are removed from the initialized request when redirecting to a different domain, they can be re-added using the BiConsumer.
    Parameters:
    
    followRedirect - if true HTTP status 301|302|307|308 auto-redirect support is enabled, otherwise disabled (default: false).
    
    redirectRequestBiConsumer - BiConsumer, invoked on redirects, after the redirect request has been initialized, in order to apply further changes such as add/remove headers and cookies; use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress. The BiConsumer provides the headers from the previous request and the current redirect request.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.12
  - followRedirect
```
public final HttpClient followRedirect(boolean followRedirect,
                                       @Nullable
                                       java.util.function.Consumer<HttpClientRequest> redirectRequestConsumer)
```
    Variant of followRedirect(boolean) that also accepts a redirect request processor.
    Note: The sensitive headers:
    - Expect
    - Cookie
    - Authorization
    - Proxy-Authorization
    are removed from the initialized request when redirecting to a different domain, they can be re-added using redirectRequestConsumer.
    Parameters:
    
    followRedirect - if true HTTP status 301|302|307|308 auto-redirect support is enabled, otherwise disabled (default: false).
    
    redirectRequestConsumer - redirect request consumer, invoked on redirects, after the redirect request has been initialized, in order to apply further changes such as add/remove headers and cookies; use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.5
  - followRedirect
```
public final HttpClient followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate)
```
    Enables auto-redirect support if the passed Predicate matches.
    Note: The passed HttpClientRequest and HttpClientResponse should be considered read-only and the implement SHOULD NOT consume or write the request/response in this predicate.
    Note: The sensitive headers followRedirect are removed from the initialized request when redirecting to a different domain, they can be re-added via followRedirect(BiPredicate, Consumer).
    
    Parameters:
    
    predicate - that returns true to enable auto-redirect support.
    
    Returns:
    
    a new HttpClient
  - followRedirect
```
public final HttpClient followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate,
                                       @Nullable
                                       java.util.function.BiConsumer<HttpHeaders,HttpClientRequest> redirectRequestBiConsumer)
```
    Variant of followRedirect(BiPredicate) that also accepts BiConsumer that provides the headers from the previous request and the current redirect request.
    Note: The sensitive headers:
    - Expect
    - Cookie
    - Authorization
    - Proxy-Authorization
    are removed from the initialized request when redirecting to a different domain, they can be re-added using the BiConsumer.
    Parameters:
    
    predicate - that returns true to enable auto-redirect support.
    
    redirectRequestBiConsumer - BiConsumer, invoked on redirects, after the redirect request has been initialized, in order to apply further changes such as add/remove headers and cookies; use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress. The BiConsumer provides the headers from the previous request and the current redirect request.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.12
  - followRedirect
```
public final HttpClient followRedirect(java.util.function.BiPredicate<HttpClientRequest,HttpClientResponse> predicate,
                                       @Nullable
                                       java.util.function.Consumer<HttpClientRequest> redirectRequestConsumer)
```
    Variant of followRedirect(BiPredicate) that also accepts a redirect request processor.
    Note: The sensitive headers:
    - Expect
    - Cookie
    - Authorization
    - Proxy-Authorization
    are removed from the initialized request when redirecting to a different domain, they can be re-added using redirectRequestConsumer.
    Parameters:
    
    predicate - that returns true to enable auto-redirect support.
    
    redirectRequestConsumer - redirect request consumer, invoked on redirects, after the redirect request has been initialized, in order to apply further changes such as add/remove headers and cookies; use HttpClientInfos.redirectedFrom() to check the original and any number of subsequent redirect(s), including the one that is in progress.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.5
  - observe
```
public final HttpClient observe(ConnectionObserver observer)
```
    Setup all lifecycle callbacks called on or after Channel has been connected and after it has been disconnected.
    
    Parameters:
    
    observer - a consumer observing state changes
    
    Returns:
    
    a new HttpClient
  - options
```
public final HttpClient.ResponseReceiver<?> options()
```
    HTTP OPTIONS to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to consume for response
  - patch
```
public final HttpClient.RequestSender patch()
```
    HTTP PATCH to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to finalize request and consume for response
  - port
```
public final HttpClient port(int port)
```
    The port to which this client should connect.
    
    Parameters:
    
    port - The port to connect to.
    
    Returns:
    
    a new HttpClient
  - post
```
public final HttpClient.RequestSender post()
```
    HTTP POST to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to finalize request and consume for response
  - protocol
```
public final HttpClient protocol(HttpProtocol... supportedProtocols)
```
    The HTTP protocol to support. Default is HttpProtocol.HTTP11.
    
    Parameters:
    
    supportedProtocols - The various HttpProtocol this server will support
    
    Returns:
    
    a new HttpClient
  - put
```
public final HttpClient.RequestSender put()
```
    HTTP PUT to connect the HttpClient.
    
    Returns:
    
    a HttpClient.RequestSender ready to finalize request and consume for response
  - request
```
public HttpClient.RequestSender request(HttpMethod method)
```
    Use the passed HTTP method to connect the HttpClient.
    
    Parameters:
    
    method - the HTTP method to send
    
    Returns:
    
    a HttpClient.RequestSender ready to finalize request and consume for response
  - responseTimeout
```
public final HttpClient responseTimeout(java.time.Duration timeout)
```
    Specifies the response timeout duration in milliseconds. This is time that takes to receive a response after sending a request. If the timeout is null, any previous setting will be removed and no response timeout will be applied. If the timeout is less than 1ms, then 1ms will be the response timeout. The response timeout setting on HttpClientRequest level overrides any response timeout setting on HttpClient level.
    
    Parameters:
    
    timeout - the response timeout duration (resolution: ms)
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.11
  - secure
```
public final HttpClient secure()
```
    Enable default sslContext support. The default SslContext will be assigned to with a default value of 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set.
    
    Returns:
    
    a new HttpClient
  - secure
```
public final HttpClient secure(java.util.function.Consumer<? super SslProvider.SslContextSpec> sslProviderBuilder)
```
    Apply an SSL configuration customization via the passed builder. The builder will produce the SslContext to be passed to with a default value of 10 seconds handshake timeout unless the environment property reactor.netty.tcp.sslHandshakeTimeout is set.
    
    Parameters:
    
    sslProviderBuilder - builder callback for further customization of SslContext.
    
    Returns:
    
    a new HttpClient
  - tcpConfiguration
```
public final HttpClient tcpConfiguration(java.util.function.Function<? super TcpClient,? extends TcpClient> tcpMapper)
```
    Apply Bootstrap configuration given mapper taking currently configured one and returning a new one to be ultimately used for socket binding.
    Configuration will apply during tcpConfiguration() phase.
    Always prefer secure() to tcpConfiguration() and TcpClient.secure(). While configuration with the later is possible, secure() will inject extra information for HTTPS support.
    
    Parameters:
    
    tcpMapper - A tcpClient mapping function to update tcp configuration and return an enriched tcp client to use.
    
    Returns:
    
    a new HttpClient
  - wiretap
```
public final HttpClient wiretap(boolean enable)
```
    Apply or remove a wire logger configuration using HttpClient category and DEBUG logger level
    
    Parameters:
    
    enable - Specifies whether the wire logger configuration will be added to the pipeline
    
    Returns:
    
    a new HttpClient
  - metrics
```
@Deprecated
public final HttpClient metrics(boolean metricsEnabled)
```
    Deprecated. as of 0.9.7. Use metrics(boolean, Function)
    Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.HTTP_CLIENT_PREFIX.
    Note: It is strongly recommended applications to configure an upper limit for the number of the URI tags. For example:
```
 Metrics.globalRegistry
        .config()
        .meterFilter(MeterFilter.maximumAllowableTags(HTTP_CLIENT_PREFIX, URI, 100, MeterFilter.deny()));
 
```
    By default metrics are not enabled.
    Parameters:
    
    metricsEnabled - true enables metrics collection; false disables it
    
    Returns:
    
    a new HttpClient
  - metrics
```
public final HttpClient metrics(boolean metricsEnabled,
                                @Nullable
                                java.util.function.Function<String,String> uriTagValue)
```
    Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.HTTP_CLIENT_PREFIX.
    uriTagValue function receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag. For example instead of using the actual uri "/users/1" as uri tag value, templated uri "/users/{id}" can be used.
    Note: It is strongly recommended applications to configure an upper limit for the number of the URI tags. For example:
```
 Metrics.globalRegistry
        .config()
        .meterFilter(MeterFilter.maximumAllowableTags(HTTP_CLIENT_PREFIX, URI, 100, MeterFilter.deny()));
 
```
    By default metrics are not enabled.
    Parameters:
    
    metricsEnabled - true enables metrics collection; false disables it
    
    uriTagValue - a function that receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.7
  - metrics
```
@Deprecated
public final HttpClient metrics(boolean metricsEnabled,
                                            HttpClientMetricsRecorder recorder)
```
    Deprecated. as of 0.9.7. Use metrics(boolean, Supplier)
    
    Specifies whether the metrics are enabled on the HttpClient. All generated metrics are provided to the specified recorder.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the server.
    
    recorder - the HttpClientMetricsRecorder
    
    Returns:
    
    a new HttpClient
  - metrics
```
public final HttpClient metrics(boolean metricsEnabled,
                                java.util.function.Supplier<? extends HttpClientMetricsRecorder> recorder)
```
    Specifies whether the metrics are enabled on the HttpClient. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the server.
    
    recorder - a supplier for the HttpClientMetricsRecorder
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.7
  - metrics
```
public final HttpClient metrics(boolean metricsEnabled,
                                java.util.function.Supplier<? extends HttpClientMetricsRecorder> recorder,
                                java.util.function.Function<String,String> uriValue)
```
    Specifies whether the metrics are enabled on the HttpClient. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled.
    uriValue function receives the actual uri and returns the uri value that will be used when the metrics are propagated to the recorder. For example instead of using the actual uri "/users/1" as uri value, templated uri "/users/{id}" can be used.
    
    Parameters:
    
    metricsEnabled - if true enables the metrics on the server.
    
    recorder - a supplier for the HttpClientMetricsRecorder
    
    uriValue - a function that receives the actual uri and returns the uri value that will be used when the metrics are propagated to the recorder.
    
    Returns:
    
    a new HttpClient
    
    Since:
    
    0.9.12
  - httpResponseDecoder
```
public final HttpClient httpResponseDecoder(java.util.function.Function<HttpResponseDecoderSpec,HttpResponseDecoderSpec> responseDecoderOptions)
```
    Configure the HttpClientCodec's response decoding options.
    
    Parameters:
    
    responseDecoderOptions - a function to mutate the provided Http response decoder options
    
    Returns:
    
    a new HttpClient
  - websocket
```
public final HttpClient.WebsocketSender websocket()
```
    HTTP Websocket to connect the HttpClient.
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
  - websocket
```
public final HttpClient.WebsocketSender websocket(WebsocketClientSpec websocketClientSpec)
```
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    websocketClientSpec - WebsocketClientSpec for websocket configuration
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
    
    Since:
    
    0.9.7
  - websocket
```
@Deprecated
public final HttpClient.WebsocketSender websocket(String subprotocols)
```
    Deprecated. as of 0.9.7. Use websocket(WebsocketClientSpec)
    
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    subprotocols - a websocket subprotocol comma separated list
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
  - websocket
```
@Deprecated
public final HttpClient.WebsocketSender websocket(int maxFramePayloadLength)
```
    Deprecated. as of 0.9.7. Use websocket(WebsocketClientSpec)
    
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    maxFramePayloadLength - maximum allowable frame payload length
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
  - websocket
```
@Deprecated
public final HttpClient.WebsocketSender websocket(boolean proxyPing)
```
    Deprecated. as of 0.9.7. Use websocket(WebsocketClientSpec)
    
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    proxyPing - whether to proxy websocket ping frames or respond to them
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
    
    Since:
    
    0.9.3
  - websocket
```
@Deprecated
public final HttpClient.WebsocketSender websocket(String subprotocols,
                                                              int maxFramePayloadLength)
```
    Deprecated. as of 0.9.7. Use websocket(WebsocketClientSpec)
    
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    subprotocols - a websocket subprotocol comma separated list
    
    maxFramePayloadLength - maximum allowable frame payload length
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
  - websocket
```
@Deprecated
public final HttpClient.WebsocketSender websocket(String subprotocols,
                                                              int maxFramePayloadLength,
                                                              boolean handlePing)
```
    Deprecated. as of 0.9.7. Use websocket(WebsocketClientSpec)
    
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    subprotocols - a websocket subprotocol comma separated list
    
    maxFramePayloadLength - maximum allowable frame payload length
    
    handlePing - whether to proxy websocket ping frames or respond to them
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
    
    Since:
    
    0.9.3
  - tcpConfiguration
```
protected TcpClient tcpConfiguration()
```
    Get a TcpClient from the parent HttpClient chain to use with TcpClient.connect()} or separately
    
    Returns:
    
    a configured TcpClient

Class HttpClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_AGENT

Constructor Detail

HttpClient

Method Detail

create

create

newConnection

from

baseUrl

addressSupplier

remoteAddress

compress

mapConnect

cookie

cookie

cookiesWhen

cookieCodec

cookieCodec

delete

doOnError

doOnRequest

doOnRequestError

doAfterRequest

doOnResponse

doOnRedirect

doOnResponseError

doAfterResponse

doAfterResponseSuccess

get

head

headers

headersWhen

keepAlive

disableRetry

followRedirect

followRedirect

followRedirect

followRedirect

followRedirect

followRedirect

observe

options

patch

port

post

protocol

put

request

responseTimeout

secure

secure

tcpConfiguration

wiretap

metrics

metrics

metrics

metrics

metrics

httpResponseDecoder

websocket

websocket

websocket

websocket

websocket

websocket

websocket

tcpConfiguration