io.micronaut.http.client.netty

Class DefaultHttpClient

java.lang.Object

io.micronaut.http.client.netty.DefaultHttpClient

All Implemented Interfaces:

LifeCycle<HttpClient>, HttpClient, ProxyHttpClient, RxHttpClient, RxProxyHttpClient, RxStreamingHttpClient, RxSseClient, SseClient, StreamingHttpClient, ChannelPipelineCustomizer, RxWebSocketClient, WebSocketClient, java.io.Closeable, java.lang.AutoCloseable

@Internal
public class DefaultHttpClient
extends java.lang.Object
implements RxWebSocketClient, RxHttpClient, RxStreamingHttpClient, RxSseClient, RxProxyHttpClient, ChannelPipelineCustomizer, java.io.Closeable, java.lang.AutoCloseable

Default implementation of the HttpClient interface based on Netty.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultHttpClient.HttpClientInitializer Initializes the HTTP client channel.
protected class	DefaultHttpClient.NettyRequestWriter A Netty request writer.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.bootstrap.Bootstrap	bootstrap
protected ByteBufferFactory<io.netty.buffer.ByteBufAllocator,io.netty.buffer.ByteBuf>	byteBufferFactory
protected io.netty.channel.EventLoopGroup	group
protected MediaTypeCodecRegistry	mediaTypeCodecRegistry

Fields inherited from interface io.micronaut.websocket.WebSocketClient

SCHEME_WS, SCHEME_WSS

Fields inherited from interface io.micronaut.http.client.HttpClient

DEFAULT_ERROR_TYPE

Fields inherited from interface io.micronaut.http.netty.channel.ChannelPipelineCustomizer

HANDLER_ACCESS_LOGGER, HANDLER_CONNECT_TTL, HANDLER_FLOW_CONTROL, HANDLER_HTTP_AGGREGATOR, HANDLER_HTTP_CHUNK, HANDLER_HTTP_CLIENT_CODEC, HANDLER_HTTP_CLIENT_INIT, HANDLER_HTTP_COMPRESSOR, HANDLER_HTTP_DECODER, HANDLER_HTTP_DECOMPRESSOR, HANDLER_HTTP_KEEP_ALIVE, HANDLER_HTTP_PROXY, HANDLER_HTTP_SERVER_CODEC, HANDLER_HTTP_STREAM, HANDLER_HTTP2_CONNECTION, HANDLER_HTTP2_PROTOCOL_NEGOTIATOR, HANDLER_HTTP2_SETTINGS, HANDLER_HTTP2_UPGRADE_REQUEST, HANDLER_IDLE_STATE, HANDLER_MICRONAUT_FULL_HTTP_RESPONSE, HANDLER_MICRONAUT_HTTP_RESPONSE_FULL, HANDLER_MICRONAUT_HTTP_RESPONSE_STREAM, HANDLER_MICRONAUT_INBOUND, HANDLER_MICRONAUT_SSE_CONTENT, HANDLER_MICRONAUT_SSE_EVENT_STREAM, HANDLER_MICRONAUT_WEBSOCKET_CLIENT, HANDLER_READ_TIMEOUT, HANDLER_SOCKS_5_PROXY, HANDLER_SSL, HANDLER_WEBSOCKET_UPGRADE

Constructor Summary

Constructors

Constructor and Description
DefaultHttpClient()
DefaultHttpClient(LoadBalancer loadBalancer, HttpClientConfiguration configuration)
DefaultHttpClient(LoadBalancer loadBalancer, HttpClientConfiguration configuration, java.lang.String contextPath, java.util.concurrent.ThreadFactory threadFactory, NettyClientSslBuilder nettyClientSslBuilder, MediaTypeCodecRegistry codecRegistry, AnnotationMetadataResolver annotationMetadataResolver, HttpClientFilter... filters) Construct a client for the given arguments.
DefaultHttpClient(LoadBalancer loadBalancer, HttpVersion httpVersion, HttpClientConfiguration configuration, java.lang.String contextPath, HttpClientFilterResolver<ClientFilterResolutionContext> filterResolver, java.util.List<HttpFilterResolver.FilterEntry<HttpClientFilter>> clientFilterEntries, java.util.concurrent.ThreadFactory threadFactory, NettyClientSslBuilder nettyClientSslBuilder, MediaTypeCodecRegistry codecRegistry, WebSocketBeanRegistry webSocketBeanRegistry, RequestBinderRegistry requestBinderRegistry, io.netty.channel.EventLoopGroup eventLoopGroup, java.lang.Class<? extends io.netty.channel.socket.SocketChannel> socketChannelClass) Construct a client for the given arguments.
DefaultHttpClient(java.net.URL url)
DefaultHttpClient(java.net.URL url, HttpClientConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected <I,O> org.reactivestreams.Publisher<HttpResponse<O>>	applyFilterToResponsePublisher(HttpRequest<?> parentRequest, HttpRequest<I> request, java.net.URI requestURI, java.util.concurrent.atomic.AtomicReference<HttpRequest> requestWrapper, org.reactivestreams.Publisher<HttpResponse<O>> responsePublisher)
protected <I> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<ByteBuffer<?>>>	buildDataStreamPublisher(HttpRequest<I> request)
protected <I,O,E> io.reactivex.functions.Function<java.net.URI,org.reactivestreams.Publisher<? extends HttpResponse<O>>>	buildExchangePublisher(HttpRequest<?> parentRequest, HttpRequest<I> request, Argument<O> bodyType, Argument<E> errorType)
protected <I> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>>>	buildExchangeStreamPublisher(HttpRequest<I> request)
protected <I,O> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<O>>	buildJsonStreamPublisher(HttpRequest<?> parentRequest, HttpRequest<I> request, Argument<O> type)
protected DefaultHttpClient.NettyRequestWriter	buildNettyRequest(MutableHttpRequest request, java.net.URI requestURI, MediaType requestContentType, boolean permitsBody, io.reactivex.functions.Consumer<? super java.lang.Throwable> onError, boolean closeChannelAfterWrite)
protected io.netty.handler.ssl.SslContext	buildSslContext(java.net.URI uriObject) Builds an SslContext for the given URI if necessary.
protected <I> io.reactivex.Flowable<HttpResponse<java.lang.Object>>	buildStreamExchange(HttpRequest<?> parentRequest, HttpRequest<I> request, java.net.URI requestURI)
void	close() Delegates to LifeCycle.stop().
protected void	closeChannelAsync(io.netty.channel.Channel channel)
protected void	configureHttp2ClearText(DefaultHttpClient.HttpClientInitializer httpClientInitializer, io.netty.channel.socket.SocketChannel ch, io.netty.handler.codec.http2.HttpToHttp2ConnectionHandler connectionHandler) Configures HTTP/2 handling for plaintext (non-SSL) connections.
protected void	configureHttp2Ssl(DefaultHttpClient.HttpClientInitializer httpClientInitializer, io.netty.channel.socket.SocketChannel ch, io.netty.handler.ssl.SslContext sslCtx, java.lang.String host, int port, io.netty.handler.codec.http2.HttpToHttp2ConnectionHandler connectionHandler) Configures HTTP/2 for the channel when SSL is enabled.
protected void	configureProxy(io.netty.channel.ChannelPipeline pipeline, java.net.Proxy.Type proxyType, java.net.SocketAddress proxyAddress) Configures the HTTP proxy for the pipeline.
protected void	configureProxy(io.netty.channel.ChannelPipeline pipeline, java.net.Proxy proxy) Configures the HTTP proxy for the pipeline.
<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.util.Map<java.lang.String,java.lang.Object> parameters) Connect the given client endpoint type.
<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, MutableHttpRequest<?> request) Connect the given client endpoint type to the URI over WebSocket.
protected io.netty.channel.nio.NioEventLoopGroup	createEventLoopGroup(HttpClientConfiguration configuration, java.util.concurrent.ThreadFactory threadFactory) Creates the NioEventLoopGroup for this client.
<I> io.reactivex.Flowable<ByteBuffer<?>>	dataStream(HttpRequest<I> request) Request a stream of data where each emitted item is a ByteBuffer instance.
protected io.netty.channel.ChannelFuture	doConnect(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port) Creates an initial connection with the given bootstrap and remote host.
protected io.netty.channel.ChannelFuture	doConnect(HttpRequest<?> request, java.lang.String host, int port, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, java.util.function.Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer) Creates an initial connection to the given remote host.
protected io.netty.channel.ChannelFuture	doConnect(HttpRequest<?> request, java.net.URI uri, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, java.util.function.Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer) Creates an initial connection to the given remote host.
void	doOnConnect(ChannelPipelineListener listener) A hook to customize the pipeline upon establishing a connection.
<I> io.reactivex.Flowable<Event<ByteBuffer<?>>>	eventStream(HttpRequest<I> request) Perform an HTTP request and receive data as a stream of SSE Event objects as they become available without blocking.
<I,B> io.reactivex.Flowable<Event<B>>	eventStream(HttpRequest<I> request, Argument<B> eventType) Perform an HTTP request and receive data as a stream of SSE Event objects as they become available without blocking.
<I,O,E> io.reactivex.Flowable<HttpResponse<O>>	exchange(HttpRequest<I> request, Argument<O> bodyType, Argument<E> errorType) Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.
<I> io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>>	exchangeStream(HttpRequest<I> request) Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).
HttpClientConfiguration	getConfiguration()
protected java.lang.Object	getLoadBalancerDiscriminator()
org.slf4j.Logger	getLog()
MediaTypeCodecRegistry	getMediaTypeCodecRegistry()
boolean	isClientChannel()
boolean	isRunning()
<I> io.reactivex.Flowable<java.util.Map<java.lang.String,java.lang.Object>>	jsonStream(HttpRequest<I> request) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
<I,O> io.reactivex.Flowable<O>	jsonStream(HttpRequest<I> request, Argument<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
<I,O> io.reactivex.Flowable<O>	jsonStream(HttpRequest<I> request, java.lang.Class<O> type) Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
protected io.netty.handler.codec.http2.HttpToHttp2ConnectionHandlerBuilder	newHttp2ConnectionHandlerBuilder(io.netty.handler.codec.http2.Http2Connection connection, HttpClientConfiguration configuration, boolean stream) Creates a new HttpToHttp2ConnectionHandlerBuilder for the given HTTP/2 connection object and config.
protected java.net.URI	prependContextPath(java.net.URI requestURI)
io.reactivex.Flowable<MutableHttpResponse<?>>	proxy(HttpRequest<?> request) Proxy the given request and emit the response.
protected <I> org.reactivestreams.Publisher<java.net.URI>	resolveRedirectURI(HttpRequest<?> parentRequest, HttpRequest<I> request)
protected <I> org.reactivestreams.Publisher<java.net.URI>	resolveRequestURI(HttpRequest<I> request)
protected <I> org.reactivestreams.Publisher<java.net.URI>	resolveRequestURI(HttpRequest<I> request, boolean includeContextPath)
void	setMediaTypeCodecRegistry(MediaTypeCodecRegistry mediaTypeCodecRegistry) Sets the MediaTypeCodecRegistry used by this client.
HttpClient	start() Starts the lifecyle component.
HttpClient	stop() Stops the life cycle component.
BlockingHttpClient	toBlocking()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.websocket.RxWebSocketClient

connect, connect

Methods inherited from interface io.micronaut.http.client.RxStreamingHttpClient

create, create

Methods inherited from interface io.micronaut.http.client.RxHttpClient

exchange, exchange, exchange, exchange, exchange, retrieve, retrieve, retrieve, retrieve, retrieve

Methods inherited from interface io.micronaut.http.client.HttpClient

refresh

Methods inherited from interface io.micronaut.http.client.sse.RxSseClient

eventStream, eventStream, eventStream

Methods inherited from interface io.micronaut.http.netty.channel.ChannelPipelineCustomizer

isServerChannel

Field Detail

bootstrap

protected final io.netty.bootstrap.Bootstrap bootstrap

group

protected io.netty.channel.EventLoopGroup group

mediaTypeCodecRegistry

protected MediaTypeCodecRegistry mediaTypeCodecRegistry

byteBufferFactory

protected ByteBufferFactory<io.netty.buffer.ByteBufAllocator,io.netty.buffer.ByteBuf> byteBufferFactory

Constructor Detail

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         LoadBalancer loadBalancer,
                         HttpClientConfiguration configuration,
                         @Nullable
                         java.lang.String contextPath,
                         @Nullable
                         java.util.concurrent.ThreadFactory threadFactory,
                         NettyClientSslBuilder nettyClientSslBuilder,
                         MediaTypeCodecRegistry codecRegistry,
                         @Nullable
                         AnnotationMetadataResolver annotationMetadataResolver,
                         HttpClientFilter... filters)

Construct a client for the given arguments.

Parameters:

loadBalancer - The LoadBalancer to use for selecting servers

configuration - The HttpClientConfiguration object

contextPath - The base URI to prepend to request uris

threadFactory - The thread factory to use for client threads

nettyClientSslBuilder - The SSL builder

codecRegistry - The MediaTypeCodecRegistry to use for encoding and decoding objects

annotationMetadataResolver - The annotation metadata resolver

filters - The filters to use

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         LoadBalancer loadBalancer,
                         @Nullable
                         HttpVersion httpVersion,
                         @NonNull
                         HttpClientConfiguration configuration,
                         @Nullable
                         java.lang.String contextPath,
                         @NonNull
                         HttpClientFilterResolver<ClientFilterResolutionContext> filterResolver,
                         java.util.List<HttpFilterResolver.FilterEntry<HttpClientFilter>> clientFilterEntries,
                         @Nullable
                         java.util.concurrent.ThreadFactory threadFactory,
                         @NonNull
                         NettyClientSslBuilder nettyClientSslBuilder,
                         @NonNull
                         MediaTypeCodecRegistry codecRegistry,
                         @NonNull
                         WebSocketBeanRegistry webSocketBeanRegistry,
                         @NonNull
                         RequestBinderRegistry requestBinderRegistry,
                         @Nullable
                         io.netty.channel.EventLoopGroup eventLoopGroup,
                         @NonNull
                         java.lang.Class<? extends io.netty.channel.socket.SocketChannel> socketChannelClass)

Construct a client for the given arguments.

Parameters:

loadBalancer - The LoadBalancer to use for selecting servers

httpVersion - The HTTP version to use. Can be null and defaults to HttpVersion.HTTP_1_1

configuration - The HttpClientConfiguration object

contextPath - The base URI to prepend to request uris

filterResolver - The http client filter resolver

clientFilterEntries - The client filter entries

threadFactory - The thread factory to use for client threads

nettyClientSslBuilder - The SSL builder

codecRegistry - The MediaTypeCodecRegistry to use for encoding and decoding objects

webSocketBeanRegistry - The websocket bean registry

requestBinderRegistry - The request binder registry

eventLoopGroup - The event loop group to use

socketChannelClass - The socket channel class

DefaultHttpClient

public DefaultHttpClient(java.net.URL url)

Parameters:

url - The URL

DefaultHttpClient

public DefaultHttpClient()

DefaultHttpClient

public DefaultHttpClient(java.net.URL url,
                         HttpClientConfiguration configuration)

Parameters:

url - The URL

configuration - The HttpClientConfiguration object

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         LoadBalancer loadBalancer,
                         HttpClientConfiguration configuration)

Parameters:

loadBalancer - The LoadBalancer to use for selecting servers

configuration - The HttpClientConfiguration object

Method Detail

getConfiguration

public HttpClientConfiguration getConfiguration()

Returns:

The configuration used by this client

getLog

public org.slf4j.Logger getLog()

Returns:

The client-specific logger name

start

public HttpClient start()

Description copied from interface: LifeCycle

Starts the lifecyle component.

Specified by:

start in interface LifeCycle<HttpClient>

Returns:

This lifecycle component

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<HttpClient>

Returns:

Whether the component is running

stop

public HttpClient stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<HttpClient>

Returns:

This lifecycle component

getMediaTypeCodecRegistry

public MediaTypeCodecRegistry getMediaTypeCodecRegistry()

Returns:

The MediaTypeCodecRegistry used by this client

setMediaTypeCodecRegistry

public void setMediaTypeCodecRegistry(MediaTypeCodecRegistry mediaTypeCodecRegistry)

Sets the MediaTypeCodecRegistry used by this client.

Parameters:

mediaTypeCodecRegistry - The registry to use. Should not be null

toBlocking

public BlockingHttpClient toBlocking()

Specified by:

toBlocking in interface HttpClient

Returns:

A blocking HTTP client suitable for testing and non-production scenarios.

eventStream

public <I> io.reactivex.Flowable<Event<ByteBuffer<?>>> eventStream(HttpRequest<I> request)

Description copied from interface: SseClient

Perform an HTTP request and receive data as a stream of SSE Event objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

eventStream in interface RxSseClient

Specified by:

eventStream in interface SseClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits an Event with the data represented as a ByteBuffer

eventStream

public <I,B> io.reactivex.Flowable<Event<B>> eventStream(HttpRequest<I> request,
                                                         Argument<B> eventType)

Description copied from interface: SseClient

Perform an HTTP request and receive data as a stream of SSE Event objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

eventStream in interface RxSseClient

Specified by:

eventStream in interface SseClient

Type Parameters:

I - The request body type

B - The event body type

Parameters:

request - The HttpRequest to execute

eventType - The event data type

Returns:

A Publisher that emits an Event with the data represented by the eventType argument

dataStream

public <I> io.reactivex.Flowable<ByteBuffer<?>> dataStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Request a stream of data where each emitted item is a ByteBuffer instance.

Specified by:

dataStream in interface RxStreamingHttpClient

Specified by:

dataStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The request

Returns:

A Publisher that emits a stream of ByteBuffer instances

exchangeStream

public <I> io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>> exchangeStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Requests a stream data where each emitted item is a ByteBuffer wrapped in the HttpResponse object (which remains the same for each emitted item).

Specified by:

exchangeStream in interface RxStreamingHttpClient

Specified by:

exchangeStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest

Returns:

A Publisher that emits a stream of ByteBuffer instances wrapped by a HttpResponse

jsonStream

public <I,O> io.reactivex.Flowable<O> jsonStream(HttpRequest<I> request,
                                                 Argument<O> type)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription. Incoming data is buffered.

Specified by:

jsonStream in interface RxStreamingHttpClient

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

public <I> io.reactivex.Flowable<java.util.Map<java.lang.String,java.lang.Object>> jsonStream(HttpRequest<I> request)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

jsonStream in interface RxStreamingHttpClient

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The HttpRequest to execute

Returns:

A Publisher that emits the full HttpResponse object

jsonStream

public <I,O> io.reactivex.Flowable<O> jsonStream(HttpRequest<I> request,
                                                 java.lang.Class<O> type)

Description copied from interface: StreamingHttpClient

Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.

The downstream Subscriber can regulate demand via the subscription

Specified by:

jsonStream in interface RxStreamingHttpClient

Specified by:

jsonStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

O - The response type

Parameters:

request - The HttpRequest to execute

type - The type of object to convert the JSON into

Returns:

A Publisher that emits the full HttpResponse object

exchange

public <I,O,E> io.reactivex.Flowable<HttpResponse<O>> exchange(HttpRequest<I> request,
                                                               Argument<O> bodyType,
                                                               Argument<E> errorType)

Description copied from interface: HttpClient

Perform an HTTP request for the given request object emitting the full HTTP response from returned Publisher and converting the response body to the specified type.

This method will send a Content-Length header and except a content length header the response and is designed for simple non-streaming exchanges of data

By default the exchange Content-Type is application/json, unless otherwise specified in the passed HttpRequest

Specified by:

exchange in interface HttpClient

Specified by:

exchange in interface RxHttpClient

Type Parameters:

I - The request body type

O - The response body type

E - The error type

Parameters:

request - The HttpRequest to execute

bodyType - The body type

errorType - The error type

Returns:

A Publisher that emits the full HttpResponse object

connect

public <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                            MutableHttpRequest<?> request)

Description copied from interface: WebSocketClient

Connect the given client endpoint type to the URI over WebSocket.

Specified by:

connect in interface RxWebSocketClient

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

request - The original request to establish the connection

Returns:

A Publisher that emits the ClientWebSocket instance

connect

public <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                            java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: RxWebSocketClient

Connect the given client endpoint type. Unlike WebSocketClient.connect(Class, URI) this method will the value declared within the ClientWebSocket as the URI and expand the URI with the given parameters.

Specified by:

connect in interface RxWebSocketClient

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

parameters - The URI parameters for the endpoint

Returns:

A Publisher that emits the ClientWebSocket instance

close

public void close()

Description copied from interface: LifeCycle

Delegates to LifeCycle.stop().

Specified by:

close in interface LifeCycle<HttpClient>

Specified by:

close in interface WebSocketClient

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

buildExchangeStreamPublisher

protected <I> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<HttpResponse<ByteBuffer<?>>>> buildExchangeStreamPublisher(HttpRequest<I> request)

Type Parameters:

I - The input type

Parameters:

request - The request

Returns:

A Function

buildJsonStreamPublisher

protected <I,O> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<O>> buildJsonStreamPublisher(HttpRequest<?> parentRequest,
                                                                                                                HttpRequest<I> request,
                                                                                                                Argument<O> type)

Type Parameters:

I - The input type

O - The output type

Parameters:

parentRequest - The parent request

request - The request

type - The type

Returns:

A Function

buildDataStreamPublisher

protected <I> io.reactivex.functions.Function<java.net.URI,io.reactivex.Flowable<ByteBuffer<?>>> buildDataStreamPublisher(HttpRequest<I> request)

Type Parameters:

I - The input type

Parameters:

request - The request

Returns:

A Function

buildStreamExchange

protected <I> io.reactivex.Flowable<HttpResponse<java.lang.Object>> buildStreamExchange(@Nullable
                                                                                        HttpRequest<?> parentRequest,
                                                                                        HttpRequest<I> request,
                                                                                        java.net.URI requestURI)

Type Parameters:

I - The input type

Parameters:

parentRequest - The parent request

request - The request

requestURI - The request URI

Returns:

A Flowable

buildExchangePublisher

protected <I,O,E> io.reactivex.functions.Function<java.net.URI,org.reactivestreams.Publisher<? extends HttpResponse<O>>> buildExchangePublisher(HttpRequest<?> parentRequest,
                                                                                                                                                HttpRequest<I> request,
                                                                                                                                                Argument<O> bodyType,
                                                                                                                                                Argument<E> errorType)

Type Parameters:

I - The input type

O - The output type

E - The error type

Parameters:

parentRequest - The parent request

request - The request

bodyType - The body type

errorType - The error type

Returns:

A Function

closeChannelAsync

protected void closeChannelAsync(io.netty.channel.Channel channel)

Parameters:

channel - The channel to close asynchronously

resolveRequestURI

protected <I> org.reactivestreams.Publisher<java.net.URI> resolveRequestURI(HttpRequest<I> request)

Type Parameters:

I - The input type

Parameters:

request - The request

Returns:

A Publisher with the resolved URI

resolveRequestURI

protected <I> org.reactivestreams.Publisher<java.net.URI> resolveRequestURI(HttpRequest<I> request,
                                                                            boolean includeContextPath)

Type Parameters:

I - The input type

Parameters:

request - The request

includeContextPath - Whether to prepend the client context path

Returns:

A Publisher with the resolved URI

resolveRedirectURI

protected <I> org.reactivestreams.Publisher<java.net.URI> resolveRedirectURI(HttpRequest<?> parentRequest,
                                                                             HttpRequest<I> request)

Type Parameters:

I - The input type

Parameters:

parentRequest - The parent request

request - The redirect location request

Returns:

A Publisher with the resolved URI

prependContextPath

protected java.net.URI prependContextPath(java.net.URI requestURI)

Parameters:

requestURI - The request URI

Returns:

A URI that is prepended with the contextPath, if set

getLoadBalancerDiscriminator

protected java.lang.Object getLoadBalancerDiscriminator()

Returns:

The discriminator to use when selecting a server for the purposes of load balancing (defaults to null)

doConnect

protected io.netty.channel.ChannelFuture doConnect(HttpRequest<?> request,
                                                   java.net.URI uri,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   java.util.function.Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)
                                            throws HttpClientException

Creates an initial connection to the given remote host.

Parameters:

request - The request

uri - The URI to connect to

sslCtx - The SslContext instance

isStream - Is the connection a stream connection

contextConsumer - The logic to run once the channel is configured correctly

Returns:

A ChannelFuture

Throws:

HttpClientException - If the URI is invalid

doConnect

protected io.netty.channel.ChannelFuture doConnect(HttpRequest<?> request,
                                                   java.lang.String host,
                                                   int port,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   java.util.function.Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)

Creates an initial connection to the given remote host.

Parameters:

request - The request

host - The host

port - The port

sslCtx - The SslContext instance

isStream - Is the connection a stream connection

contextConsumer - The logic to run once the channel is configured correctly

Returns:

A ChannelFuture

createEventLoopGroup

protected io.netty.channel.nio.NioEventLoopGroup createEventLoopGroup(HttpClientConfiguration configuration,
                                                                      java.util.concurrent.ThreadFactory threadFactory)

Creates the NioEventLoopGroup for this client.

Parameters:

configuration - The configuration

threadFactory - The thread factory

Returns:

The group

doConnect

protected io.netty.channel.ChannelFuture doConnect(io.netty.bootstrap.Bootstrap bootstrap,
                                                   java.lang.String host,
                                                   int port)

Creates an initial connection with the given bootstrap and remote host.

Parameters:

bootstrap - The bootstrap instance

host - The host

port - The port

Returns:

The ChannelFuture

buildSslContext

protected io.netty.handler.ssl.SslContext buildSslContext(java.net.URI uriObject)

Builds an SslContext for the given URI if necessary.

Parameters:

uriObject - The URI

Returns:

The SslContext instance

configureProxy

protected void configureProxy(io.netty.channel.ChannelPipeline pipeline,
                              java.net.Proxy proxy)

Configures the HTTP proxy for the pipeline.

Parameters:

pipeline - The pipeline

proxy - The proxy

configureProxy

protected void configureProxy(io.netty.channel.ChannelPipeline pipeline,
                              java.net.Proxy.Type proxyType,
                              java.net.SocketAddress proxyAddress)

Configures the HTTP proxy for the pipeline.

Parameters:

pipeline - The pipeline

proxyType - The proxy type

proxyAddress - The proxy address

applyFilterToResponsePublisher

protected <I,O> org.reactivestreams.Publisher<HttpResponse<O>> applyFilterToResponsePublisher(HttpRequest<?> parentRequest,
                                                                                              HttpRequest<I> request,
                                                                                              java.net.URI requestURI,
                                                                                              java.util.concurrent.atomic.AtomicReference<HttpRequest> requestWrapper,
                                                                                              org.reactivestreams.Publisher<HttpResponse<O>> responsePublisher)

Type Parameters:

I - The input type

O - The output type

Parameters:

parentRequest - The parent request

request - The request

requestURI - The URI of the request

requestWrapper - The request wrapper

responsePublisher - The response publisher

Returns:

The Publisher for the response

buildNettyRequest

protected DefaultHttpClient.NettyRequestWriter buildNettyRequest(MutableHttpRequest request,
                                                                 java.net.URI requestURI,
                                                                 MediaType requestContentType,
                                                                 boolean permitsBody,
                                                                 io.reactivex.functions.Consumer<? super java.lang.Throwable> onError,
                                                                 boolean closeChannelAfterWrite)
                                                          throws io.netty.handler.codec.http.multipart.HttpPostRequestEncoder.ErrorDataEncoderException

Parameters:

request - The request

requestURI - The URI of the request

requestContentType - The request content type

permitsBody - Whether permits body

onError - Called when the body publisher encounters an error

closeChannelAfterWrite - Whether to close the channel. For stream requests we don't close the channel until disposed of.

Returns:

A DefaultHttpClient.NettyRequestWriter

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if there is an encoder exception

configureHttp2Ssl

protected void configureHttp2Ssl(DefaultHttpClient.HttpClientInitializer httpClientInitializer,
                                 @NonNull
                                 io.netty.channel.socket.SocketChannel ch,
                                 @NonNull
                                 io.netty.handler.ssl.SslContext sslCtx,
                                 java.lang.String host,
                                 int port,
                                 io.netty.handler.codec.http2.HttpToHttp2ConnectionHandler connectionHandler)

Configures HTTP/2 for the channel when SSL is enabled.

Parameters:

httpClientInitializer - The client initializer

ch - The channel

sslCtx - The SSL context

host - The host

port - The port

connectionHandler - The connection handler

configureHttp2ClearText

protected void configureHttp2ClearText(DefaultHttpClient.HttpClientInitializer httpClientInitializer,
                                       @NonNull
                                       io.netty.channel.socket.SocketChannel ch,
                                       @NonNull
                                       io.netty.handler.codec.http2.HttpToHttp2ConnectionHandler connectionHandler)

Configures HTTP/2 handling for plaintext (non-SSL) connections.

Parameters:

httpClientInitializer - The client initializer

ch - The channel

connectionHandler - The connection handler

newHttp2ConnectionHandlerBuilder

@NonNull
protected io.netty.handler.codec.http2.HttpToHttp2ConnectionHandlerBuilder newHttp2ConnectionHandlerBuilder(@NonNull
                                                                                                                     io.netty.handler.codec.http2.Http2Connection connection,
                                                                                                                     @NonNull
                                                                                                                     HttpClientConfiguration configuration,
                                                                                                                     boolean stream)

Creates a new HttpToHttp2ConnectionHandlerBuilder for the given HTTP/2 connection object and config.

Parameters:

connection - The connection

configuration - The configuration

stream - Whether this is a stream request

Returns:

The HttpToHttp2ConnectionHandlerBuilder

isClientChannel

public boolean isClientChannel()

Specified by:

isClientChannel in interface ChannelPipelineCustomizer

Returns:

Is this customizer the client.

doOnConnect

public void doOnConnect(@NonNull
                        ChannelPipelineListener listener)

Description copied from interface: ChannelPipelineCustomizer

A hook to customize the pipeline upon establishing a connection.

Specified by:

doOnConnect in interface ChannelPipelineCustomizer

Parameters:

listener - The listener The listener.

proxy

public io.reactivex.Flowable<MutableHttpResponse<?>> proxy(HttpRequest<?> request)

Description copied from interface: ProxyHttpClient

Proxy the given request and emit the response. This method expects the full absolute URL to be included in the request. If a relative URL is specified then the method will try to resolve the URI for the current server otherwise an exception will be thrown.

Specified by:

proxy in interface ProxyHttpClient

Specified by:

proxy in interface RxProxyHttpClient

Parameters:

request - The request

Returns:

A publisher that emits the response.