Package io.servicetalk.transport.netty.internal

Class NettyPipelineSslUtils

java.lang.Object

io.servicetalk.transport.netty.internal.NettyPipelineSslUtils

public final class NettyPipelineSslUtils
extends Object

Utilities for ChannelPipeline and SSL/TLS.

Method Summary

Modifier and Type	Method	Description
static SSLSession	extractSslSession(io.netty.channel.ChannelPipeline pipeline, io.netty.handler.ssl.SslHandshakeCompletionEvent sslEvent, Consumer<Throwable> failureConsumer)	Extracts the SSLSession from the ChannelPipeline if the SslHandshakeCompletionEvent is successful or propagate the failure to failureConsumer.
static SSLSession	extractSslSession(SslConfig sslConfig, io.netty.channel.ChannelPipeline pipeline)	Extracts the SSLSession from the ChannelPipeline if the handshake is already done.
static SSLSession	extractSslSessionAndReport(io.netty.channel.ChannelPipeline pipeline, io.netty.handler.ssl.SslHandshakeCompletionEvent sslEvent, Consumer<Throwable> failureConsumer, boolean shouldReport)	Deprecated. Use extractSslSession(ChannelPipeline, SslHandshakeCompletionEvent, Consumer) instead, reporting to ConnectionObserver.SecurityHandshakeObserver is handled automatically for all SslHandlers initialized by SslClientChannelInitializer or SslServerChannelInitializer.
static SSLSession	extractSslSessionAndReport(SslConfig sslConfig, io.netty.channel.ChannelPipeline pipeline, ConnectionObserver connectionObserver)	Deprecated. Use extractSslSession(SslConfig, ChannelPipeline) instead, reporting to ConnectionObserver.SecurityHandshakeObserver is handled automatically for all SslHandlers initialized by SslClientChannelInitializer or SslServerChannelInitializer
static boolean	isSslEnabled(io.netty.channel.ChannelPipeline pipeline)	Deprecated. not required anymore, will be removed in the future releases, see extractSslSessionAndReport(SslConfig, ChannelPipeline, ConnectionObserver) for an alternative approach

Methods inherited from class java.lang.Object

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

Method Details

isSslEnabled

@Deprecated
public static boolean isSslEnabled(io.netty.channel.ChannelPipeline pipeline)

Deprecated.

not required anymore, will be removed in the future releases, see extractSslSessionAndReport(SslConfig, ChannelPipeline, ConnectionObserver) for an alternative approach

Determine if the ChannelPipeline is configured for SSL/TLS.

Parameters:

pipeline - The pipeline to check.

Returns:

true if the pipeline is configured to use SSL/TLS.

extractSslSessionAndReport

@Nullable
@Deprecated
public static SSLSession extractSslSessionAndReport(@Nullable
 SslConfig sslConfig,
 io.netty.channel.ChannelPipeline pipeline,
 ConnectionObserver connectionObserver)

Deprecated.

Use extractSslSession(SslConfig, ChannelPipeline) instead, reporting to ConnectionObserver.SecurityHandshakeObserver is handled automatically for all SslHandlers initialized by SslClientChannelInitializer or SslServerChannelInitializer

Extracts the SSLSession from the ChannelPipeline if the handshake is already done and reports the result to ConnectionObserver.SecurityHandshakeObserver if available. If it's done but failed, it rethrows the result.

Parameters:

sslConfig - SslConfig if SSL/TLS is expected

pipeline - ChannelPipeline which contains a handler containing the SSLSession

connectionObserver - ConnectionObserver in case the handshake status should be reported

Returns:

The SSLSession or null if none can be found

Throws:

IllegalStateException - if SslHandler can not be found in the ChannelPipeline

extractSslSession

@Nullable
public static SSLSession extractSslSession(@Nullable
 SslConfig sslConfig,
 io.netty.channel.ChannelPipeline pipeline)

Extracts the SSLSession from the ChannelPipeline if the handshake is already done. If it's done but failed, it rethrows the result.

Parameters:

sslConfig - SslConfig if SSL/TLS is expected

pipeline - ChannelPipeline which contains a handler containing the SSLSession

Returns:

The SSLSession or null if none can be found

Throws:

IllegalStateException - if SslHandler can not be found in the ChannelPipeline

extractSslSessionAndReport

@Nullable
@Deprecated
public static SSLSession extractSslSessionAndReport(io.netty.channel.ChannelPipeline pipeline,
 io.netty.handler.ssl.SslHandshakeCompletionEvent sslEvent,
 Consumer<Throwable> failureConsumer,
 boolean shouldReport)

Deprecated.

Use extractSslSession(ChannelPipeline, SslHandshakeCompletionEvent, Consumer) instead, reporting to ConnectionObserver.SecurityHandshakeObserver is handled automatically for all SslHandlers initialized by SslClientChannelInitializer or SslServerChannelInitializer.

Extracts the SSLSession from the ChannelPipeline if the SslHandshakeCompletionEvent is successful and reports the result to ConnectionObserver.SecurityHandshakeObserver if available.

Parameters:

pipeline - the ChannelPipeline which contains handler containing the SSLSession.

sslEvent - the event indicating a SSL/TLS handshake completed.

failureConsumer - invoked if a failure is encountered.

shouldReport - true if the handshake status should be reported to ConnectionObserver.SecurityHandshakeObserver.

Returns:

The SSLSession or null if none can be found.

extractSslSession

@Nullable
public static SSLSession extractSslSession(io.netty.channel.ChannelPipeline pipeline,
 io.netty.handler.ssl.SslHandshakeCompletionEvent sslEvent,
 Consumer<Throwable> failureConsumer)

Extracts the SSLSession from the ChannelPipeline if the SslHandshakeCompletionEvent is successful or propagate the failure to failureConsumer.

Parameters:

pipeline - the ChannelPipeline which contains handler containing the SSLSession.

sslEvent - the event indicating a SSL/TLS handshake completed.

failureConsumer - invoked if a failure is encountered.

Returns:

The SSLSession or null if none can be found.