DefaultHttpClient (micronaut 3.6.5 API)

java.lang.Object
- io.micronaut.http.client.netty.DefaultHttpClient

All Implemented Interfaces:

LifeCycle<HttpClient>, HttpClient, ProxyHttpClient, SseClient, StreamingHttpClient, WebSocketClient, Closeable, AutoCloseable
```
@Internal
public class DefaultHttpClient
extends Object
implements WebSocketClient, HttpClient, StreamingHttpClient, SseClient, ProxyHttpClient, Closeable, 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

Constructor Summary

Constructors
Constructor and Description
`DefaultHttpClient()`
`DefaultHttpClient(LoadBalancer loadBalancer, HttpClientConfiguration configuration, List<InvocationInstrumenterFactory> invocationInstrumenterFactories)`
`DefaultHttpClient(LoadBalancer loadBalancer, HttpClientConfiguration configuration, String contextPath, ThreadFactory threadFactory, NettyClientSslBuilder nettyClientSslBuilder, MediaTypeCodecRegistry codecRegistry, AnnotationMetadataResolver annotationMetadataResolver, List<InvocationInstrumenterFactory> invocationInstrumenterFactories, HttpClientFilter... filters)` Construct a client for the given arguments.
DefaultHttpClient(LoadBalancer loadBalancer, HttpVersion httpVersion, HttpClientConfiguration configuration, String contextPath, HttpClientFilterResolver<ClientFilterResolutionContext> filterResolver, List<HttpFilterResolver.FilterEntry<HttpClientFilter>> clientFilterEntries, ThreadFactory threadFactory, NettyClientSslBuilder nettyClientSslBuilder, MediaTypeCodecRegistry codecRegistry, WebSocketBeanRegistry webSocketBeanRegistry, RequestBinderRegistry requestBinderRegistry, io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.channel.ChannelFactory socketChannelFactory, Collection<ChannelPipelineListener> pipelineListeners, NettyClientCustomizer clientCustomizer, List<InvocationInstrumenterFactory> invocationInstrumenterFactories, String informationalServiceId) Construct a client for the given arguments.
`DefaultHttpClient(URI uri)`
`DefaultHttpClient(URI uri, HttpClientConfiguration configuration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected DefaultHttpClient.NettyRequestWriter`	`buildNettyRequest(MutableHttpRequest request, URI requestURI, MediaType requestContentType, boolean permitsBody, Argument<?> bodyType, Consumer<? super Throwable> onError, boolean closeChannelAfterWrite)`
`protected io.netty.handler.ssl.SslContext`	`buildSslContext(URI uriObject)` Builds an `SslContext` for the given URI if necessary.
`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, 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, Proxy.Type proxyType, SocketAddress proxyAddress)` Configures the HTTP proxy for the pipeline.
`protected void`	`configureProxy(io.netty.channel.ChannelPipeline pipeline, Proxy proxy)` Configures the HTTP proxy for the pipeline.
`<T extends AutoCloseable> Publisher<T>`	`connect(Class<T> clientEndpointType, Map<String,Object> parameters)` Connect the given client endpoint type.
`<T extends AutoCloseable> Publisher<T>`	`connect(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, ThreadFactory threadFactory)` Creates the `NioEventLoopGroup` for this client.
`<I> Publisher<ByteBuffer<?>>`	`dataStream(HttpRequest<I> request)` Request a stream of data where each emitted item is a `ByteBuffer` instance.
`<I> Publisher<ByteBuffer<?>>`	`dataStream(HttpRequest<I> request, Argument<?> errorType)` Request a stream of data where each emitted item is a `ByteBuffer` instance.
`protected io.netty.channel.ChannelFuture`	`doConnect(io.netty.bootstrap.Bootstrap bootstrap, String host, int port)` Creates an initial connection with the given bootstrap and remote host.
`protected io.netty.channel.ChannelFuture`	`doConnect(HttpRequest<?> request, String host, int port, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, boolean isProxy, Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)` Creates an initial connection to the given remote host.
`protected io.netty.channel.ChannelFuture`	`doConnect(HttpRequest<?> request, String host, int port, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)` Creates an initial connection to the given remote host.
`protected io.netty.channel.ChannelFuture`	`doConnect(HttpRequest<?> request, URI uri, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, boolean isProxy, Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)` Creates an initial connection to the given remote host.
`protected io.netty.channel.ChannelFuture`	`doConnect(HttpRequest<?> request, URI uri, io.netty.handler.ssl.SslContext sslCtx, boolean isStream, Consumer<io.netty.channel.ChannelHandlerContext> contextConsumer)` Creates an initial connection to the given remote host.
`<I> Publisher<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> Publisher<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,B> Publisher<Event<B>>`	`eventStream(HttpRequest<I> request, Argument<B> eventType, Argument<?> errorType)` Perform an HTTP request and receive data as a stream of SSE `Event` objects as they become available without blocking.
`<I,O,E> Publisher<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> Publisher<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).
`<I> Publisher<HttpResponse<ByteBuffer<?>>>`	`exchangeStream(HttpRequest<I> request, Argument<?> errorType)` 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 Object`	`getLoadBalancerDiscriminator()`
`org.slf4j.Logger`	`getLog()`
`MediaTypeCodecRegistry`	`getMediaTypeCodecRegistry()`
`boolean`	`isRunning()`
`<I> Publisher<Map<String,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> Publisher<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> Publisher<O>`	`jsonStream(HttpRequest<I> request, Argument<O> type, Argument<?> errorType)` Perform an HTTP request and receive data as a stream of JSON objects as they become available without blocking.
`<I,O> Publisher<O>`	`jsonStream(HttpRequest<I> request, 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 URI`	`prependContextPath(URI requestURI)`
`Publisher<MutableHttpResponse<?>>`	`proxy(HttpRequest<?> request)` Proxy the given request and emit the response.
`Publisher<MutableHttpResponse<?>>`	`proxy(HttpRequest<?> request, ProxyRequestOptions options)` Proxy the given request and emit the response.
`protected <I> Publisher<URI>`	`resolveRedirectURI(HttpRequest<?> parentRequest, HttpRequest<I> request)`
`protected <I> Publisher<URI>`	`resolveRequestURI(HttpRequest<I> request)`
`protected <I> Publisher<URI>`	`resolveRequestURI(HttpRequest<I> request, boolean includeContextPath)`
`<I,O,E> Publisher<O>`	`retrieve(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.
`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.WebSocketClient
connect, connect, create, create, create, create

Methods inherited from interface io.micronaut.http.client.StreamingHttpClient
create, create

Methods inherited from interface io.micronaut.http.client.HttpClient
exchange, exchange, exchange, exchange, exchange, refresh, retrieve, retrieve, retrieve, retrieve

Methods inherited from interface io.micronaut.http.client.sse.SseClient
create, create, eventStream, eventStream, eventStream

Methods inherited from interface io.micronaut.http.client.ProxyHttpClient
create, create

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,
                         @NonNull
                         HttpClientConfiguration configuration,
                         @Nullable
                         String contextPath,
                         @Nullable
                         ThreadFactory threadFactory,
                         NettyClientSslBuilder nettyClientSslBuilder,
                         MediaTypeCodecRegistry codecRegistry,
                         @Nullable
                         AnnotationMetadataResolver annotationMetadataResolver,
                         List<InvocationInstrumenterFactory> invocationInstrumenterFactories,
                         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; invocationInstrumenterFactories - The invocation instrumeter factories to instrument netty handlers execution with; filters - The filters to use

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         LoadBalancer loadBalancer,
                         @Nullable
                         HttpVersion httpVersion,
                         @NonNull
                         HttpClientConfiguration configuration,
                         @Nullable
                         String contextPath,
                         @NonNull
                         HttpClientFilterResolver<ClientFilterResolutionContext> filterResolver,
                         List<HttpFilterResolver.FilterEntry<HttpClientFilter>> clientFilterEntries,
                         @Nullable
                         ThreadFactory threadFactory,
                         @NonNull
                         NettyClientSslBuilder nettyClientSslBuilder,
                         @NonNull
                         MediaTypeCodecRegistry codecRegistry,
                         @NonNull
                         WebSocketBeanRegistry webSocketBeanRegistry,
                         @NonNull
                         RequestBinderRegistry requestBinderRegistry,
                         @Nullable
                         io.netty.channel.EventLoopGroup eventLoopGroup,
                         @NonNull
                         io.netty.channel.ChannelFactory socketChannelFactory,
                         Collection<ChannelPipelineListener> pipelineListeners,
                         NettyClientCustomizer clientCustomizer,
                         List<InvocationInstrumenterFactory> invocationInstrumenterFactories,
                         @Nullable
                         String informationalServiceId)

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; socketChannelFactory - The socket channel factory; pipelineListeners - The listeners to call for pipeline customization; clientCustomizer - The pipeline customizer; invocationInstrumenterFactories - The invocation instrumeter factories to instrument netty handlers execution with; informationalServiceId - Optional service ID that will be passed to exceptions created by this client

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         URI uri)

Parameters:: uri - The URL

DefaultHttpClient
```
public DefaultHttpClient()
```

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         URI uri,
                         @NonNull
                         HttpClientConfiguration configuration)

Parameters:: uri - The URI; configuration - The HttpClientConfiguration object

DefaultHttpClient

public DefaultHttpClient(@Nullable
                         LoadBalancer loadBalancer,
                         HttpClientConfiguration configuration,
                         List<InvocationInstrumenterFactory> invocationInstrumenterFactories)

Parameters:: loadBalancer - The LoadBalancer to use for selecting servers; configuration - The HttpClientConfiguration object; invocationInstrumenterFactories - The invocation instrumeter factories to instrument netty handlers execution with

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  Publisher<Event<ByteBuffer<?>>> eventStream(@NonNull
 HttpRequest 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 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> Publisher<Event> eventStream(@NonNull
 HttpRequest request,
 @NonNull
 Argument 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 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

eventStream

public <I,B> Publisher<Event<B>> eventStream(@NonNull
                                             HttpRequest<I> request,
                                             @NonNull
                                             Argument<B> eventType,
                                             @NonNull
                                             Argument<?> errorType)

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 SseClient
Type Parameters:: I - The request body type; B - The event body type
Parameters:: request - The HttpRequest to execute; eventType - The event data type; errorType - The type that the response body should be coerced into if the server responds with an error
Returns:: A Publisher that emits an Event with the data represented by the eventType argument

dataStream
```
public  Publisher<ByteBuffer<?>> dataStream(@NonNull
 HttpRequest request)
```
Description copied from interface: StreamingHttpClient

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

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

dataStream
```
public  Publisher<ByteBuffer<?>> dataStream(@NonNull
 HttpRequest request,
 @NonNull
 Argument<?> errorType)
```
Description copied from interface: StreamingHttpClient

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

Specified by:

dataStream in interface StreamingHttpClient

Type Parameters:

I - The request body type

Parameters:

request - The request

errorType - The type that the response body should be coerced into if the server responds with an error

Returns:

A Publisher that emits a stream of ByteBuffer instances

exchangeStream
```
public  Publisher<HttpResponse<ByteBuffer<?>>> exchangeStream(@NonNull
 HttpRequest 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 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

exchangeStream

public <I> Publisher<HttpResponse<ByteBuffer<?>>> exchangeStream(@NonNull
                                                                 HttpRequest<I> request,
                                                                 @NonNull
                                                                 Argument<?> errorType)

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 StreamingHttpClient
Type Parameters:: I - The request body type
Parameters:: request - The HttpRequest; errorType - The type that the response body should be coerced into if the server responds with an error
Returns:: A Publisher that emits a stream of ByteBuffer instances wrapped by a HttpResponse

jsonStream
```
public <I,O> Publisher<O> jsonStream(@NonNull
 HttpRequest request,
 @NonNull
 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 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,O> Publisher<O> jsonStream(@NonNull
 HttpRequest request,
 @NonNull
 Argument<O> type,
 @NonNull
 Argument<?> errorType)
```
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 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

errorType - The type that the response body should be coerced into if the server responds with an error

Returns:

A Publisher that emits the full HttpResponse object

jsonStream
```
public  Publisher<Map<String,Object>> jsonStream(@NonNull
 HttpRequest 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 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> Publisher<O> jsonStream(@NonNull
 HttpRequest request,
 @NonNull
 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 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> Publisher<HttpResponse<O>> exchange(@NonNull
 HttpRequest request,
 @NonNull
 Argument<O> bodyType,
 @NonNull
 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

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

retrieve
```
public <I,O,E> Publisher<O> retrieve(HttpRequest 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.

Specified by:

retrieve in interface HttpClient

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 a result of the given type

connect
```
public <T extends AutoCloseable> Publisher<T> connect(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 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 AutoCloseable> Publisher<T> connect(Class<T> clientEndpointType,
 Map<String,Object> parameters)
```
Description copied from interface: WebSocketClient

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 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 Closeable

Specified by:

close in interface AutoCloseable

proxy
```
public Publisher<MutableHttpResponse<?>> proxy(@NonNull
 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

Parameters:

request - The request

Returns:

A publisher that emits the response.

proxy
```
public Publisher<MutableHttpResponse<?>> proxy(@NonNull
 HttpRequest<?> request,
 @NonNull
 ProxyRequestOptions options)
```
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

Parameters:

request - The request

options - Further options for the proxy request

Returns:

A publisher that emits the response.

closeChannelAsync
```
protected void closeChannelAsync(io.netty.channel.Channel channel)
```
Parameters:

channel - The channel to close asynchronously

resolveRequestURI
```
protected  Publisher<URI> resolveRequestURI(HttpRequest request)
```
Type Parameters:

I - The input type

Parameters:

request - The request

Returns:

A Publisher with the resolved URI

resolveRequestURI
```
protected  Publisher<URI> resolveRequestURI(HttpRequest 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> Publisher<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 URI prependContextPath(URI requestURI)
```
Parameters:

requestURI - The request URI

Returns:

A URI that is prepended with the contextPath, if set

getLoadBalancerDiscriminator
```
protected 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,
                                                   URI uri,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   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,
                                                   URI uri,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   boolean isProxy,
                                                   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; isProxy - Is this a streaming proxy; 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,
                                                   String host,
                                                   int port,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   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

doConnect

protected io.netty.channel.ChannelFuture doConnect(HttpRequest<?> request,
                                                   String host,
                                                   int port,
                                                   @Nullable
                                                   io.netty.handler.ssl.SslContext sslCtx,
                                                   boolean isStream,
                                                   boolean isProxy,
                                                   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; isProxy - Is this a streaming proxy; contextConsumer - The logic to run once the channel is configured correctly
Returns:: A ChannelFuture

createEventLoopGroup

protected io.netty.channel.nio.NioEventLoopGroup createEventLoopGroup(HttpClientConfiguration configuration,
                                                                      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,
                                                   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(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,
                              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,
                              Proxy.Type proxyType,
                              SocketAddress proxyAddress)

Configures the HTTP proxy for the pipeline.

Parameters:: pipeline - The pipeline; proxyType - The proxy type; proxyAddress - The proxy address

buildNettyRequest

protected DefaultHttpClient.NettyRequestWriter buildNettyRequest(MutableHttpRequest request,
                                                                 URI requestURI,
                                                                 MediaType requestContentType,
                                                                 boolean permitsBody,
                                                                 @Nullable
                                                                 Argument<?> bodyType,
                                                                 Consumer<? super 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; bodyType - The body type; 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,
                                 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

Class DefaultHttpClient

Nested Class Summary

Field Summary

Fields inherited from interface io.micronaut.websocket.WebSocketClient

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.websocket.WebSocketClient

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

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

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

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

Field Detail

bootstrap

group

mediaTypeCodecRegistry

byteBufferFactory

Constructor Detail

DefaultHttpClient

DefaultHttpClient

DefaultHttpClient

DefaultHttpClient

DefaultHttpClient

DefaultHttpClient

Method Detail

getConfiguration

getLog

start

isRunning

stop

getMediaTypeCodecRegistry

setMediaTypeCodecRegistry

toBlocking

eventStream

eventStream

eventStream

dataStream

dataStream

exchangeStream

exchangeStream

jsonStream

jsonStream

jsonStream

jsonStream

exchange

retrieve

connect

connect

close

proxy

proxy

closeChannelAsync

resolveRequestURI

resolveRequestURI

resolveRedirectURI

prependContextPath

getLoadBalancerDiscriminator

doConnect

doConnect

doConnect

doConnect

createEventLoopGroup

doConnect

buildSslContext

configureProxy

configureProxy

buildNettyRequest

configureHttp2Ssl

configureHttp2ClearText

newHttp2ConnectionHandlerBuilder