Class NetHttpTransport.Builder

java.lang.Object

com.google.api.client.http.javanet.NetHttpTransport.Builder

Enclosing class:

NetHttpTransport

public static final class NetHttpTransport.Builder
extends Object

Builder for NetHttpTransport.

Implementation is not thread-safe.

Since:

1.13

Field Summary

Fields

Modifier and Type	Field	Description
private ConnectionFactory	connectionFactory	ConnectionFactory or null to use a DefaultConnectionFactory.
private HostnameVerifier	hostnameVerifier	Host name verifier or null for the default.
private boolean	isMtls	Whether the transport is mTLS.
private Proxy	proxy	HTTP proxy or null to use the proxy settings from system properties.
private SSLSocketFactory	sslSocketFactory	SSL socket factory or null for the default.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetHttpTransport	build()	Returns a new instance of NetHttpTransport based on the options.
NetHttpTransport.Builder	doNotValidateCertificate()	Beta Disables validating server SSL certificates by setting the SSL socket factory using SslUtils.trustAllSSLContext() for the SSL context and SslUtils.trustAllHostnameVerifier() for the host name verifier.
HostnameVerifier	getHostnameVerifier()	Returns the host name verifier or null for the default.
SSLSocketFactory	getSslSocketFactory()	Returns the SSL socket factory.
NetHttpTransport.Builder	setConnectionFactory(ConnectionFactory connectionFactory)	Sets the ConnectionFactory or null to use a DefaultConnectionFactory.
NetHttpTransport.Builder	setHostnameVerifier(HostnameVerifier hostnameVerifier)	Sets the host name verifier or null for the default.
NetHttpTransport.Builder	setProxy(Proxy proxy)	Sets the HTTP proxy or null to use the proxy settings from system properties.
NetHttpTransport.Builder	setSslSocketFactory(SSLSocketFactory sslSocketFactory)	Sets the SSL socket factory or null for the default.
NetHttpTransport.Builder	trustCertificates(KeyStore trustStore)	Sets the SSL socket factory based on a root certificate trust store.
NetHttpTransport.Builder	trustCertificates(KeyStore trustStore, KeyStore mtlsKeyStore, String mtlsKeyStorePassword)	Beta Sets the SSL socket factory based on a root certificate trust store and a client certificate key store.
NetHttpTransport.Builder	trustCertificatesFromJavaKeyStore(InputStream keyStoreStream, String storePass)	Sets the SSL socket factory based on root certificates in a Java KeyStore.
NetHttpTransport.Builder	trustCertificatesFromStream(InputStream certificateStream)	Sets the SSL socket factory based root certificates generated from the specified stream using CertificateFactory.generateCertificates(InputStream).

Methods inherited from class Object

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

Field Details

sslSocketFactory

private SSLSocketFactory sslSocketFactory

SSL socket factory or null for the default.

hostnameVerifier

private HostnameVerifier hostnameVerifier

Host name verifier or null for the default.

proxy

private Proxy proxy

HTTP proxy or null to use the proxy settings from system properties.

connectionFactory

private ConnectionFactory connectionFactory

ConnectionFactory or null to use a DefaultConnectionFactory. This value is only used if proxy is unset.

isMtls

private boolean isMtls

Whether the transport is mTLS. Default value is false.

Constructor Details

Builder

public Builder()

Method Details

setProxy

public NetHttpTransport.Builder setProxy(Proxy proxy)

Sets the HTTP proxy or null to use the proxy settings from system properties.

For example:

setProxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 8080)))

setConnectionFactory

public NetHttpTransport.Builder setConnectionFactory(ConnectionFactory connectionFactory)

Sets the ConnectionFactory or null to use a DefaultConnectionFactory. This value is ignored if the setProxy(Proxy) has been called with a non-null value.

If you wish to use a Proxy, it should be included in your ConnectionFactory implementation.

Since:

1.20

trustCertificatesFromJavaKeyStore

public NetHttpTransport.Builder trustCertificatesFromJavaKeyStore(InputStream keyStoreStream,
 String storePass)
                                                           throws GeneralSecurityException,
IOException

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

Example usage:

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

Parameters:

keyStoreStream - input stream to the key store (closed at the end of this method in a finally block)

storePass - password protecting the key store file

Throws:

GeneralSecurityException

IOException

Since:

1.14

trustCertificatesFromStream

public NetHttpTransport.Builder trustCertificatesFromStream(InputStream certificateStream)
                                                     throws GeneralSecurityException,
IOException

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

Example usage:

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

Parameters:

certificateStream - certificate stream

Throws:

GeneralSecurityException

IOException

Since:

1.14

trustCertificates

public NetHttpTransport.Builder trustCertificates(KeyStore trustStore)
                                           throws GeneralSecurityException

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

Parameters:

trustStore - certificate trust store (use for example SecurityUtils.loadKeyStore(KeyStore, InputStream, String) or SecurityUtils.loadKeyStoreFromCertificates(KeyStore, CertificateFactory, InputStream))

Throws:

GeneralSecurityException

Since:

1.14

trustCertificates

@Beta
public NetHttpTransport.Builder trustCertificates(KeyStore trustStore,
 KeyStore mtlsKeyStore,
 String mtlsKeyStorePassword)
                                           throws GeneralSecurityException

Beta
Sets the SSL socket factory based on a root certificate trust store and a client certificate key store. The client certificate key store will be used to establish mutual TLS.

Parameters:

trustStore - certificate trust store (use for example SecurityUtils.loadKeyStore(KeyStore, InputStream, String) or SecurityUtils.loadKeyStoreFromCertificates(KeyStore, CertificateFactory, InputStream))

mtlsKeyStore - key store for client certificate and key to establish mutual TLS. (use for example SecurityUtils.createMtlsKeyStore(InputStream))

mtlsKeyStorePassword - password for mtlsKeyStore parameter

Throws:

GeneralSecurityException

Since:

1.38

doNotValidateCertificate

@Beta
public NetHttpTransport.Builder doNotValidateCertificate()
                                                  throws GeneralSecurityException

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

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

Throws:

GeneralSecurityException

getSslSocketFactory

public SSLSocketFactory getSslSocketFactory()

Returns the SSL socket factory.

setSslSocketFactory

public NetHttpTransport.Builder setSslSocketFactory(SSLSocketFactory sslSocketFactory)

Sets the SSL socket factory or null for the default.

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

Returns the host name verifier or null for the default.

setHostnameVerifier

public NetHttpTransport.Builder setHostnameVerifier(HostnameVerifier hostnameVerifier)

Sets the host name verifier or null for the default.

build

public NetHttpTransport build()

Returns a new instance of NetHttpTransport based on the options.