io.micronaut.http.client.netty

Class DefaultNettyHttpClientRegistry

java.lang.Object

io.micronaut.http.client.netty.DefaultNettyHttpClientRegistry

All Implemented Interfaces:

HttpClientRegistry<HttpClient>, NettyClientCustomizer.Registry, ProxyHttpClientRegistry<ProxyHttpClient>, SseClientRegistry<SseClient>, StreamingHttpClientRegistry<StreamingHttpClient>, ChannelPipelineCustomizer, WebSocketClientRegistry<WebSocketClient>, AutoCloseable

@Factory
 @Internal
public class DefaultNettyHttpClientRegistry
extends Object
implements AutoCloseable, HttpClientRegistry<HttpClient>, SseClientRegistry<SseClient>, StreamingHttpClientRegistry<StreamingHttpClient>, WebSocketClientRegistry<WebSocketClient>, ProxyHttpClientRegistry<ProxyHttpClient>, ChannelPipelineCustomizer, NettyClientCustomizer.Registry

Factory for the default implementation of the HttpClient interface based on Netty.

Since:

2.0

Author:

Graeme Rocher

Field Summary

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_HTTP_TO_HTTPS_REDIRECT, 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

DefaultNettyHttpClientRegistry(HttpClientConfiguration defaultHttpClientConfiguration, HttpClientFilterResolver httpClientFilterResolver, LoadBalancerResolver loadBalancerResolver, NettyClientSslBuilder nettyClientSslBuilder, ThreadFactory threadFactory, MediaTypeCodecRegistry codecRegistry, EventLoopGroupRegistry eventLoopGroupRegistry, EventLoopGroupFactory eventLoopGroupFactory, BeanContext beanContext, List<InvocationInstrumenterFactory> invocationInstrumenterFactories, JsonMapper jsonMapper) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
void	disposeClient(AnnotationMetadata annotationMetadata) Dispose of the client defined by the given metadata.
void	doOnConnect(ChannelPipelineListener listener) A hook to customize the pipeline upon establishing a connection.
DefaultHttpClient	getClient(AnnotationMetadata metadata) Return the client for the given annotation metadata.
HttpClient	getClient(HttpVersion httpVersion, String clientId, String path) Return the client for the client ID and path.
DefaultHttpClient	getProxyHttpClient(AnnotationMetadata metadata) Return the client for the given annotation metadata.
DefaultHttpClient	getSseClient(AnnotationMetadata metadata) Return the client for the given annotation metadata.
DefaultHttpClient	getStreamingHttpClient(AnnotationMetadata metadata) Return the client for the given annotation metadata.
DefaultHttpClient	getWebSocketClient(AnnotationMetadata metadata) Return the client for the given annotation metadata.
protected DefaultHttpClient	httpClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Creates a new HttpClient for the given injection point.
boolean	isClientChannel()
void	register(NettyClientCustomizer customizer) Register a new customizer with this registry.
HttpClient	resolveClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Resolves a HttpClient for the given injection point.
ProxyHttpClient	resolveProxyHttpClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Resolves a ProxyHttpClient for the given injection point.
SseClient	resolveSseClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Resolves a SseClient for the given injection point.
StreamingHttpClient	resolveStreamingHttpClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Resolves a StreamingHttpClient for the given injection point.
WebSocketClient	resolveWebSocketClient(InjectionPoint<?> injectionPoint, LoadBalancer loadBalancer, HttpClientConfiguration configuration, BeanContext beanContext) Resolves a WebSocketClient for the given injection point.

Methods inherited from class java.lang.Object

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

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

getDefaultClient

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

getDefaultSseClient

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

getDefaultStreamingHttpClient

Methods inherited from interface io.micronaut.websocket.WebSocketClientRegistry

getDefaultWebSocketClient

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

getDefaultProxyHttpClient

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

isServerChannel

Constructor Detail

DefaultNettyHttpClientRegistry

public DefaultNettyHttpClientRegistry(HttpClientConfiguration defaultHttpClientConfiguration,
                                      HttpClientFilterResolver httpClientFilterResolver,
                                      LoadBalancerResolver loadBalancerResolver,
                                      NettyClientSslBuilder nettyClientSslBuilder,
                                      ThreadFactory threadFactory,
                                      MediaTypeCodecRegistry codecRegistry,
                                      EventLoopGroupRegistry eventLoopGroupRegistry,
                                      EventLoopGroupFactory eventLoopGroupFactory,
                                      BeanContext beanContext,
                                      List<InvocationInstrumenterFactory> invocationInstrumenterFactories,
                                      JsonMapper jsonMapper)

Default constructor.

Parameters:

defaultHttpClientConfiguration - The default HTTP client configuration

httpClientFilterResolver - The HTTP client filter resolver

loadBalancerResolver - The load balancer resolver

nettyClientSslBuilder - The client SSL builder

threadFactory - The thread factory

codecRegistry - The codec registry

eventLoopGroupRegistry - The event loop group registry

eventLoopGroupFactory - The event loop group factory

beanContext - The bean context

invocationInstrumenterFactories - The invocation instrumenter factories

jsonMapper - JSON Mapper

Method Detail

getClient

@NonNull
public HttpClient getClient(HttpVersion httpVersion,
                                     @NonNull
                                     String clientId,
                                     @Nullable
                                     String path)

Description copied from interface: HttpClientRegistry

Return the client for the client ID and path.

Specified by:

getClient in interface HttpClientRegistry<HttpClient>

Parameters:

httpVersion - The HTTP version

clientId - The client ID

path - The path (Optional)

Returns:

The client

getClient

@NonNull
public DefaultHttpClient getClient(@NonNull
                                            AnnotationMetadata metadata)

Description copied from interface: HttpClientRegistry

Return the client for the given annotation metadata.

Specified by:

getClient in interface HttpClientRegistry<HttpClient>

Parameters:

metadata - The annotation metadata.

Returns:

The client

getSseClient

@NonNull
public DefaultHttpClient getSseClient(@NonNull
                                               AnnotationMetadata metadata)

Description copied from interface: SseClientRegistry

Return the client for the given annotation metadata.

Specified by:

getSseClient in interface SseClientRegistry<SseClient>

Parameters:

metadata - The annotation metadata.

Returns:

The client

getStreamingHttpClient

@NonNull
public DefaultHttpClient getStreamingHttpClient(@NonNull
                                                         AnnotationMetadata metadata)

Description copied from interface: StreamingHttpClientRegistry

Return the client for the given annotation metadata.

Specified by:

getStreamingHttpClient in interface StreamingHttpClientRegistry<StreamingHttpClient>

Parameters:

metadata - The annotation metadata.

Returns:

The client

getProxyHttpClient

@NonNull
public DefaultHttpClient getProxyHttpClient(@NonNull
                                                     AnnotationMetadata metadata)

Description copied from interface: ProxyHttpClientRegistry

Return the client for the given annotation metadata.

Specified by:

getProxyHttpClient in interface ProxyHttpClientRegistry<ProxyHttpClient>

Parameters:

metadata - The annotation metadata.

Returns:

The client

getWebSocketClient

@NonNull
public DefaultHttpClient getWebSocketClient(@NonNull
                                                     AnnotationMetadata metadata)

Description copied from interface: WebSocketClientRegistry

Return the client for the given annotation metadata.

Specified by:

getWebSocketClient in interface WebSocketClientRegistry<WebSocketClient>

Parameters:

metadata - The annotation metadata.

Returns:

The client

close

@PreDestroy
public void close()

Specified by:

close in interface AutoCloseable

disposeClient

public void disposeClient(AnnotationMetadata annotationMetadata)

Description copied from interface: HttpClientRegistry

Dispose of the client defined by the given metadata.

Specified by:

disposeClient in interface HttpClientRegistry<HttpClient>

Specified by:

disposeClient in interface ProxyHttpClientRegistry<ProxyHttpClient>

Specified by:

disposeClient in interface SseClientRegistry<SseClient>

Specified by:

disposeClient in interface StreamingHttpClientRegistry<StreamingHttpClient>

Specified by:

disposeClient in interface WebSocketClientRegistry<WebSocketClient>

Parameters:

annotationMetadata - The annotation metadata

httpClient

@Bean
 @Primary
protected DefaultHttpClient httpClient(@Nullable
                                                       InjectionPoint<?> injectionPoint,
                                                       @Parameter @Nullable
                                                       LoadBalancer loadBalancer,
                                                       @Parameter @Nullable
                                                       HttpClientConfiguration configuration,
                                                       BeanContext beanContext)

Creates a new HttpClient for the given injection point.

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The client

resolveClient

@NonNull
public HttpClient resolveClient(@Nullable
                                         InjectionPoint<?> injectionPoint,
                                         @Nullable
                                         LoadBalancer loadBalancer,
                                         @Nullable
                                         HttpClientConfiguration configuration,
                                         @NonNull
                                         BeanContext beanContext)

Description copied from interface: HttpClientRegistry

Resolves a HttpClient for the given injection point.

Specified by:

resolveClient in interface HttpClientRegistry<HttpClient>

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The HTTP Client

resolveProxyHttpClient

@NonNull
public ProxyHttpClient resolveProxyHttpClient(@Nullable
                                                       InjectionPoint<?> injectionPoint,
                                                       @Nullable
                                                       LoadBalancer loadBalancer,
                                                       @Nullable
                                                       HttpClientConfiguration configuration,
                                                       @NonNull
                                                       BeanContext beanContext)

Description copied from interface: ProxyHttpClientRegistry

Resolves a ProxyHttpClient for the given injection point.

Specified by:

resolveProxyHttpClient in interface ProxyHttpClientRegistry<ProxyHttpClient>

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The Proxy HTTP Client

resolveSseClient

@NonNull
public SseClient resolveSseClient(@Nullable
                                           InjectionPoint<?> injectionPoint,
                                           @Nullable
                                           LoadBalancer loadBalancer,
                                           @Nullable
                                           HttpClientConfiguration configuration,
                                           @NonNull
                                           BeanContext beanContext)

Description copied from interface: SseClientRegistry

Resolves a SseClient for the given injection point.

Specified by:

resolveSseClient in interface SseClientRegistry<SseClient>

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The SSE HTTP Client

resolveStreamingHttpClient

@NonNull
public StreamingHttpClient resolveStreamingHttpClient(@Nullable
                                                               InjectionPoint<?> injectionPoint,
                                                               @Nullable
                                                               LoadBalancer loadBalancer,
                                                               @Nullable
                                                               HttpClientConfiguration configuration,
                                                               @NonNull
                                                               BeanContext beanContext)

Description copied from interface: StreamingHttpClientRegistry

Resolves a StreamingHttpClient for the given injection point.

Specified by:

resolveStreamingHttpClient in interface StreamingHttpClientRegistry<StreamingHttpClient>

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The Streaming HTTP Client

resolveWebSocketClient

@NonNull
public WebSocketClient resolveWebSocketClient(@Nullable
                                                       InjectionPoint<?> injectionPoint,
                                                       @Nullable
                                                       LoadBalancer loadBalancer,
                                                       @Nullable
                                                       HttpClientConfiguration configuration,
                                                       @NonNull
                                                       BeanContext beanContext)

Description copied from interface: WebSocketClientRegistry

Resolves a WebSocketClient for the given injection point.

Specified by:

resolveWebSocketClient in interface WebSocketClientRegistry<WebSocketClient>

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The Streaming HTTP Client

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.

register

public void register(@NonNull
                     NettyClientCustomizer customizer)

Description copied from interface: NettyClientCustomizer.Registry

Register a new customizer with this registry.

Specified by:

register in interface NettyClientCustomizer.Registry

Parameters:

customizer - The customizer to register.