org.gbif.ws.client

Class ClientBuilder

java.lang.Object

org.gbif.ws.client.ClientBuilder

public class ClientBuilder
extends Object

ClientBuilder used to create Feign Clients. This builders support retry using exponential backoff and multithreaded http client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientBuilder.ConnectionPoolConfig

Constructor Summary

Constructors

Constructor and Description
ClientBuilder()

Method Summary

Modifier and Type	Method and Description
<T> T	build(Class<T> clazz) Creates a new client instance.
ClientBuilder	withAppKeyCredentials(String username, String appKey, String secretKey) Custom AppKey credentials.
ClientBuilder	withClientContract(ClientContract clientContract)
ClientBuilder	withConnectionPoolConfig(ClientBuilder.ConnectionPoolConfig connectionPoolConfig) Connection pool configuration to create a multithreaded client.
ClientBuilder	withConnectTimeout(int connectTimeoutMillis) Client connection timeout in milliseconds.
ClientBuilder	withCredentials(String username, String password) Simple base credentials.
ClientBuilder	withCustomGbifAuth(String username, String appKey, String secretKey, SigningService signingService, Md5EncodeService md5EncodeService) Custom GBIF authentication.
ClientBuilder	withExponentialBackoffRetry(Duration initialInterval, double multiplier, int maxAttempts) Exponential backoff retryer.
ClientBuilder	withFormEncoder()
ClientBuilder	withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Jakcson ObjectMapper used to serialize JSON data.
ClientBuilder	withReadTimeout(int readTimeoutMillis) Client read timeout in milliseconds.
ClientBuilder	withUrl(String url) Target base url.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientBuilder

public ClientBuilder()

Method Detail

withExponentialBackoffRetry

public ClientBuilder withExponentialBackoffRetry(Duration initialInterval,
                                                 double multiplier,
                                                 int maxAttempts)

Exponential backoff retryer.

withUrl

public ClientBuilder withUrl(String url)

Target base url.

withCredentials

public ClientBuilder withCredentials(String username,
                                     String password)

Simple base credentials.

withAppKeyCredentials

public ClientBuilder withAppKeyCredentials(String username,
                                           String appKey,
                                           String secretKey)

Custom AppKey credentials.

withConnectionPoolConfig

public ClientBuilder withConnectionPoolConfig(ClientBuilder.ConnectionPoolConfig connectionPoolConfig)

Connection pool configuration to create a multithreaded client.

withConnectTimeout

public ClientBuilder withConnectTimeout(int connectTimeoutMillis)

Client connection timeout in milliseconds.

withReadTimeout

public ClientBuilder withReadTimeout(int readTimeoutMillis)

Client read timeout in milliseconds.

withObjectMapper

public ClientBuilder withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Jakcson ObjectMapper used to serialize JSON data.

withCustomGbifAuth

public ClientBuilder withCustomGbifAuth(String username,
                                        String appKey,
                                        String secretKey,
                                        SigningService signingService,
                                        Md5EncodeService md5EncodeService)

Custom GBIF authentication.

withFormEncoder

public ClientBuilder withFormEncoder()

withClientContract

public ClientBuilder withClientContract(ClientContract clientContract)

build

public <T> T build(Class<T> clazz)

Creates a new client instance.