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
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
FieldsFields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
decode
(ChannelHandlerContext context, ByteBuf in, List<Object> out) Decode the from oneByteBuf
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
Optionally specify the non-SSL handler name, this method may returnnull
.protected SslHandler
newSslHandler
(ChannelHandlerContext context, SslContext sslContext) Override to configure the SslHandler eg.protected String
Optionally specify the SSL handler name, this method may returnnull
.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
-
-
Constructor Details
-
OptionalSslHandler
-
-
Method Details
-
decode
Description copied from class:ByteToMessageDecoder
Decode the from oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
context
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
Exception
- is thrown if an error occurs
-
handleSsl
-
handleNonSsl
-
newSslHandlerName
Optionally specify the SSL handler name, this method may returnnull
.- Returns:
- the name of the SSL handler.
-
newSslHandler
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 theSslContext.newHandler(ByteBufAllocator, String, int)
variant.- Parameters:
context
- theChannelHandlerContext
to use.sslContext
- theSSLContext
to use.- Returns:
- the
SslHandler
which will replace theOptionalSslHandler
in the pipeline if the traffic is SSL.
-
newNonSslHandlerName
Optionally specify the non-SSL handler name, this method may returnnull
.- Returns:
- the name of the non-SSL handler.
-
newNonSslHandler
Override to configure the ChannelHandler.- Parameters:
context
- theChannelHandlerContext
to use.- Returns:
- the
ChannelHandler
which will replace theOptionalSslHandler
in the pipeline ornull
to simply remove theOptionalSslHandler
if the traffic is non-SSL.
-