Class ApacheHttpTransport.Builder (1.45.3)

public static final class ApacheHttpTransport.Builder

Builder for ApacheHttpTransport.

Implementation is not thread-safe.

Inheritance

java.lang.Object > ApacheHttpTransport.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

build()

public ApacheHttpTransport build()

Returns a new instance of ApacheHttpTransport based on the options.

Returns
Type	Description
`ApacheHttpTransport`

doNotValidateCertificate()

public ApacheHttpTransport.Builder doNotValidateCertificate()

Beta
Disables validating server SSL certificates by setting the SSL socket factory using SslUtils#trustAllSSLContext() for the SSL context and SSLSocketFactory#ALLOW_ALL_HOSTNAME_VERIFIER for the host name verifier.

Be careful! Disabling certificate validation is dangerous and should only be done in testing environments.

Returns
Type	Description
`ApacheHttpTransport.Builder`

Exceptions
Type	Description
`GeneralSecurityException`

getHttpParams()

public HttpParams getHttpParams()

Returns the HTTP parameters.

Returns
Type	Description
`org.apache.http.params.HttpParams`

getSSLSocketFactory()

public SSLSocketFactory getSSLSocketFactory()

Returns the SSL socket factory (SSLSocketFactory#getSocketFactory() by default).

Returns
Type	Description
`org.apache.http.conn.ssl.SSLSocketFactory`

setProxy(HttpHost proxy)

public ApacheHttpTransport.Builder setProxy(HttpHost proxy)

Sets the HTTP proxy to use DefaultHttpRoutePlanner or null to use #setProxySelector(ProxySelector) with ProxySelector#getDefault().

By default it is null, which uses the proxy settings from system properties.

For example:

setProxy(new HttpHost("127.0.0.1", 8080))

Parameter
Name	Description
`proxy`	`org.apache.http.HttpHost`

Returns
Type	Description
`ApacheHttpTransport.Builder`

setProxySelector(ProxySelector proxySelector)

public ApacheHttpTransport.Builder setProxySelector(ProxySelector proxySelector)

Sets the HTTP proxy selector to use ProxySelectorRoutePlanner or null for DefaultHttpRoutePlanner.

By default it is ProxySelector#getDefault() which uses the proxy settings from system properties.

Parameter
Name	Description
`proxySelector`	`ProxySelector`

Returns
Type	Description
`ApacheHttpTransport.Builder`

setSocketFactory(SSLSocketFactory socketFactory)

public ApacheHttpTransport.Builder setSocketFactory(SSLSocketFactory socketFactory)

Sets the SSL socket factory (SSLSocketFactory#getSocketFactory() by default).

Parameter
Name	Description
`socketFactory`	`org.apache.http.conn.ssl.SSLSocketFactory`

Returns
Type	Description
`ApacheHttpTransport.Builder`

trustCertificates(KeyStore trustStore)

public ApacheHttpTransport.Builder trustCertificates(KeyStore trustStore)

Sets the SSL socket factory based on a root certificate trust store.

Parameter
Name	Description
`trustStore`	`KeyStore` certificate trust store (use for example SecurityUtils#loadKeyStore or SecurityUtils#loadKeyStoreFromCertificates)

Returns
Type	Description
`ApacheHttpTransport.Builder`

Exceptions
Type	Description
`GeneralSecurityException`

trustCertificatesFromJavaKeyStore(InputStream keyStoreStream, String storePass)

public ApacheHttpTransport.Builder trustCertificatesFromJavaKeyStore(InputStream keyStoreStream, String storePass)

Sets the SSL socket factory based on root certificates in a Java KeyStore.

Example usage:

trustCertificatesFromJavaKeyStore(new FileInputStream("certs.jks"), "password");

Parameters
Name	Description
`keyStoreStream`	`InputStream` input stream to the key store (closed at the end of this method in a finally block)
`storePass`	`String` password protecting the key store file

Returns
Type	Description
`ApacheHttpTransport.Builder`

Exceptions
Type	Description
`GeneralSecurityException`
`IOException`

trustCertificatesFromStream(InputStream certificateStream)

public ApacheHttpTransport.Builder trustCertificatesFromStream(InputStream certificateStream)

Sets the SSL socket factory based root certificates generated from the specified stream using CertificateFactory#generateCertificates(InputStream).

Example usage:

trustCertificatesFromStream(new FileInputStream("certs.pem"));

Parameter
Name	Description
`certificateStream`	`InputStream` certificate stream

Returns
Type	Description
`ApacheHttpTransport.Builder`

Exceptions
Type	Description
`GeneralSecurityException`
`IOException`