Class ClientTlsStrategyBuilder

java.lang.Object

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

public class ClientTlsStrategyBuilder
extends Object

Builder for client TLS strategy 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 buildAsync() or buildClassic().

• 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 HostnameVerificationPolicy	hostnameVerificationPolicy
private HostnameVerifier	hostnameVerifier
private org.apache.hc.core5.reactor.ssl.SSLBufferMode	sslBufferMode
private SSLContext	sslContext
private boolean	systemProperties
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()	Deprecated. Use buildAsync() or buildClassic().
org.apache.hc.core5.http.nio.ssl.TlsStrategy	buildAsync()
TlsSocketStrategy	buildClassic()
private DefaultClientTlsStrategy	buildImpl()
static ClientTlsStrategyBuilder	create()
final ClientTlsStrategyBuilder	setCiphers(String... ciphers)	Sets enabled ciphers.
void	setHostnameVerificationPolicy(HostnameVerificationPolicy hostnameVerificationPolicy)	Deprecated. Use #setHostVerificationPolicy
ClientTlsStrategyBuilder	setHostnameVerifier(HostnameVerifier hostnameVerifier)	Sets HostnameVerifier instance.
ClientTlsStrategyBuilder	setHostVerificationPolicy(HostnameVerificationPolicy hostnameVerificationPolicy)	Sets HostnameVerificationPolicy value.
ClientTlsStrategyBuilder	setSslBufferMode(org.apache.hc.core5.reactor.ssl.SSLBufferMode sslBufferMode)	Sets SSLBufferMode value.
ClientTlsStrategyBuilder	setSslContext(SSLContext sslContext)	Sets 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)	Sets enabled TLS versions.
final ClientTlsStrategyBuilder	setTlsVersions(org.apache.hc.core5.http.ssl.TLS... tlslVersions)	Sets enabled TLS versions.
final ClientTlsStrategyBuilder	useSystemProperties()	Use system properties when creating and configuring default implementations.

Methods inherited from class 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

hostnameVerificationPolicy

private HostnameVerificationPolicy hostnameVerificationPolicy

hostnameVerifier

private HostnameVerifier hostnameVerifier

systemProperties

private boolean systemProperties

Constructor Details

ClientTlsStrategyBuilder

public ClientTlsStrategyBuilder()

Method Details

create

public static ClientTlsStrategyBuilder create()

setSslContext

public ClientTlsStrategyBuilder setSslContext(SSLContext sslContext)

Sets SSLContext instance.

Returns:

this instance.

setTlsVersions

public final ClientTlsStrategyBuilder setTlsVersions(String... tlslVersions)

Sets enabled TLS versions.

Returns:

this instance.

setTlsVersions

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

Sets enabled TLS versions.

Returns:

this instance.

setCiphers

public final ClientTlsStrategyBuilder setCiphers(String... ciphers)

Sets enabled ciphers.

Returns:

this instance.

setSslBufferMode

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

Sets SSLBufferMode value.

Returns:

this instance.

setHostnameVerificationPolicy

@Deprecated
public void setHostnameVerificationPolicy(HostnameVerificationPolicy hostnameVerificationPolicy)

Deprecated.

Use #setHostVerificationPolicy

Sets HostnameVerificationPolicy value.

setHostVerificationPolicy

public ClientTlsStrategyBuilder setHostVerificationPolicy(HostnameVerificationPolicy hostnameVerificationPolicy)

Sets HostnameVerificationPolicy value.

Since:

5.5

setHostnameVerifier

public ClientTlsStrategyBuilder setHostnameVerifier(HostnameVerifier hostnameVerifier)

Sets HostnameVerifier instance.

Returns:

this 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. This method has no effect.

Sets TlsDetails Factory instance.

Returns:

this instance.

useSystemProperties

public final ClientTlsStrategyBuilder useSystemProperties()

Use system properties when creating and configuring default implementations.

Returns:

this instance.

build

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

Deprecated.

Use buildAsync() or buildClassic().

buildAsync

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

Since:

5.5

buildClassic

public TlsSocketStrategy buildClassic()

Since:

5.5

buildImpl

private DefaultClientTlsStrategy buildImpl()