com.algolia.search

Class APIClientBuilder

java.lang.Object

com.algolia.search.APIClientBuilder

public abstract class APIClientBuilder
extends Object

Base class to create APIClient

Constructor Summary

Constructors

Constructor and Description
APIClientBuilder(String applicationId, String apiKey) Initialize this builder with the applicationId and apiKey

Method Summary

Modifier and Type	Method and Description
APIClient	build() Build the APIClient
protected abstract APIClient	build(APIClientConfiguration configuration)
protected List<String>	generateBuildHosts()
protected Map<String,String>	generateHeaders()
protected List<String>	generateQueryHosts()
APIClientBuilder	setConnectTimeout(int connectTimeout) Set the connect timeout of the HTTP client
APIClientBuilder	setExtraHeader(String key, String value) Set extra headers to the requests
APIClientBuilder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Set the Jackson ObjectMapper
APIClientBuilder	setReadTimeout(int readTimeout) Set the read timeout of the HTTP client
APIClientBuilder	setUserAgent(String customAgent, String customAgentVersion) Customize the user agent

Methods inherited from class java.lang.Object

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

Constructor Detail

APIClientBuilder

public APIClientBuilder(@Nonnull
                        String applicationId,
                        @Nonnull
                        String apiKey)

Initialize this builder with the applicationId and apiKey

Parameters:

applicationId - APP_ID can be found on https://www.algolia.com/api-keys

apiKey - Algolia API_KEY can also be found on https://www.algolia.com/api-keys

Method Detail

setUserAgent

public APIClientBuilder setUserAgent(@Nonnull
                                     String customAgent,
                                     @Nonnull
                                     String customAgentVersion)

Customize the user agent

Parameters:

customAgent - key to add to the user agent

customAgentVersion - value of this key to add to the user agent

Returns:

this

setExtraHeader

public APIClientBuilder setExtraHeader(@Nonnull
                                       String key,
                                       String value)

Set extra headers to the requests

Parameters:

key - name of the header

value - value of the header

Returns:

this

setConnectTimeout

public APIClientBuilder setConnectTimeout(int connectTimeout)

Set the connect timeout of the HTTP client

Parameters:

connectTimeout - the value in ms

Returns:

this

setReadTimeout

public APIClientBuilder setReadTimeout(int readTimeout)

Set the read timeout of the HTTP client

Parameters:

readTimeout - the value in ms

Returns:

this

setObjectMapper

public APIClientBuilder setObjectMapper(@Nonnull
                                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Set the Jackson ObjectMapper

Parameters:

objectMapper - the mapper

Returns:

this

generateBuildHosts

protected List<String> generateBuildHosts()

generateQueryHosts

protected List<String> generateQueryHosts()

generateHeaders

protected Map<String,String> generateHeaders()

build

protected abstract APIClient build(@Nonnull
                                   APIClientConfiguration configuration)

build

public APIClient build()

Build the APIClient

Returns:

the built APIClient