Package io.netty.handler.ssl

Class ApplicationProtocolNegotiationHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.ssl.ApplicationProtocolNegotiationHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public abstract class ApplicationProtocolNegotiationHandler
extends ChannelInboundHandlerAdapter

Configures a ChannelPipeline depending on the application-level protocol negotiation result of SslHandler. For example, you could configure your HTTP pipeline depending on the result of ALPN:

 public class MyInitializer extends ChannelInitializer<Channel> {
     private final SslContext sslCtx;

     public MyInitializer(SslContext sslCtx) {
         this.sslCtx = sslCtx;
     }

     protected void initChannel(Channel ch) {
         ChannelPipeline p = ch.pipeline();
         p.addLast(sslCtx.newHandler(...)); // Adds SslHandler
         p.addLast(new MyNegotiationHandler());
     }
 }

 public class MyNegotiationHandler extends ApplicationProtocolNegotiationHandler {
     public MyNegotiationHandler() {
         super(ApplicationProtocolNames.HTTP_1_1);
     }

     protected void configurePipeline(ChannelHandlerContext ctx, String protocol) {
         if (ApplicationProtocolNames.HTTP_2.equals(protocol) {
             configureHttp2(ctx);
         } else if (ApplicationProtocolNames.HTTP_1_1.equals(protocol)) {
             configureHttp1(ctx);
         } else {
             throw new IllegalStateException("unknown protocol: " + protocol);
         }
     }
 }
 

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ApplicationProtocolNegotiationHandler(java.lang.String fallbackProtocol)	Creates a new instance with the specified fallback protocol name.

Method Summary

Modifier and Type	Method	Description
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected abstract void	configurePipeline(ChannelHandlerContext ctx, java.lang.String protocol)	Invoked on successful initial SSL/TLS handshake.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected void	handshakeFailure(ChannelHandlerContext ctx, java.lang.Throwable cause)	Invoked on failed initial SSL/TLS handshake.
void	userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationProtocolNegotiationHandler

protected ApplicationProtocolNegotiationHandler(java.lang.String fallbackProtocol)

Creates a new instance with the specified fallback protocol name.

Parameters:

fallbackProtocol - the name of the protocol to use when ALPN/NPN negotiation fails or the client does not support ALPN/NPN

Method Detail

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.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:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

Description copied from class: ChannelHandlerAdapter

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

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

java.lang.Exception

channelRead

public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

userEventTriggered

public void userEventTriggered(ChannelHandlerContext ctx,
                               java.lang.Object evt)
                        throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

userEventTriggered in interface ChannelInboundHandler

Overrides:

userEventTriggered in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

configurePipeline

protected abstract void configurePipeline(ChannelHandlerContext ctx,
                                          java.lang.String protocol)
                                   throws java.lang.Exception

Invoked on successful initial SSL/TLS handshake. Implement this method to configure your pipeline for the negotiated application-level protocol.

Parameters:

protocol - the name of the negotiated application-level protocol, or the fallback protocol name specified in the constructor call if negotiation failed or the client isn't aware of ALPN/NPN extension

Throws:

java.lang.Exception

handshakeFailure

protected void handshakeFailure(ChannelHandlerContext ctx,
                                java.lang.Throwable cause)
                         throws java.lang.Exception

Invoked on failed initial SSL/TLS handshake.

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

exceptionCaught in interface ChannelHandler

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception