public static final class ApacheHttpTransport.BuilderConstructors
Builder()
public Builder()Methods
build()
public ApacheHttpTransport build()Returns a new instance of ApacheHttpTransport based on the options.
| 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.
| Type | Description |
ApacheHttpTransport.Builder |
| Type | Description |
GeneralSecurityException |
getHttpParams()
public HttpParams getHttpParams()Returns the HTTP parameters.
| Type | Description |
org.apache.http.params.HttpParams |
getSSLSocketFactory()
public SSLSocketFactory getSSLSocketFactory()Returns the SSL socket factory (SSLSocketFactory#getSocketFactory() by default).
| 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))
| Name | Description |
proxy | org.apache.http.HttpHost |
| 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.
| Name | Description |
proxySelector | ProxySelector |
| Type | Description |
ApacheHttpTransport.Builder |
setSocketFactory(SSLSocketFactory socketFactory)
public ApacheHttpTransport.Builder setSocketFactory(SSLSocketFactory socketFactory)Sets the SSL socket factory (SSLSocketFactory#getSocketFactory() by default).
| Name | Description |
socketFactory | org.apache.http.conn.ssl.SSLSocketFactory |
| 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.
| Name | Description |
trustStore | KeyStorecertificate trust store (use for example SecurityUtils#loadKeyStore or SecurityUtils#loadKeyStoreFromCertificates) |
| Type | Description |
ApacheHttpTransport.Builder |
| 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");
| Name | Description |
keyStoreStream | InputStreaminput stream to the key store (closed at the end of this method in a finally block) |
storePass | Stringpassword protecting the key store file |
| Type | Description |
ApacheHttpTransport.Builder |
| 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"));
| Name | Description |
certificateStream | InputStreamcertificate stream |
| Type | Description |
ApacheHttpTransport.Builder |
| Type | Description |
GeneralSecurityException | |
IOException |