reactor.ipc.netty.http.client

Class HttpClient

java.lang.Object

reactor.ipc.netty.http.client.HttpClient

All Implemented Interfaces:

Connector<ByteBuf,ByteBuf,HttpClientResponse,HttpClientRequest>, NettyConnector<HttpClientResponse,HttpClientRequest>

public class HttpClient
extends Object
implements NettyConnector<HttpClientResponse,HttpClientRequest>

The base class for a Netty-based Http client.

Author:

Stephane Maldini, Simon Baslé

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_AGENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpClient(HttpClientOptions options)

Method Summary

Modifier and Type	Method and Description
static HttpClient	create()
static HttpClient	create(java.util.function.Consumer<? super HttpClientOptions> options)
static HttpClient	create(int port)
static HttpClient	create(String address)
static HttpClient	create(String address, int port)
Mono<HttpClientResponse>	delete(String url) HTTP DELETE the passed URL.
Mono<HttpClientResponse>	delete(String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) HTTP DELETE the passed URL.
Mono<HttpClientResponse>	get(String url) HTTP GET the passed URL.
Mono<HttpClientResponse>	get(String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) HTTP GET the passed URL.
Mono<HttpClientResponse>	newHandler(java.util.function.BiFunction<? super HttpClientResponse,? super HttpClientRequest,? extends Publisher<Void>> ioHandler)
Mono<HttpClientResponse>	patch(String url) HTTP PATCH the passed URL.
Mono<HttpClientResponse>	patch(String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) HTTP PATCH the passed URL.
Mono<HttpClientResponse>	post(String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) HTTP POST the passed URL.
Mono<HttpClientResponse>	put(String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) HTTP PUT the passed URL.
Mono<HttpClientResponse>	request(HttpMethod method, String url, java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler) Use the passed HTTP method to send to the given URL.
Mono<HttpClientResponse>	ws(String url) WebSocket to the passed URL.
Mono<HttpClientResponse>	ws(String url, java.util.function.Consumer<? super HttpHeaders> headerBuilder) WebSocket to the passed URL.
Mono<HttpClientResponse>	ws(String url, java.util.function.Consumer<? super HttpHeaders> headerBuilder, String subprotocols) WebSocket to the passed URL, negotiating one of the passed subprotocols.
Mono<HttpClientResponse>	ws(String url, String subprotocols) WebSocket to the passed URL, negotiating one of the passed subprotocols.

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

protected HttpClient(HttpClientOptions options)

Method Detail

create

public static HttpClient create()

Returns:

a simple HTTP client

create

public static HttpClient create(java.util.function.Consumer<? super HttpClientOptions> options)

Returns:

a simple HTTP client using provided options

create

public static HttpClient create(String address)

Returns:

a simple HTTP client bound on the provided address and port 80

create

public static HttpClient create(String address,
                                int port)

Returns:

a simple HTTP client bound on the provided address and port

create

public static HttpClient create(int port)

Returns:

a simple HTTP client bound on localhost and the provided port

delete

public final Mono<HttpClientResponse> delete(String url,
                                             java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

HTTP DELETE the passed URL. When connection has been established, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

url - the target remote URL

handler - the Function to invoke on open channel

Returns:

a Mono of the HttpServerResponse ready to consume for response

delete

public final Mono<HttpClientResponse> delete(String url)

HTTP DELETE the passed URL.

Parameters:

url - the target remote URL

Returns:

a Mono of the HttpServerResponse ready to consume for response

get

public final Mono<HttpClientResponse> get(String url,
                                          java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

HTTP GET the passed URL. When connection has been made, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

url - the target remote URL

handler - the Function to invoke on open channel

Returns:

a Mono of the HttpServerResponse ready to consume for response

get

public final Mono<HttpClientResponse> get(String url)

HTTP GET the passed URL.

Parameters:

url - the target remote URL

Returns:

a Mono of the HttpServerResponse ready to consume for response

newHandler

public Mono<HttpClientResponse> newHandler(java.util.function.BiFunction<? super HttpClientResponse,? super HttpClientRequest,? extends Publisher<Void>> ioHandler)

Specified by:

newHandler in interface Connector<ByteBuf,ByteBuf,HttpClientResponse,HttpClientRequest>

patch

public final Mono<HttpClientResponse> patch(String url,
                                            java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

HTTP PATCH the passed URL. When connection has been made, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

url - the target remote URL

handler - the Function to invoke on open channel

Returns:

a Mono of the HttpServerResponse ready to consume for response

patch

public final Mono<HttpClientResponse> patch(String url)

HTTP PATCH the passed URL.

Parameters:

url - the target remote URL

Returns:

a Mono of the HttpServerResponse ready to consume for response

post

public final Mono<HttpClientResponse> post(String url,
                                           java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

HTTP POST the passed URL. When connection has been made, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

url - the target remote URL

handler - the Function to invoke on open channel

Returns:

a Mono of the HttpServerResponse ready to consume for response

put

public final Mono<HttpClientResponse> put(String url,
                                          java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

HTTP PUT the passed URL. When connection has been made, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

url - the target remote URL

handler - the Function to invoke on open channel

Returns:

a Mono of the HttpServerResponse ready to consume for response

request

public Mono<HttpClientResponse> request(HttpMethod method,
                                        String url,
                                        java.util.function.Function<? super HttpClientRequest,? extends Publisher<Void>> handler)

Use the passed HTTP method to send to the given URL. When connection has been made, the passed handler is invoked and can be used to tune the request and write data to it.

Parameters:

method - the HTTP method to send

url - the target remote URL

handler - the Function to invoke on opened TCP connection

Returns:

a Mono of the HttpServerResponse ready to consume for response

ws

public final Mono<HttpClientResponse> ws(String url)

WebSocket to the passed URL.

Parameters:

url - the target remote URL

Returns:

a Mono of the HttpServerResponse ready to consume for response

ws

public final Mono<HttpClientResponse> ws(String url,
                                         java.util.function.Consumer<? super HttpHeaders> headerBuilder)

WebSocket to the passed URL.

Parameters:

url - the target remote URL

headerBuilder - the header Consumer to invoke before sending websocket handshake

Returns:

a Mono of the HttpServerResponse ready to consume for response

ws

public final Mono<HttpClientResponse> ws(String url,
                                         String subprotocols)

WebSocket to the passed URL, negotiating one of the passed subprotocols.

The negotiated subprotocol can be accessed through the HttpClientResponse by switching to websocket (using any of the receiveWebSocket methods) and using WebsocketInbound.selectedSubprotocol().

To send data through the websocket, use HttpClientResponse.receiveWebsocket(BiFunction) and then use the function's WebsocketOutbound.

Parameters:

url - the target remote URL

subprotocols - the subprotocol(s) to negotiate, comma-separated, or null if not relevant.

Returns:

a Mono of the HttpServerResponse ready to consume for response

ws

public final Mono<HttpClientResponse> ws(String url,
                                         java.util.function.Consumer<? super HttpHeaders> headerBuilder,
                                         String subprotocols)

WebSocket to the passed URL, negotiating one of the passed subprotocols.

The negotiated subprotocol can be accessed through the HttpClientResponse by switching to websocket (using any of the receiveWebSocket methods) and using WebsocketInbound.selectedSubprotocol().

To send data through the websocket, use HttpClientResponse.receiveWebsocket(BiFunction) and then use the function's WebsocketOutbound.

Parameters:

url - the target remote URL

headerBuilder - the header Consumer to invoke before sending websocket handshake

subprotocols - the subprotocol(s) to negotiate, comma-separated, or null if not relevant.

Returns:

a Mono of the HttpServerResponse ready to consume for response