Package io.micronaut.http.client.netty

Class NettyHttpClientFactory

java.lang.Object

io.micronaut.http.client.netty.NettyHttpClientFactory

All Implemented Interfaces:

HttpClientFactory, ProxyHttpClientFactory, RawHttpClientFactory, SseClientFactory, StreamingHttpClientFactory, WebSocketClientFactory

@Internal
public class NettyHttpClientFactory
extends Object
implements HttpClientFactory, SseClientFactory, ProxyHttpClientFactory, StreamingHttpClientFactory, WebSocketClientFactory, RawHttpClientFactory

A factory to create Netty HTTP clients.

Since:

3.0

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor	Description
NettyHttpClientFactory()

Method Summary

Modifier and Type	Method	Description
@NonNull HttpClient	createClient(URL url)	Create a new HttpClient.
@NonNull HttpClient	createClient(URL url, @NonNull HttpClientConfiguration configuration)	Create a new HttpClient with the specified configuration.
@NonNull ProxyHttpClient	createProxyClient(URL url)	Create a new ProxyHttpClient.
@NonNull ProxyHttpClient	createProxyClient(URL url, @NonNull HttpClientConfiguration configuration)	Create a new ProxyHttpClient with the specified configuration.
@NonNull RawHttpClient	createRawClient(@Nullable URI url)	Create a new RawHttpClient.
@NonNull RawHttpClient	createRawClient(@Nullable URI url, @NonNull HttpClientConfiguration configuration)	Create a new RawHttpClient with the specified configuration.
@NonNull SseClient	createSseClient(@Nullable URL url)	Create a new SseClient.
@NonNull SseClient	createSseClient(@Nullable URL url, @NonNull HttpClientConfiguration configuration)	Create a new SseClient with the specified configuration.
@NonNull StreamingHttpClient	createStreamingClient(URL url)	Create a new StreamingHttpClient.
@NonNull StreamingHttpClient	createStreamingClient(URL url, @NonNull HttpClientConfiguration configuration)	Create a new StreamingHttpClient with the specified configuration.
@NonNull WebSocketClient	createWebSocketClient(URI uri)	Create a new WebSocketClient.
@NonNull WebSocketClient	createWebSocketClient(URI uri, @NonNull HttpClientConfiguration configuration)	Create a new WebSocketClient with the specified configuration.

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.WebSocketClientFactory

createWebSocketClient, createWebSocketClient

Constructor Details

NettyHttpClientFactory

public NettyHttpClientFactory()

Method Details

createClient

@NonNull
public @NonNull HttpClient createClient(URL url)

Description copied from interface: HttpClientFactory

Create a new HttpClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createClient in interface HttpClientFactory

Parameters:

url - The base URL

Returns:

The client

createClient

@NonNull
public @NonNull HttpClient createClient(URL url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: HttpClientFactory

Create a new HttpClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createClient in interface HttpClientFactory

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

createProxyClient

@NonNull
public @NonNull ProxyHttpClient createProxyClient(URL url)

Description copied from interface: ProxyHttpClientFactory

Create a new ProxyHttpClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createProxyClient in interface ProxyHttpClientFactory

Parameters:

url - The base URL

Returns:

The client

createProxyClient

@NonNull
public @NonNull ProxyHttpClient createProxyClient(URL url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: ProxyHttpClientFactory

Create a new ProxyHttpClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createProxyClient in interface ProxyHttpClientFactory

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

createSseClient

@NonNull
public @NonNull SseClient createSseClient(@Nullable
 @Nullable URL url)

Description copied from interface: SseClientFactory

Create a new SseClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createSseClient in interface SseClientFactory

Parameters:

url - The base URL

Returns:

The client

createSseClient

@NonNull
public @NonNull SseClient createSseClient(@Nullable
 @Nullable URL url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: SseClientFactory

Create a new SseClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createSseClient in interface SseClientFactory

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

createStreamingClient

@NonNull
public @NonNull StreamingHttpClient createStreamingClient(URL url)

Description copied from interface: StreamingHttpClientFactory

Create a new StreamingHttpClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createStreamingClient in interface StreamingHttpClientFactory

Parameters:

url - The base URL

Returns:

The client

createStreamingClient

@NonNull
public @NonNull StreamingHttpClient createStreamingClient(URL url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: StreamingHttpClientFactory

Create a new StreamingHttpClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createStreamingClient in interface StreamingHttpClientFactory

Parameters:

url - The base URL

configuration - The client configuration

Returns:

The client

createWebSocketClient

@NonNull
public @NonNull WebSocketClient createWebSocketClient(URI uri)

Description copied from interface: WebSocketClientFactory

Create a new WebSocketClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createWebSocketClient in interface WebSocketClientFactory

Parameters:

uri - The base URI

Returns:

The client

createWebSocketClient

@NonNull
public @NonNull WebSocketClient createWebSocketClient(URI uri,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: WebSocketClientFactory

Create a new WebSocketClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createWebSocketClient in interface WebSocketClientFactory

Parameters:

uri - The base URI

configuration - The client configuration

Returns:

The client

createRawClient

@NonNull
public @NonNull RawHttpClient createRawClient(@Nullable
 @Nullable URI url)

Description copied from interface: RawHttpClientFactory

Create a new RawHttpClient. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createRawClient in interface RawHttpClientFactory

Parameters:

url - The base URL

Returns:

The client

createRawClient

@NonNull
public @NonNull RawHttpClient createRawClient(@Nullable
 @Nullable URI url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Description copied from interface: RawHttpClientFactory

Create a new RawHttpClient with the specified configuration. Note that this method should only be used outside the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

createRawClient in interface RawHttpClientFactory

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client