io.netty.handler.ssl

Class SslClientHelloHandler<T>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractSniHandler

public abstract class SslClientHelloHandler<T>
extends io.netty.handler.codec.ByteToMessageDecoder
implements io.netty.channel.ChannelOutboundHandler

ByteToMessageDecoder which allows to be notified once a full ClientHello was received.

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
static int	MAX_CLIENT_HELLO_LENGTH The maximum length of client hello message as defined by RFC5246.

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	SslClientHelloHandler()
protected	SslClientHelloHandler(int maxClientHelloLength)

Method Summary

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)
protected void	handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
protected abstract io.netty.util.concurrent.Future<T>	lookup(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf clientHello) Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the onLookupComplete(ChannelHandlerContext, Future) on completion.
protected abstract void	onLookupComplete(io.netty.channel.ChannelHandlerContext ctx, io.netty.util.concurrent.Future<T> future) Called upon completion of the lookup(ChannelHandlerContext, ByteBuf) Future.
void	read(io.netty.channel.ChannelHandlerContext ctx)
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, 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

Field Detail

MAX_CLIENT_HELLO_LENGTH

public static final int MAX_CLIENT_HELLO_LENGTH

The maximum length of client hello message as defined by RFC5246.

See Also:

Constant Field Values

Constructor Detail

SslClientHelloHandler

public SslClientHelloHandler()

SslClientHelloHandler

protected SslClientHelloHandler(int maxClientHelloLength)

Method Detail

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

handlerRemoved0

protected void handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

Overrides:

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

Throws:

Exception

lookup

protected abstract io.netty.util.concurrent.Future<T> lookup(io.netty.channel.ChannelHandlerContext ctx,
                                                             io.netty.buffer.ByteBuf clientHello)
                                                      throws Exception

Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the 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_suites<2..2^16-2>;
    CompressionMethod compression_methods<1..2^8-1>;
    select (extensions_present) {
        case false:
            struct {};
        case true:
            Extension extensions<0..2^16-1>;
    };
 } ClientHello;
 

Throws:

Exception

See Also:

onLookupComplete(ChannelHandlerContext, Future)

onLookupComplete

protected abstract void onLookupComplete(io.netty.channel.ChannelHandlerContext ctx,
                                         io.netty.util.concurrent.Future<T> future)
                                  throws Exception

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

Throws:

Exception

See Also:

lookup(ChannelHandlerContext, ByteBuf)

read

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

Specified by:

read in interface io.netty.channel.ChannelOutboundHandler

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

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