Class WebSocketServerProtocolHandshakeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandshakeHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

class WebSocketServerProtocolHandshakeHandler
extends ChannelInboundHandlerAdapter

Handles the HTTP handshake (the HTTP Upgrade request) for WebSocketServerProtocolHandler.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private ChannelHandlerContext	ctx
private ChannelPromise	handshakePromise
private boolean	isWebSocketPath
private final WebSocketServerProtocolConfig	serverConfig

Constructor Summary

Constructors

Constructor	Description
WebSocketServerProtocolHandshakeHandler(WebSocketServerProtocolConfig serverConfig)

Method Summary

Modifier and Type	Method	Description
private void	applyHandshakeTimeout()
private static boolean	areOriginsAllowed(HttpRequest req, java.lang.CharSequence headerName, java.util.Set<java.lang.String> allowedOrigins)
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
private boolean	checkNextUri(java.lang.String uri, java.lang.String websocketPath)
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
private boolean	isOriginAllowed(HttpRequest req)
private boolean	isWebSocketPath(HttpRequest req)
private static void	sendForbiddenResponse(ChannelHandlerContext ctx)

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface ChannelHandler

handlerRemoved

Field Details

serverConfig

private final WebSocketServerProtocolConfig serverConfig

ctx

private ChannelHandlerContext ctx

handshakePromise

private ChannelPromise handshakePromise

isWebSocketPath

private boolean isWebSocketPath

Constructor Details

WebSocketServerProtocolHandshakeHandler

WebSocketServerProtocolHandshakeHandler(WebSocketServerProtocolConfig serverConfig)

Method Details

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)

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

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

isOriginAllowed

private boolean isOriginAllowed(HttpRequest req)

areOriginsAllowed

private static boolean areOriginsAllowed(HttpRequest req,
 java.lang.CharSequence headerName,
 java.util.Set<java.lang.String> allowedOrigins)

sendForbiddenResponse

private static void sendForbiddenResponse(ChannelHandlerContext ctx)

isWebSocketPath

private boolean isWebSocketPath(HttpRequest req)

checkNextUri

private boolean checkNextUri(java.lang.String uri,
 java.lang.String websocketPath)

applyHandshakeTimeout

private void applyHandshakeTimeout()