org.apache.hc.core5.http.nio.ssl

Class BasicClientTlsStrategy

java.lang.Object

org.apache.hc.core5.http.nio.ssl.BasicClientTlsStrategy

All Implemented Interfaces:

TlsStrategy

public class BasicClientTlsStrategy
extends Object
implements TlsStrategy

Basic client-side implementation of TlsStrategy that upgrades to TLS for all endpoints with HTTPS scheme.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
BasicClientTlsStrategy()
BasicClientTlsStrategy(SSLContext sslContext)
BasicClientTlsStrategy(SSLContext sslContext, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier)
BasicClientTlsStrategy(SSLContext sslContext, SSLSessionInitializer initializer, SSLSessionVerifier verifier)
BasicClientTlsStrategy(SSLContext sslContext, SSLSessionVerifier verifier)
BasicClientTlsStrategy(SSLSessionVerifier verifier) Constructor with the default SSL context based on system properties and custom SSLSessionVerifier verifier.

Method Summary

Modifier and Type	Method and Description
boolean	upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout) Deprecated. use upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)
void	upgrade(TransportSecurityLayer tlsSession, NamedEndpoint endpoint, Object attachment, Timeout handshakeTimeout, FutureCallback<TransportSecurityLayer> callback) Secures current session layer with TLS.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicClientTlsStrategy

public BasicClientTlsStrategy(SSLContext sslContext,
                              SSLBufferMode sslBufferMode,
                              SSLSessionInitializer initializer,
                              SSLSessionVerifier verifier)

BasicClientTlsStrategy

public BasicClientTlsStrategy(SSLContext sslContext,
                              SSLSessionInitializer initializer,
                              SSLSessionVerifier verifier)

BasicClientTlsStrategy

public BasicClientTlsStrategy(SSLContext sslContext,
                              SSLSessionVerifier verifier)

BasicClientTlsStrategy

public BasicClientTlsStrategy(SSLContext sslContext)

BasicClientTlsStrategy

public BasicClientTlsStrategy()

BasicClientTlsStrategy

public BasicClientTlsStrategy(SSLSessionVerifier verifier)

Constructor with the default SSL context based on system properties and custom SSLSessionVerifier verifier.

Parameters:

verifier - the custom SSLSessionVerifier.

Since:

5.2

See Also:

SSLContext

Method Detail

upgrade

public void upgrade(TransportSecurityLayer tlsSession,
                    NamedEndpoint endpoint,
                    Object attachment,
                    Timeout handshakeTimeout,
                    FutureCallback<TransportSecurityLayer> callback)

Description copied from interface: TlsStrategy

Secures current session layer with TLS.

Specified by:

upgrade in interface TlsStrategy

Parameters:

tlsSession - the session layer

endpoint - the name of the opposite endpoint when applicable or null otherwise.

attachment - arbitrary object passes to the TLS session initialization code.

handshakeTimeout - the timeout to use while performing the TLS handshake; may be null.

callback - Operation result callback.

upgrade

@Deprecated
public boolean upgrade(TransportSecurityLayer tlsSession,
                                   HttpHost host,
                                   SocketAddress localAddress,
                                   SocketAddress remoteAddress,
                                   Object attachment,
                                   Timeout handshakeTimeout)

Deprecated. use upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)

Description copied from interface: TlsStrategy

Secures current session layer with TLS.

Specified by:

upgrade in interface TlsStrategy

Parameters:

tlsSession - the session layer

host - the name of the opposite endpoint when given or null otherwise.

localAddress - the address of the local endpoint.

remoteAddress - the address of the remote endpoint.

attachment - arbitrary object passes to the TLS session initialization code.

handshakeTimeout - the timeout to use while performing the TLS handshake; may be null.

Returns:

true if the session has been upgraded, false otherwise.