Top Description Methods
org.apache.hc.core5.reactor.ssl

public Interface TransportSecurityLayer

Known Direct Subinterfaces
org.apache.hc.core5.reactor.ProtocolIOSession
Imports
javax.net.ssl.SSLContext, org.apache.hc.core5.concurrent.FutureCallback, org.apache.hc.core5.net.NamedEndpoint, org.apache.hc.core5.util.Timeout
TLS capable session layer interface.
Since
5.0

Method Summary

Modifier and TypeMethod and Description
public TlsDetails

Returns:

TLS session details.
getTlsDetails()

Returns details of a fully established TLS session.

public void
startTls(SSLContext
SSL context to be used for this session.
sslContext, NamedEndpoint
optional endpoint details for outgoing client side connections.
endpoint, SSLBufferMode
SSL buffer management mode.
sslBufferMode, SSLSessionInitializer
SSL session initialization callback.
initializer, SSLSessionVerifier
SSL session verification callback.
verifier, Timeout
the timeout to use while performing the TLS handshake; may be null.
handshakeTimeout)

Starts TLS session over an existing network connection with the given SSL context.

public default void
startTls(SSLContext
SSL context to be used for this session.
sslContext, NamedEndpoint
optional endpoint details for outgoing client side connections.
endpoint, SSLBufferMode
SSL buffer management mode.
sslBufferMode, SSLSessionInitializer
SSL session initialization callback.
initializer, SSLSessionVerifier
SSL session verification callback.
verifier, Timeout
the timeout to use while performing the TLS handshake; may be null.
handshakeTimeout, FutureCallback<TransportSecurityLayer> callback)

Starts TLS session over an existing network connection with the given SSL context.

Method Detail

getTlsDetailsback to summary
public TlsDetails getTlsDetails()

Returns details of a fully established TLS session.

Returns:TlsDetails

TLS session details.

startTlsback to summary
public void startTls(SSLContext sslContext, NamedEndpoint endpoint, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Timeout handshakeTimeout) throws UnsupportedOperationException

Starts TLS session over an existing network connection with the given SSL context. NamedEndpoint details are applicable for client side connections and are used for host name verification, when supported by the SSL engine.

Parameters
sslContext:SSLContext

SSL context to be used for this session.

endpoint:NamedEndpoint

optional endpoint details for outgoing client side connections.

sslBufferMode:SSLBufferMode

SSL buffer management mode.

initializer:SSLSessionInitializer

SSL session initialization callback.

verifier:SSLSessionVerifier

SSL session verification callback.

handshakeTimeout:Timeout

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

startTlsback to summary
public default void startTls(SSLContext sslContext, NamedEndpoint endpoint, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Timeout handshakeTimeout, FutureCallback<TransportSecurityLayer> callback) throws UnsupportedOperationException

Starts TLS session over an existing network connection with the given SSL context. NamedEndpoint details are applicable for client side connections and are used for host name verification, when supported by the SSL engine.

Parameters
sslContext:SSLContext

SSL context to be used for this session.

endpoint:NamedEndpoint

optional endpoint details for outgoing client side connections.

sslBufferMode:SSLBufferMode

SSL buffer management mode.

initializer:SSLSessionInitializer

SSL session initialization callback.

verifier:SSLSessionVerifier

SSL session verification callback.

handshakeTimeout:Timeout

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

Since
5.2