io.lettuce.core.support.http

Interface HttpClientProvider

All Known Implementing Classes:

NettyHttpClientProvider

@Experimental
public interface HttpClientProvider

SPI (Service Provider Interface) for providing custom HttpClient implementations. Implementations of this interface can be registered via Java's ServiceLoader mechanism to provide alternative HTTP client implementations.

To register a custom provider, create a file named META-INF/services/io.lettuce.core.http.HttpClientProvider containing the fully qualified class name of your implementation.

The HTTP client uses a shared infrastructure (event loops) and supports per-connection configuration. Connections are established with specific SSL options and timeouts that apply to all requests made through that connection.

Example implementation:

 public class MyHttpClientProvider implements HttpClientProvider {

     @Override
     public HttpClient createHttpClient() {
         return new MyHttpClient();
     }

     @Override
     public boolean isAvailable() {
         try {
             Class.forName("com.example.MyHttpClient");
             return true;
         } catch (ClassNotFoundException e) {
             return false;
         }
     }

 }
 

Since:

7.4

Author:

Ivo Gaydazhiev

See Also:

HttpClient, HttpClientResources

Method Summary

Modifier and Type	Method and Description
HttpClient	createHttpClient() Creates a new HttpClient instance.
default int	getPriority() Returns the priority of this provider.
boolean	isAvailable() Returns true if this provider is available and can create HTTP clients.

Method Detail

createHttpClient

HttpClient createHttpClient()

Creates a new HttpClient instance. The client uses shared infrastructure and supports per-connection configuration.

Returns:

a new HttpClient instance.

isAvailable

boolean isAvailable()

Returns true if this provider is available and can create HTTP clients. This method should check if all required dependencies are present on the classpath.

Returns:

true if this provider is available.

getPriority

default int getPriority()

Returns the priority of this provider. Higher priority providers are preferred over lower priority ones. The default Netty-based provider has priority 0.

Returns:

the priority of this provider.