com.algolia.search

Class GenericAPIClientBuilder

java.lang.Object

com.algolia.search.GenericAPIClientBuilder

Direct Known Subclasses:

APIClientBuilder, AsyncAPIClientBuilder

public abstract class GenericAPIClientBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	analyticsHost
protected String	apiKey
protected String	applicationId
protected List<String>	buildHosts
protected int	connectTimeout
protected String	customAgent
protected String	customAgentVersion
protected Map<String,String>	customHeaders
protected int	hostDownTimeout
protected int	maxConnPerRoute
protected int	maxConnTotal
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected List<String>	queryHosts
protected Random	random
protected int	readTimeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GenericAPIClientBuilder	addExtraHeader(String key, String value) Add extra headers to the requests
protected List<String>	generateBuildHosts()
protected Map<String,String>	generateHeaders()
protected List<String>	generateQueryHosts()
GenericAPIClientBuilder	setAnalyticsHost(String analyticsHost) Set the analytics host
GenericAPIClientBuilder	setBuildHosts(List<String> buildHosts) Set the hosts for indexing & building
GenericAPIClientBuilder	setConnectTimeout(int connectTimeout) Set the connect timeout of the HTTP client
GenericAPIClientBuilder	setExtraHeader(String key, String value) Deprecated.
GenericAPIClientBuilder	setHostDownTimeout(int hostDownTimeout) Set the retry timeout to detect if a host is down
GenericAPIClientBuilder	setMaxConnPerRoute(int maxConnPerRoute) Set the maximum of connection per route, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder
GenericAPIClientBuilder	setMaxConnTotal(int maxConnTotal) Set the maximum of connection, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder
GenericAPIClientBuilder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Set the Jackson ObjectMapper, it overrides the default one and add 2 features: * Enables: AUTO_CLOSE_JSON_CONTENT * Disables: FAIL_ON_UNKNOWN_PROPERTIES
GenericAPIClientBuilder	setQueryHosts(List<String> queryHosts) Set the hosts for search & queries
GenericAPIClientBuilder	setReadTimeout(int readTimeout) Set the read timeout of the HTTP client
GenericAPIClientBuilder	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

Field Detail

random

protected final Random random

applicationId

protected final String applicationId

apiKey

protected final String apiKey

customAgent

protected String customAgent

customAgentVersion

protected String customAgentVersion

analyticsHost

protected String analyticsHost

queryHosts

protected List<String> queryHosts

buildHosts

protected List<String> buildHosts

customHeaders

protected Map<String,String> customHeaders

connectTimeout

protected int connectTimeout

readTimeout

protected int readTimeout

hostDownTimeout

protected int hostDownTimeout

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

maxConnTotal

protected int maxConnTotal

maxConnPerRoute

protected int maxConnPerRoute

Constructor Detail

GenericAPIClientBuilder

public GenericAPIClientBuilder(@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 GenericAPIClientBuilder 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

@Deprecated
public GenericAPIClientBuilder setExtraHeader(@Nonnull
                                                          String key,
                                                          String value)

Deprecated.

Deprecated: use addExtraHeader(String, String)

addExtraHeader

public GenericAPIClientBuilder addExtraHeader(@Nonnull
                                              String key,
                                              String value)

Add extra headers to the requests

Parameters:

key - name of the header

value - value of the header

Returns:

this

setConnectTimeout

public GenericAPIClientBuilder setConnectTimeout(int connectTimeout)

Set the connect timeout of the HTTP client

Parameters:

connectTimeout - the value in ms

Returns:

this

setReadTimeout

public GenericAPIClientBuilder setReadTimeout(int readTimeout)

Set the read timeout of the HTTP client

Parameters:

readTimeout - the value in ms

Returns:

this

setHostDownTimeout

public GenericAPIClientBuilder setHostDownTimeout(int hostDownTimeout)

Set the retry timeout to detect if a host is down

Parameters:

hostDownTimeout - the value in ms

Returns:

this

setObjectMapper

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

Set the Jackson ObjectMapper, it overrides the default one and add 2 features: * Enables: AUTO_CLOSE_JSON_CONTENT * Disables: FAIL_ON_UNKNOWN_PROPERTIES

Parameters:

objectMapper - the mapper

Returns:

this

setAnalyticsHost

public GenericAPIClientBuilder setAnalyticsHost(@Nonnull
                                                String analyticsHost)

Set the analytics host

Parameters:

analyticsHost - the analytics host to use

Returns:

this

setQueryHosts

public GenericAPIClientBuilder setQueryHosts(List<String> queryHosts)

Set the hosts for search & queries

Parameters:

queryHosts - the list of hosts for search

Returns:

this

setBuildHosts

public GenericAPIClientBuilder setBuildHosts(List<String> buildHosts)

Set the hosts for indexing & building

Parameters:

buildHosts - the list of hosts for indexing/building

Returns:

this

setMaxConnTotal

public GenericAPIClientBuilder setMaxConnTotal(int maxConnTotal)

Set the maximum of connection, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder

Parameters:

maxConnTotal - the max number of connections

Returns:

this

setMaxConnPerRoute

public GenericAPIClientBuilder setMaxConnPerRoute(int maxConnPerRoute)

Set the maximum of connection per route, only available for ApacheAPIClientBuilder and AsyncAPIClientBuilder

Parameters:

maxConnPerRoute - the max number of connections per route

Returns:

this

generateBuildHosts

protected List<String> generateBuildHosts()

generateQueryHosts

protected List<String> generateQueryHosts()

generateHeaders

protected Map<String,String> generateHeaders()