io.netty.handler.ssl

Class SniHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.ssl.SniHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public class SniHandler
extends io.netty.handler.codec.ByteToMessageDecoder
implements io.netty.channel.ChannelOutboundHandler

Enables SNI (Server Name Indication) extension for server side SSL. For clients support SNI, the server could have multiple host name bound on a single IP. The client will send host name in the handshake data so server could decide which certificate to choose for the host name.

Nested Class Summary

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

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.util.AsyncMapping<String,SslContext>	mapping

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(io.netty.util.DomainNameMapping<? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping
SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by Mapping

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(io.netty.channel.ChannelHandlerContext ctx, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
void	deregister(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
String	hostname()
protected io.netty.util.concurrent.Future<SslContext>	lookup(io.netty.channel.ChannelHandlerContext ctx, String hostname) The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.
void	read(io.netty.channel.ChannelHandlerContext ctx)
protected void	replaceHandler(io.netty.channel.ChannelHandlerContext ctx, String hostname, SslContext sslContext) The default implementation of this method will simply replace this SniHandler instance with a SslHandler.
SslContext	sslContext()
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

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

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

exceptionCaught, handlerAdded, handlerRemoved

Field Detail

mapping

protected final io.netty.util.AsyncMapping<String,SslContext> mapping

Constructor Detail

SniHandler

public SniHandler(io.netty.util.Mapping<? super String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by Mapping

Parameters:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(io.netty.util.DomainNameMapping<? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping

Parameters:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(io.netty.util.AsyncMapping<? super String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

Parameters:

mapping - the mapping of domain name to SslContext

Method Detail

hostname

public String hostname()

Returns:

the selected hostname

sslContext

public SslContext sslContext()

Returns:

the selected SslContext

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          List<Object> out)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception

lookup

protected io.netty.util.concurrent.Future<SslContext> lookup(io.netty.channel.ChannelHandlerContext ctx,
                                                 String hostname)
                                                      throws Exception

The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.

Throws:

Exception

See Also:

AsyncMapping.map(Object, Promise)

replaceHandler

protected void replaceHandler(io.netty.channel.ChannelHandlerContext ctx,
                  String hostname,
                  SslContext sslContext)
                       throws Exception

The default implementation of this method will simply replace this SniHandler instance with a SslHandler. Users may override this method to implement custom behavior. Please be aware that this method may get called after a client has already disconnected and custom implementations must take it into consideration when overriding this method. It's also possible for the hostname argument to be null.

Throws:

Exception

bind

public void bind(io.netty.channel.ChannelHandlerContext ctx,
        SocketAddress localAddress,
        io.netty.channel.ChannelPromise promise)
          throws Exception

Specified by:

bind in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

connect

public void connect(io.netty.channel.ChannelHandlerContext ctx,
           SocketAddress remoteAddress,
           SocketAddress localAddress,
           io.netty.channel.ChannelPromise promise)
             throws Exception

Specified by:

connect in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

disconnect

public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

deregister

public void deregister(io.netty.channel.ChannelHandlerContext ctx,
              io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

deregister in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

read

public void read(io.netty.channel.ChannelHandlerContext ctx)
          throws Exception

Specified by:

read in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         Object msg,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx)
           throws Exception

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception