Package io.netty.handler.ssl

Class OptionalSslHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.ssl.OptionalSslHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class OptionalSslHandler
extends ByteToMessageDecoder

OptionalSslHandler is a utility decoder to support both SSL and non-SSL handlers based on the first message received.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final SslContext	sslContext

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
OptionalSslHandler(SslContext sslContext)

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext context, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
private void	handleNonSsl(ChannelHandlerContext context)
private void	handleSsl(ChannelHandlerContext context)
protected ChannelHandler	newNonSslHandler(ChannelHandlerContext context)	Override to configure the ChannelHandler.
protected String	newNonSslHandlerName()	Optionally specify the non-SSL handler name, this method may return null.
protected SslHandler	newSslHandler(ChannelHandlerContext context, SslContext sslContext)	Override to configure the SslHandler eg.
protected String	newSslHandlerName()	Optionally specify the SSL handler name, this method may return null.

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Details

sslContext

private final SslContext sslContext

Constructor Details

OptionalSslHandler

public OptionalSslHandler(SslContext sslContext)

Method Details

decode

protected void decode(ChannelHandlerContext context,
 ByteBuf in,
 List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

context - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

handleSsl

private void handleSsl(ChannelHandlerContext context)

handleNonSsl

private void handleNonSsl(ChannelHandlerContext context)

newSslHandlerName

protected String newSslHandlerName()

Optionally specify the SSL handler name, this method may return null.

Returns:

the name of the SSL handler.

newSslHandler

protected SslHandler newSslHandler(ChannelHandlerContext context,
 SslContext sslContext)

Override to configure the SslHandler eg. SSLParameters.setEndpointIdentificationAlgorithm(String). The hostname and port is not known by this method so servers may want to override this method and use the SslContext.newHandler(ByteBufAllocator, String, int) variant.

Parameters:

context - the ChannelHandlerContext to use.

sslContext - the SSLContext to use.

Returns:

the SslHandler which will replace the OptionalSslHandler in the pipeline if the traffic is SSL.

newNonSslHandlerName

protected String newNonSslHandlerName()

Optionally specify the non-SSL handler name, this method may return null.

Returns:

the name of the non-SSL handler.

newNonSslHandler

protected ChannelHandler newNonSslHandler(ChannelHandlerContext context)

Override to configure the ChannelHandler.

Parameters:

context - the ChannelHandlerContext to use.

Returns:

the ChannelHandler which will replace the OptionalSslHandler in the pipeline or null to simply remove the OptionalSslHandler if the traffic is non-SSL.