HttpClient (Reactor Netty 0.8.0.M2)

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

public abstract class HttpClient
extends java.lang.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.

Examples:

 
 HttpClient.create()
           .baseUrl("http://example.com")
           .get()
           .response()
           .block();
 
 
 HttpClient.create()
           .post()
           .uri("http://example.com")
           .send(Flux.just(bb1, bb2, bb3))
           .responseSingle((res, content) -> Mono.just(res.status().code()))
           .block();
 
 
 HttpClient.create()
           .baseUri("http://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.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 java.lang.String USER_AGENT

Fields
Modifier and Type	Field and Description
`static java.lang.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
Modifier and Type	Method and Description
`HttpClient`	`addressSupplier(java.util.function.Supplier<? extends java.net.SocketAddress> connectAddressSupplier)` The address to which this client should connect for each subscribe.
`HttpClient`	`baseUrl(java.lang.String baseUrl)` Configure URI to use for this request/response
`HttpClient`	`chunkedTransfer()` Enable transfer-encoding
`HttpClient`	`compress()` Enable gzip compression
`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`	`doAfterRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doAfterRequest)` Setup a callback called when `HttpClientRequest` has been sent
`HttpClient`	`doAfterResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponse)` Setup a callback called after `HttpClientResponse` has been fully received.
`HttpClient`	`doOnRequest(java.util.function.BiConsumer<? super HttpClientRequest,? super Connection> doOnRequest)` Setup a callback called when `HttpClientRequest` is about to be sent.
`HttpClient`	`doOnResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doOnResponse)` Setup a callback called after `HttpClientResponse` headers have been received
`HttpClient`	`followRedirect()` Enable http status 301/302 auto-redirect support
`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.
`static HttpClient`	`newConnection()` Prepare an unpooled `HttpClient`.
`HttpClient`	`noChunkedTransfer()` Disable transfer-encoding
`HttpClient`	`noCompression()` Disable gzip compression
`HttpClient`	`noRedirection()` Disable http status 301/302 auto-redirect support
`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.RequestSender`	`put()` HTTP PUT to connect the `HttpClient`.
`HttpClient.RequestSender`	`request(HttpMethod method)` Use the passed HTTP method to connect the `HttpClient`.
`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(java.lang.String subprotocols)` HTTP Websocket to connect the `HttpClient`.
`HttpClient`	`wiretap()` Apply 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 java.lang.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(java.lang.String baseUrl)
```
    Configure URI to use for this request/response
    
    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
```
public final HttpClient addressSupplier(java.util.function.Supplier<? extends java.net.SocketAddress> connectAddressSupplier)
```
    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
  - compress
```
public final HttpClient compress()
```
    Enable gzip compression
    
    Returns:
    
    a new HttpClient
  - followRedirect
```
public final HttpClient followRedirect()
```
    Enable http status 301/302 auto-redirect support
    
    Returns:
    
    a new HttpClient
  - chunkedTransfer
```
public final HttpClient chunkedTransfer()
```
    Enable transfer-encoding
    
    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
  - 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.
    
    Parameters:
    
    doOnRequest - a consumer observing connected events
    
    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
    
    Parameters:
    
    doAfterRequest - a consumer observing connected events
    
    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
    
    Parameters:
    
    doOnResponse - a consumer observing connected events
    
    Returns:
    
    a new HttpClient
  - doAfterResponse
```
public final HttpClient doAfterResponse(java.util.function.BiConsumer<? super HttpClientResponse,? super Connection> doAfterResponse)
```
    Setup a callback called after HttpClientResponse has been fully received.
    
    Parameters:
    
    doAfterResponse - a consumer observing disconnected events
    
    Returns:
    
    a new HttpClient
  - 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 sending websocket handshake
    
    Returns:
    
    a new HttpClient
  - noCompression
```
public final HttpClient noCompression()
```
    Disable gzip compression
    
    Returns:
    
    a new HttpClient
  - noRedirection
```
public final HttpClient noRedirection()
```
    Disable http status 301/302 auto-redirect support
    
    Returns:
    
    a new HttpClient
  - noChunkedTransfer
```
public final HttpClient noChunkedTransfer()
```
    Disable transfer-encoding
    
    Returns:
    
    a new HttpClient
  - 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
  - post
```
public final HttpClient.RequestSender post()
```
    HTTP POST 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
  - 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
  - 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()
```
    Apply a wire logger configuration using HttpClient category and DEBUG logger level
    
    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(java.lang.String subprotocols)
```
    HTTP Websocket to connect the HttpClient.
    
    Parameters:
    
    subprotocols - a websocket subprotocol comma separated list
    
    Returns:
    
    a HttpClient.WebsocketSender ready to consume for response
  - 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

compress

followRedirect

chunkedTransfer

delete

doOnRequest

doAfterRequest

doOnResponse

doAfterResponse

get

head

headers

noCompression

noRedirection

noChunkedTransfer

observe

options

patch

post

port

put

request

secure

secure

tcpConfiguration

wiretap

websocket

websocket

tcpConfiguration