io.netty.handler.ssl

类 SniHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.ssl.SslClientHelloHandler<T>

io.netty.handler.ssl.AbstractSniHandler<SslContext>

io.netty.handler.ssl.SniHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class SniHandler
extends AbstractSniHandler<SslContext>

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.

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
protected AsyncMapping<java.lang.String,SslContext>	mapping

从类继承的字段 io.netty.handler.ssl.AbstractSniHandler

handshakeTimeoutMillis

从类继承的字段 io.netty.handler.ssl.SslClientHelloHandler

MAX_CLIENT_HELLO_LENGTH

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器

构造器和说明
SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping, int maxClientHelloLength, long handshakeTimeoutMillis) Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping, long handshakeTimeoutMillis) Creates a SNI detection handler with configured SslContext maintained by AsyncMapping
SniHandler(DomainNameMapping<? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping
SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping) Creates a SNI detection handler with configured SslContext maintained by Mapping
SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping, int maxClientHelloLength, long handshakeTimeoutMillis) Creates a SNI detection handler with configured SslContext maintained by Mapping
SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping, long handshakeTimeoutMillis) Creates a SNI detection handler with configured SslContext maintained by Mapping

方法概要

限定符和类型	方法和说明
java.lang.String	hostname()
protected Future<SslContext>	lookup(ChannelHandlerContext ctx, java.lang.String hostname) The default implementation will simply call AsyncMapping.map(Object, Promise) but users can override this method to implement custom behavior.
protected SslHandler	newSslHandler(SslContext context, ByteBufAllocator allocator) Returns a new SslHandler using the given SslContext and ByteBufAllocator.
protected void	onLookupComplete(ChannelHandlerContext ctx, java.lang.String hostname, Future<SslContext> future) Called upon completion of the AbstractSniHandler.lookup(ChannelHandlerContext, String) Future.
protected void	replaceHandler(ChannelHandlerContext ctx, java.lang.String hostname, SslContext sslContext) The default implementation of this method will simply replace this SniHandler instance with a SslHandler.
SslContext	sslContext()

从类继承的方法 io.netty.handler.ssl.AbstractSniHandler

channelActive, handlerAdded, lookup, onLookupComplete

从类继承的方法 io.netty.handler.ssl.SslClientHelloHandler

bind, close, connect, decode, deregister, disconnect, flush, handlerRemoved0, read, write

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

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

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerRemoved

字段详细资料

mapping

protected final AsyncMapping<java.lang.String,SslContext> mapping

构造器详细资料

SniHandler

public SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by Mapping

参数:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping,
                  int maxClientHelloLength,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by Mapping

参数:

mapping - the mapping of domain name to SslContext

maxClientHelloLength - the maximum length of the client hello message

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(DomainNameMapping<? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by DomainNameMapping

参数:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

参数:

mapping - the mapping of domain name to SslContext

SniHandler

public SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping,
                  int maxClientHelloLength,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

参数:

mapping - the mapping of domain name to SslContext

maxClientHelloLength - the maximum length of the client hello message

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(Mapping<? super java.lang.String,? extends SslContext> mapping,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by Mapping

参数:

mapping - the mapping of domain name to SslContext

handshakeTimeoutMillis - the handshake timeout in milliseconds

SniHandler

public SniHandler(AsyncMapping<? super java.lang.String,? extends SslContext> mapping,
                  long handshakeTimeoutMillis)

Creates a SNI detection handler with configured SslContext maintained by AsyncMapping

参数:

mapping - the mapping of domain name to SslContext

handshakeTimeoutMillis - the handshake timeout in milliseconds

方法详细资料

hostname

public java.lang.String hostname()

返回:

the selected hostname

sslContext

public SslContext sslContext()

返回:

the selected SslContext

lookup

protected Future<SslContext> lookup(ChannelHandlerContext ctx,
                                    java.lang.String hostname)
                             throws java.lang.Exception

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

指定者:

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

Called upon completion of the AbstractSniHandler.lookup(ChannelHandlerContext, String) Future.

指定者:

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

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.

抛出:

java.lang.Exception

newSslHandler

protected SslHandler newSslHandler(SslContext context,
                                   ByteBufAllocator allocator)

Returns a new SslHandler using the given SslContext and ByteBufAllocator. Users may override this method to implement custom behavior.