io.searchbox.client.config

Class HttpClientConfig.Builder

java.lang.Object

io.searchbox.client.config.ClientConfig.AbstractBuilder<HttpClientConfig,HttpClientConfig.Builder>

io.searchbox.client.config.HttpClientConfig.Builder

Enclosing class:

HttpClientConfig

public static class HttpClientConfig.Builder
extends ClientConfig.AbstractBuilder<HttpClientConfig,HttpClientConfig.Builder>

Field Summary

Fields inherited from class io.searchbox.client.config.ClientConfig.AbstractBuilder

connTimeout, defaultSchemeForDiscoveredNodes, discoveryFilter, discoveryFrequency, discoveryFrequencyTimeUnit, gson, isDiscoveryEnabled, isMultiThreaded, isRequestCompressionEnabled, maxConnectionIdleTime, maxConnectionIdleTimeDurationTimeUnit, readTimeout, serverList

Constructor Summary

Constructors

Constructor and Description
HttpClientConfig.Builder(Collection<String> serverUris)
HttpClientConfig.Builder(HttpClientConfig httpClientConfig)
HttpClientConfig.Builder(String serverUri)

Method Summary

Methods

Modifier and Type	Method and Description
HttpClientConfig	build()
HttpClientConfig.Builder	credentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider) Set a custom instance of an implementation of CredentialsProvider.
HttpClientConfig.Builder	defaultCredentials(String username, String password)
HttpClientConfig.Builder	defaultMaxTotalConnectionPerRoute(int defaultMaxTotalConnectionPerRoute)
HttpClientConfig.Builder	httpIOSessionStrategy(org.apache.http.nio.conn.SchemeIOSessionStrategy httpIOSessionStrategy) Sets the socket factory that will be used by async client for HTTP scheme.
HttpClientConfig.Builder	httpsIOSessionStrategy(org.apache.http.nio.conn.SchemeIOSessionStrategy httpsIOSessionStrategy) Sets the socket factory that will be used by async client for HTTPS scheme.
HttpClientConfig.Builder	maxTotalConnection(int maxTotalConnection)
HttpClientConfig.Builder	maxTotalConnectionPerRoute(org.apache.http.conn.routing.HttpRoute httpRoute, int maxTotalConnection)
HttpClientConfig.Builder	maxTotalConnectionPerRoute(Map<org.apache.http.conn.routing.HttpRoute,Integer> maxTotalConnectionPerRoute)
HttpClientConfig.Builder	plainSocketFactory(org.apache.http.conn.socket.ConnectionSocketFactory socketFactory) Sets the socket factory that will be used by sync client for HTTPS scheme.
HttpClientConfig.Builder	preemptiveAuthTargetHosts(Set<org.apache.http.HttpHost> preemptiveAuthTargetHosts) Sets preemptive authentication for the specified set of target hosts by pre-populating an authentication data cache.
HttpClientConfig.Builder	proxy(org.apache.http.HttpHost proxy)
HttpClientConfig.Builder	proxy(org.apache.http.HttpHost proxy, org.apache.http.client.AuthenticationStrategy proxyAuthenticationStrategy)
HttpClientConfig.Builder	setPreemptiveAuth(org.apache.http.HttpHost targetHost) Sets preemptive authentication for the specified target host by pre-populating an authentication data cache.
HttpClientConfig.Builder	sslSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory socketFactory) Sets the socket factory that will be used by sync client for HTTP scheme.

Methods inherited from class io.searchbox.client.config.ClientConfig.AbstractBuilder

addServer, addServer, connTimeout, defaultSchemeForDiscoveredNodes, discoveryEnabled, discoveryFilter, discoveryFrequency, gson, maxConnectionIdleTime, multiThreaded, readTimeout, requestCompressionEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientConfig.Builder

public HttpClientConfig.Builder(HttpClientConfig httpClientConfig)

HttpClientConfig.Builder

public HttpClientConfig.Builder(Collection<String> serverUris)

HttpClientConfig.Builder

public HttpClientConfig.Builder(String serverUri)

Method Detail

maxTotalConnection

public HttpClientConfig.Builder maxTotalConnection(int maxTotalConnection)

Overrides:

maxTotalConnection in class ClientConfig.AbstractBuilder<HttpClientConfig,HttpClientConfig.Builder>

defaultMaxTotalConnectionPerRoute

public HttpClientConfig.Builder defaultMaxTotalConnectionPerRoute(int defaultMaxTotalConnectionPerRoute)

Overrides:

defaultMaxTotalConnectionPerRoute in class ClientConfig.AbstractBuilder<HttpClientConfig,HttpClientConfig.Builder>

maxTotalConnectionPerRoute

public HttpClientConfig.Builder maxTotalConnectionPerRoute(Map<org.apache.http.conn.routing.HttpRoute,Integer> maxTotalConnectionPerRoute)

maxTotalConnectionPerRoute

public HttpClientConfig.Builder maxTotalConnectionPerRoute(org.apache.http.conn.routing.HttpRoute httpRoute,
                                                  int maxTotalConnection)

credentialsProvider

public HttpClientConfig.Builder credentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider)

Set a custom instance of an implementation of CredentialsProvider. This method will override any previous credential setting (including defaultCredentials) on this builder instance.

defaultCredentials

public HttpClientConfig.Builder defaultCredentials(String username,
                                          String password)

sslSocketFactory

public HttpClientConfig.Builder sslSocketFactory(org.apache.http.conn.socket.LayeredConnectionSocketFactory socketFactory)

Sets the socket factory that will be used by sync client for HTTP scheme.

SSLConnectionSocketFactory.getSocketFactory() is used by default.

A bad example of trust-all socket factory creation can be done as below:

 // trust ALL certificates
 SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() {
     public boolean isTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {
         return true;
     }
 }).build();

 // skip hostname checks
 HostnameVerifier hostnameVerifier = NoopHostnameVerifier.INSTANCE;

 SSLConnectionSocketFactory sslSocketFactory = new SSLConnectionSocketFactory(sslContext, hostnameVerifier);
 

Parameters:

socketFactory - socket factory instance that will be registered for https scheme.

See Also:

SSLConnectionSocketFactory

plainSocketFactory

public HttpClientConfig.Builder plainSocketFactory(org.apache.http.conn.socket.ConnectionSocketFactory socketFactory)

Sets the socket factory that will be used by sync client for HTTPS scheme.

PlainConnectionSocketFactory.getSocketFactory() is used by default.

Parameters:

socketFactory - socket factory instance that will be registered for http scheme.

See Also:

PlainConnectionSocketFactory

httpIOSessionStrategy

public HttpClientConfig.Builder httpIOSessionStrategy(org.apache.http.nio.conn.SchemeIOSessionStrategy httpIOSessionStrategy)

Sets the socket factory that will be used by async client for HTTP scheme.

NoopIOSessionStrategy.INSTANCE is used by default.

Parameters:

httpIOSessionStrategy - SchemeIOSessionStrategy instance that will be registered for http scheme.

See Also:

NoopIOSessionStrategy

httpsIOSessionStrategy

public HttpClientConfig.Builder httpsIOSessionStrategy(org.apache.http.nio.conn.SchemeIOSessionStrategy httpsIOSessionStrategy)

Sets the socket factory that will be used by async client for HTTPS scheme.

SSLIOSessionStrategy.getSystemDefaultStrategy() is used by default.

Parameters:

httpsIOSessionStrategy - SchemeIOSessionStrategy instance that will be registered for https scheme.

See Also:

SSLIOSessionStrategy

setPreemptiveAuth

public HttpClientConfig.Builder setPreemptiveAuth(org.apache.http.HttpHost targetHost)

Sets preemptive authentication for the specified target host by pre-populating an authentication data cache.

It is mandatory to set a credentials provider to use preemptive authentication.

If preemptive authentication is set without setting a credentials provider an exception will be thrown.

preemptiveAuthTargetHosts

public HttpClientConfig.Builder preemptiveAuthTargetHosts(Set<org.apache.http.HttpHost> preemptiveAuthTargetHosts)

Sets preemptive authentication for the specified set of target hosts by pre-populating an authentication data cache.

It is mandatory to set a credentials provider to use preemptive authentication.

If preemptive authentication is set without setting a credentials provider an exception will be thrown.

Parameters:

preemptiveAuthTargetHosts - set of hosts targeted for preemptive authentication

proxy

public HttpClientConfig.Builder proxy(org.apache.http.HttpHost proxy)

proxy

public HttpClientConfig.Builder proxy(org.apache.http.HttpHost proxy,
                             org.apache.http.client.AuthenticationStrategy proxyAuthenticationStrategy)

build

public HttpClientConfig build()

Specified by:

build in class ClientConfig.AbstractBuilder<HttpClientConfig,HttpClientConfig.Builder>