Package org.apache.hc.client5.http.ssl

Class ClientTlsStrategyBuilder

java.lang.Object

org.apache.hc.client5.http.ssl.ClientTlsStrategyBuilder

public class ClientTlsStrategyBuilder
extends Object

Builder for client TlsStrategy instances.

When a particular component is not explicitly set this class will use its default implementation. System properties will be taken into account when configuring the default implementations when useSystemProperties() method is called prior to calling build().

• ssl.TrustManagerFactory.algorithm
• javax.net.ssl.trustStoreType
• javax.net.ssl.trustStore
• javax.net.ssl.trustStoreProvider
• javax.net.ssl.trustStorePassword
• ssl.KeyManagerFactory.algorithm
• javax.net.ssl.keyStoreType
• javax.net.ssl.keyStore
• javax.net.ssl.keyStoreProvider
• javax.net.ssl.keyStorePassword
• https.protocols
• https.cipherSuites

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private String[]	ciphers
private HostnameVerifier	hostnameVerifier
private org.apache.hc.core5.reactor.ssl.SSLBufferMode	sslBufferMode
private SSLContext	sslContext
private boolean	systemProperties
private org.apache.hc.core5.function.Factory<SSLEngine,org.apache.hc.core5.reactor.ssl.TlsDetails>	tlsDetailsFactory	Deprecated. To be removed.
private String[]	tlsVersions

Constructor Summary

Constructors

Constructor	Description
ClientTlsStrategyBuilder()

Method Summary

Modifier and Type	Method	Description
org.apache.hc.core5.http.nio.ssl.TlsStrategy	build()
static ClientTlsStrategyBuilder	create()
final ClientTlsStrategyBuilder	setCiphers(String... ciphers)	Assigns enabled ciphers.
ClientTlsStrategyBuilder	setHostnameVerifier(HostnameVerifier hostnameVerifier)	Assigns HostnameVerifier instance.
ClientTlsStrategyBuilder	setSslBufferMode(org.apache.hc.core5.reactor.ssl.SSLBufferMode sslBufferMode)	Assigns SSLBufferMode value.
ClientTlsStrategyBuilder	setSslContext(SSLContext sslContext)	Assigns SSLContext instance.
ClientTlsStrategyBuilder	setTlsDetailsFactory(org.apache.hc.core5.function.Factory<SSLEngine,org.apache.hc.core5.reactor.ssl.TlsDetails> tlsDetailsFactory)	Deprecated. Do not use.
final ClientTlsStrategyBuilder	setTlsVersions(String... tlslVersions)	Assigns enabled TLS versions.
final ClientTlsStrategyBuilder	setTlsVersions(org.apache.hc.core5.http.ssl.TLS... tlslVersions)	Assigns enabled TLS versions.
final ClientTlsStrategyBuilder	useSystemProperties()	Use system properties when creating and configuring default implementations.

Methods inherited from class java.lang.Object

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

Field Details

sslContext

private SSLContext sslContext

tlsVersions

private String[] tlsVersions

ciphers

private String[] ciphers

sslBufferMode

private org.apache.hc.core5.reactor.ssl.SSLBufferMode sslBufferMode

hostnameVerifier

private HostnameVerifier hostnameVerifier

tlsDetailsFactory

@Deprecated
private org.apache.hc.core5.function.Factory<SSLEngine,org.apache.hc.core5.reactor.ssl.TlsDetails> tlsDetailsFactory

Deprecated.

To be removed.

systemProperties

private boolean systemProperties

Constructor Details

ClientTlsStrategyBuilder

public ClientTlsStrategyBuilder()

Method Details

create

public static ClientTlsStrategyBuilder create()

setSslContext

public ClientTlsStrategyBuilder setSslContext(SSLContext sslContext)

Assigns SSLContext instance.

setTlsVersions

public final ClientTlsStrategyBuilder setTlsVersions(String... tlslVersions)

Assigns enabled TLS versions.

setTlsVersions

public final ClientTlsStrategyBuilder setTlsVersions(org.apache.hc.core5.http.ssl.TLS... tlslVersions)

Assigns enabled TLS versions.

setCiphers

public final ClientTlsStrategyBuilder setCiphers(String... ciphers)

Assigns enabled ciphers.

setSslBufferMode

public ClientTlsStrategyBuilder setSslBufferMode(org.apache.hc.core5.reactor.ssl.SSLBufferMode sslBufferMode)

Assigns SSLBufferMode value.

setHostnameVerifier

public ClientTlsStrategyBuilder setHostnameVerifier(HostnameVerifier hostnameVerifier)

Assigns HostnameVerifier instance.

setTlsDetailsFactory

@Deprecated
public ClientTlsStrategyBuilder setTlsDetailsFactory(org.apache.hc.core5.function.Factory<SSLEngine,org.apache.hc.core5.reactor.ssl.TlsDetails> tlsDetailsFactory)

Deprecated.

Do not use.

Assigns TlsDetails Factory instance.

useSystemProperties

public final ClientTlsStrategyBuilder useSystemProperties()

Use system properties when creating and configuring default implementations.

build

public org.apache.hc.core5.http.nio.ssl.TlsStrategy build()