SniHandler (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder
    - - io.netty.handler.ssl.AbstractSniHandler<SslContext>
      - io.netty.handler.ssl.SniHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
public class SniHandler
extends AbstractSniHandler<SslContext>
```
为服务器端SSL启用SNI (Server Name Indication)扩展。对于支持SNI的客户端，服务器可以在单个IP上绑定多个主机名。客户端将在握手数据中发送主机名，以便服务器可以决定为主机名选择哪个证书。

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 and Description
`protected AsyncMapping<java.lang.String,SslContext>`	`mapping`

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造方法摘要

构造方法
Constructor and Description
`SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping)` 创建一个SNI检测处理程序，配置`SslContext`，由`AsyncMapping`维护
`SniHandler(DomainNameMapping<? extends SslContext> mapping)` 创建一个由`DomainNameMapping`维护的配置`SslContext`的SNI检测处理程序
`SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping)` 创建一个由`Mapping`维护的配置`SslContext`的SNI检测处理程序

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`java.lang.String`	`hostname()`
`protected Future<SslContext>`	`lookup(ChannelHandlerContext ctx, java.lang.String hostname)` 默认实现只会调用 `AsyncMapping.map(Object, Promise)`，但用户可以重写此方法来实现自定义行为。
`protected void`	`onLookupComplete(ChannelHandlerContext ctx, java.lang.String hostname, Future<SslContext> future)` 在`AbstractSniHandler.lookup(ChannelHandlerContext, String)` `Future`完成时调用。
`protected void`	`replaceHandler(ChannelHandlerContext ctx, java.lang.String hostname, SslContext sslContext)` 此方法的默认实现将只需更换`this` `SniHandler`用实例`SslHandler` 。
`SslContext`	`sslContext()`

Methods inherited from class io.netty.handler.ssl.AbstractSniHandler
bind, close, connect, decode, deregister, disconnect, flush, read, write

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
exceptionCaught, handlerAdded, handlerRemoved

- 字段详细信息
  - mapping
```
protected final AsyncMapping<java.lang.String,SslContext> mapping
```
- 构造方法详细信息
  - SniHandler
```
public SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping)
```
    创建一个SNI检测处理程序，其配置SslContext由Mapping维护
    
    参数
    
    mapping - 域名映射到SslContext
  - SniHandler
```
public SniHandler(DomainNameMapping<? extends SslContext> mapping)
```
    创建一个由DomainNameMapping维护的配置SslContext的SNI检测处理程序
    
    参数
    
    mapping - 域名映射到SslContext
  - SniHandler
```
public SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping)
```
    创建一个由AsyncMapping维护的配置SslContext的SNI检测处理程序
    
    参数
    
    mapping - 域名映射到SslContext
- 方法详细信息
  - hostname
```
public java.lang.String hostname()
```
    结果
    
    所选主机名
  - sslContext
```
public SslContext sslContext()
```
    结果
    
    选中SslContext
  - lookup
```
protected Future<SslContext> lookup(ChannelHandlerContext ctx,
                                    java.lang.String hostname)
                             throws java.lang.Exception
```
    默认实现将简单地调用 AsyncMapping.map(Object, Promise)，但用户可以重写此方法来实现自定义行为。
    
    Specified by:
    
    lookup在课堂 AbstractSniHandler<SslContext>
    
    异常
    
    java.lang.Exception
    
    另请参见：
    
    AsyncMapping.map(Object, Promise)
  - onLookupComplete
```
protected final void onLookupComplete(ChannelHandlerContext ctx,
                                      java.lang.String hostname,
                                      Future<SslContext> future)
                               throws java.lang.Exception
```
    从类复制的描述： AbstractSniHandler
    
    在AbstractSniHandler.lookup(ChannelHandlerContext, String) Future完成时调用。
    
    Specified by:
    
    onLookupComplete在课堂 AbstractSniHandler<SslContext>
    
    异常
    
    java.lang.Exception
    
    另请参见：
    
    AbstractSniHandler.lookup(ChannelHandlerContext, String)
  - replaceHandler
```
protected void replaceHandler(ChannelHandlerContext ctx,
                              java.lang.String hostname,
                              SslContext sslContext)
                       throws java.lang.Exception
```
    此方法的默认实现将只需更换this SniHandler用实例SslHandler 。用户可以重写此方法来实现自定义行为。请注意，在客户端断开连接后，可能会调用此方法，并且在覆盖此方法时，自定义实现必须考虑此方法。主机名参数也可以是null 。
    
    异常
    
    java.lang.Exception

Class SniHandler

Nested Class Summary

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

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

Field Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.ssl.AbstractSniHandler

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

字段详细信息

mapping

构造方法详细信息

SniHandler

SniHandler

SniHandler

方法详细信息

hostname

sslContext

lookup

onLookupComplete

replaceHandler