Class AbstractSniHandler<T>

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<T>

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

Direct Known Subclasses:

SniHandler

public abstract class AbstractSniHandler<T>
extends SslClientHelloHandler<T>

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 ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Modifier and Type	Class	Description
static interface	ByteToMessageDecoder.Cumulator	Cumulate ByteBufs.

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Field Summary

Fields

Modifier and Type	Field	Description
protected final long	handshakeTimeoutMillis

Fields inherited from class SslClientHelloHandler

MAX_CLIENT_HELLO_LENGTH

Modifier and Type	Field	Description
static final int	MAX_CLIENT_HELLO_LENGTH	The maximum length of client hello message as defined by RFC5246.

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Modifier and Type	Field	Description
static final ByteToMessageDecoder.Cumulator	COMPOSITE_CUMULATOR	Cumulate ByteBufs by add them to a CompositeByteBuf and so do no memory copy whenever possible.
static final ByteToMessageDecoder.Cumulator	MERGE_CUMULATOR	Cumulate ByteBufs by merge them into one ByteBuf's, using memory copies.

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractSniHandler()
protected	AbstractSniHandler(int maxClientHelloLength, long handshakeTimeoutMillis)
protected	AbstractSniHandler(long handshakeTimeoutMillis)

Method Summary

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected Future<T>	lookup(ChannelHandlerContext ctx, ByteBuf clientHello)	Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the SslClientHelloHandler.onLookupComplete(ChannelHandlerContext, Future) on completion.
protected abstract Future<T>	lookup(ChannelHandlerContext ctx, String hostname)	Kicks off a lookup for the given SNI value and returns a Future which in turn will notify the onLookupComplete(ChannelHandlerContext, String, Future) on completion.
protected void	onLookupComplete(ChannelHandlerContext ctx, Future<T> future)	Called upon completion of the SslClientHelloHandler.lookup(ChannelHandlerContext, ByteBuf) Future.
protected abstract void	onLookupComplete(ChannelHandlerContext ctx, String hostname, Future<T> future)	Called upon completion of the lookup(ChannelHandlerContext, String) Future.

Methods inherited from class SslClientHelloHandler

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

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a deregister operation is made from the current registered EventLoop.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a disconnect operation is made.
void	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
protected void	handlerRemoved0(ChannelHandlerContext ctx)	Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Called once a write operation is made.

Methods inherited from class ByteToMessageDecoder

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

Modifier and Type	Method	Description
protected int	actualReadableBytes()	Returns the actual number of readable bytes in the internal cumulative buffer of this decoder.
protected void	callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Called once data should be decoded from the given ByteBuf.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object input)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Is called one last time when the ChannelHandlerContext goes in-active.
protected final void	discardSomeReadBytes()
final void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected ByteBuf	internalBuffer()	Returns the internal cumulative buffer of this decoder.
boolean	isSingleDecode()	If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	setCumulator(ByteToMessageDecoder.Cumulator cumulator)	Set the ByteToMessageDecoder.Cumulator to use for cumulate the received ByteBufs.
void	setDiscardAfterReads(int discardAfterReads)	Set the number of reads after which ByteBuf.discardSomeReadBytes() are called and so free up memory.
void	setSingleDecode(boolean singleDecode)	If set then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Modifier and Type	Method	Description
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Field Details

handshakeTimeoutMillis

protected final long handshakeTimeoutMillis

Constructor Details

AbstractSniHandler

protected AbstractSniHandler(long handshakeTimeoutMillis)

Parameters:

handshakeTimeoutMillis - the handshake timeout in milliseconds

AbstractSniHandler

protected AbstractSniHandler(int maxClientHelloLength,
 long handshakeTimeoutMillis)

Parameters:

maxClientHelloLength - the maximum length of the client hello message.

handshakeTimeoutMillis - the handshake timeout in milliseconds

AbstractSniHandler

public AbstractSniHandler()

Method Details

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

Exception

lookup

protected Future<T> lookup(ChannelHandlerContext ctx,
 ByteBuf clientHello)
                    throws Exception

Description copied from class: SslClientHelloHandler

Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the SslClientHelloHandler.onLookupComplete(ChannelHandlerContext, Future) on completion. See https://tools.ietf.org/html/rfc5246#section-7.4.1.2

struct {
   ProtocolVersion client_version;
   Random random;
   SessionID session_id;
   CipherSuite cipher_suitesinvalid input: '<'2..2^16-2>;
   CompressionMethod compression_methodsinvalid input: '<'1..2^8-1>;
   select (extensions_present) {
       case false:
           struct {};
       case true:
           Extension extensionsinvalid input: '<'0..2^16-1>;
   };
} ClientHello;

Specified by:

lookup in class SslClientHelloHandler<T>

Throws:

Exception

See Also:

• SslClientHelloHandler.onLookupComplete(ChannelHandlerContext, Future)

onLookupComplete

protected void onLookupComplete(ChannelHandlerContext ctx,
 Future<T> future)
                         throws Exception

Description copied from class: SslClientHelloHandler

Called upon completion of the SslClientHelloHandler.lookup(ChannelHandlerContext, ByteBuf) Future.

Specified by:

onLookupComplete in class SslClientHelloHandler<T>

Throws:

Exception

See Also:

• SslClientHelloHandler.lookup(ChannelHandlerContext, ByteBuf)

lookup

protected abstract Future<T> lookup(ChannelHandlerContext ctx,
 String hostname)
                             throws Exception

Kicks off a lookup for the given SNI value and returns a Future which in turn will notify the onLookupComplete(ChannelHandlerContext, String, Future) on completion.

Throws:

Exception

See Also:

• onLookupComplete(ChannelHandlerContext, String, Future)

onLookupComplete

protected abstract void onLookupComplete(ChannelHandlerContext ctx,
 String hostname,
 Future<T> future)
                                  throws Exception

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

Throws:

Exception

See Also:

• lookup(ChannelHandlerContext, String)