Package com.algolia.search

Class ApacheAPIClientBuilder

java.lang.Object

com.algolia.search.GenericAPIClientBuilder

com.algolia.search.APIClientBuilder

com.algolia.search.ApacheAPIClientBuilder

public final class ApacheAPIClientBuilder
extends APIClientBuilder

Field Summary

Fields inherited from class com.algolia.search.GenericAPIClientBuilder

apiKey, applicationId, buildHosts, connectTimeout, customAgent, customAgentVersion, customHeaders, hostDownTimeout, maxConnTotal, objectMapper, queryHosts, random, readTimeout

Constructor Summary

Constructors

Constructor	Description
ApacheAPIClientBuilder(java.lang.String applicationId, java.lang.String apiKey)

Method Summary

Modifier and Type	Method	Description
ApacheAPIClientBuilder	addExtraHeader(java.lang.String key, java.lang.String value)
protected APIClient	build(APIClientConfiguration configuration)
ApacheAPIClientBuilder	setBuildHosts(java.util.List<java.lang.String> buildHosts)
ApacheAPIClientBuilder	setConnectTimeout(int connectTimeout)
ApacheAPIClientBuilder	setDefaultCredentialsProvider(org.apache.http.client.CredentialsProvider defaultCredentialsProvider)	Set the CredentialsProvider for the underlying Apache HTTP Client
ApacheAPIClientBuilder	setExtraHeader(java.lang.String key, java.lang.String value)	Deprecated.
ApacheAPIClientBuilder	setHostDownTimeout(int hostDownTimeout)
ApacheAPIClientBuilder	setMaxConnTotal(int maxConnTotal)
ApacheAPIClientBuilder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
ApacheAPIClientBuilder	setProxy(org.apache.http.HttpHost proxy)	Set the proxy for the underlying Apache HTTP Client
ApacheAPIClientBuilder	setProxyPreferredAuthSchemes(java.util.Collection<java.lang.String> proxyPreferredAuthSchemes)	Set the proxyPreferredAuthSchemes for the underlying Apache HTTP Client
ApacheAPIClientBuilder	setQueryHosts(java.util.List<java.lang.String> queryHosts)
ApacheAPIClientBuilder	setReadTimeout(int readTimeout)
ApacheAPIClientBuilder	setUserAgent(java.lang.String customAgent, java.lang.String customAgentVersion)

Methods inherited from class com.algolia.search.APIClientBuilder

build

Methods inherited from class com.algolia.search.GenericAPIClientBuilder

generateBuildHosts, generateHeaders, generateQueryHosts

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheAPIClientBuilder

public ApacheAPIClientBuilder(@Nonnull
                              java.lang.String applicationId,
                              @Nonnull
                              java.lang.String apiKey)

Method Detail

setUserAgent

public ApacheAPIClientBuilder setUserAgent(@Nonnull
                                           java.lang.String customAgent,
                                           @Nonnull
                                           java.lang.String customAgentVersion)

Overrides:

setUserAgent in class APIClientBuilder

setExtraHeader

@Deprecated
public ApacheAPIClientBuilder setExtraHeader(@Nonnull
                                             java.lang.String key,
                                             java.lang.String value)

Deprecated.

Overrides:

setExtraHeader in class APIClientBuilder

addExtraHeader

public ApacheAPIClientBuilder addExtraHeader(@Nonnull
                                             java.lang.String key,
                                             java.lang.String value)

Overrides:

addExtraHeader in class APIClientBuilder

setConnectTimeout

public ApacheAPIClientBuilder setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class APIClientBuilder

setReadTimeout

public ApacheAPIClientBuilder setReadTimeout(int readTimeout)

Overrides:

setReadTimeout in class APIClientBuilder

setHostDownTimeout

public ApacheAPIClientBuilder setHostDownTimeout(int hostDownTimeout)

Overrides:

setHostDownTimeout in class APIClientBuilder

setObjectMapper

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

Overrides:

setObjectMapper in class APIClientBuilder

setQueryHosts

public ApacheAPIClientBuilder setQueryHosts(java.util.List<java.lang.String> queryHosts)

Overrides:

setQueryHosts in class APIClientBuilder

setBuildHosts

public ApacheAPIClientBuilder setBuildHosts(java.util.List<java.lang.String> buildHosts)

Overrides:

setBuildHosts in class APIClientBuilder

setMaxConnTotal

public ApacheAPIClientBuilder setMaxConnTotal(int maxConnTotal)

Overrides:

setMaxConnTotal in class APIClientBuilder

setProxy

public ApacheAPIClientBuilder setProxy(org.apache.http.HttpHost proxy)

Set the proxy for the underlying Apache HTTP Client

See https://hc.apache.org/httpcomponents-client-ga/examples.html for examples

Parameters:

proxy -

Returns:

this

setProxyPreferredAuthSchemes

public ApacheAPIClientBuilder setProxyPreferredAuthSchemes(java.util.Collection<java.lang.String> proxyPreferredAuthSchemes)

Set the proxyPreferredAuthSchemes for the underlying Apache HTTP Client

See https://hc.apache.org/httpcomponents-client-ga/examples.html for examples

Parameters:

proxyPreferredAuthSchemes -

Returns:

this

setDefaultCredentialsProvider

public ApacheAPIClientBuilder setDefaultCredentialsProvider(org.apache.http.client.CredentialsProvider defaultCredentialsProvider)

Set the CredentialsProvider for the underlying Apache HTTP Client

See https://hc.apache.org/httpcomponents-client-ga/examples.html for examples

Parameters:

defaultCredentialsProvider -

Returns:

this

build

protected APIClient build(@Nonnull
                          APIClientConfiguration configuration)

Specified by:

build in class APIClientBuilder