com.gmt2001.httpwsserver.WebSocketFrameHandler

All Implemented Interfaces:: ChannelHandler, ChannelInboundHandler

public class WebSocketFrameHandler extends SimpleChannelInboundHandler<WebSocketFrame>

Processes WebSocket frames and passes successful ones to the appropriate registered final handler

Author:: gmt2001

Nested Class Summary

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

Fields

Modifier and Type

Field

Description

static final AttributeKey<String>

ATTR_ALLOW_NON_SSL

Represents the ATTR_ALLOW_NON_SSL attribute, which stores if the client is allowed to bypass SSL requirements

static final AttributeKey<WsFrameHandler>

ATTR_FRAME_HANDLER

Represents the ATTR_FRAME_HANDLER attribute, which stores the WsFrameHandler that processes frames for this client

static final AttributeKey<String>

ATTR_URI

Represents the ATTR_URI attribute, which stores the URI the client has connected to
Method Summary

Modifier and Type

Method

Description

static void

broadcastWsFrame(WebSocketFrame resframe)

Transmits a WebSocketFrame to all authenticated clients

static void

broadcastWsFrame(String uri, WebSocketFrame resframe)

Transmits a WebSocketFrame to all authenticated clients that are connected to a specific URI

protected void

channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame)

Handles incoming WebSocket frames and passes them to the appropriate WsFrameHandler

static void

deregisterWsHandler(String path)

Deregisters a WS URI path

void

exceptionCaught(ChannelHandlerContext ctx, Throwable cause)

Handles exceptions that are thrown up the stack

static Queue<Channel>

getWsSessions(String uri)

static WebSocketFrame

prepareBinaryWebSocketResponse(byte[] content)

Creates and prepares a binary-type WebSocketFrame for transmission

static WebSocketFrame

prepareCloseWebSocketFrame(int status, String reason)

Creates and prepares a Close WebSocketFrame for transmission

static WebSocketFrame

prepareCloseWebSocketFrame(WebSocketCloseStatus status)

Creates and prepares a Close WebSocketFrame for transmission

static WebSocketFrame

prepareTextWebSocketResponse(String content)

Creates and prepares a text-type WebSocketFrame for transmission

static WebSocketFrame

prepareTextWebSocketResponse(JSONObject json)

Creates and prepares a text-type WebSocketFrame for transmission from a JSONObject

static WebSocketFrame

prepareTextWebSocketResponse(JSONStringer json)

Creates and prepares a text-type WebSocketFrame for transmission from a JSONStringer

static void

registerWsHandler(String path, WsFrameHandler handler)

Registers a WS URI path to a WsFrameHandler

static void

sendWsFrame(ChannelHandlerContext ctx, WebSocketFrame reqframe, WebSocketFrame resframe)

Transmits a WebSocketFrame back to the client

static void

sendWsFrame(Channel ch, WebSocketFrame reqframe, WebSocketFrame resframe)

Transmits a WebSocketFrame back to the client

void

userEventTriggered(ChannelHandlerContext ctx, Object evt)

Captures WebSocketServerProtocolHandler.HandshakeComplete events and saves the WsFrameHandler URI to the session If a handler is not available for the requested path, then 404 NOT FOUND is sent back to the client using JSON:API format

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler
acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, handlerRemoved, 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
handlerAdded, handlerRemoved

Field Details
- ATTR_URI
  
  public static final AttributeKey<String> ATTR_URI
  
  Represents the ATTR_URI attribute, which stores the URI the client has connected to
- ATTR_FRAME_HANDLER
  
  public static final AttributeKey<WsFrameHandler> ATTR_FRAME_HANDLER
  
  Represents the ATTR_FRAME_HANDLER attribute, which stores the WsFrameHandler that processes frames for this client
- ATTR_ALLOW_NON_SSL
  
  public static final AttributeKey<String> ATTR_ALLOW_NON_SSL
  
  Represents the ATTR_ALLOW_NON_SSL attribute, which stores if the client is allowed to bypass SSL requirements
Method Details
- channelRead0
  
  protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame) throws Exception
  
  Handles incoming WebSocket frames and passes them to the appropriate WsFrameHandler
  
  Specified by:
  
  channelRead0 in class SimpleChannelInboundHandler<WebSocketFrame>
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  frame - The WebSocketFrame containing the request frame
  
  Throws:
  
  Exception - Passes any thrown exceptions up the stack
- userEventTriggered
  
  public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception
  
  Captures WebSocketServerProtocolHandler.HandshakeComplete events and saves the WsFrameHandler URI to the session If a handler is not available for the requested path, then 404 NOT FOUND is sent back to the client using JSON:API format
  
  Specified by:
  
  userEventTriggered in interface ChannelInboundHandler
  
  Overrides:
  
  userEventTriggered in class ChannelInboundHandlerAdapter
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  evt - The event object
  
  Throws:
  
  Exception - Passes any thrown exceptions up the stack
- exceptionCaught
  
  public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
  
  Handles exceptions that are thrown up the stack
  
  Specified by:
  
  exceptionCaught in interface ChannelHandler
  
  Specified by:
  
  exceptionCaught in interface ChannelInboundHandler
  
  Overrides:
  
  exceptionCaught in class ChannelInboundHandlerAdapter
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  cause - The exception
- prepareTextWebSocketResponse
  
  public static WebSocketFrame prepareTextWebSocketResponse(String content)
  
  Creates and prepares a text-type WebSocketFrame for transmission
  
  Parameters:
  
  content - The content to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- prepareTextWebSocketResponse
  
  public static WebSocketFrame prepareTextWebSocketResponse(JSONObject json)
  
  Creates and prepares a text-type WebSocketFrame for transmission from a JSONObject
  
  Parameters:
  
  json - The JSONObject to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- prepareTextWebSocketResponse
  
  public static WebSocketFrame prepareTextWebSocketResponse(JSONStringer json)
  
  Creates and prepares a text-type WebSocketFrame for transmission from a JSONStringer
  
  Parameters:
  
  json - The JSONStringer to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- prepareBinaryWebSocketResponse
  
  public static WebSocketFrame prepareBinaryWebSocketResponse(byte[] content)
  
  Creates and prepares a binary-type WebSocketFrame for transmission
  
  Parameters:
  
  content - The binary content to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- prepareCloseWebSocketFrame
  
  public static WebSocketFrame prepareCloseWebSocketFrame(WebSocketCloseStatus status)
  
  Creates and prepares a Close WebSocketFrame for transmission
  
  Parameters:
  
  status - The WebSocketCloseStatus to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- prepareCloseWebSocketFrame
  
  public static WebSocketFrame prepareCloseWebSocketFrame(int status, String reason)
  
  Creates and prepares a Close WebSocketFrame for transmission
  
  Parameters:
  
  status - The close status code to send
  
  reason - The reason string to send
  
  Returns:
  
  A WebSocketFrame that is ready to transmit
- sendWsFrame
  
  public static void sendWsFrame(ChannelHandlerContext ctx, WebSocketFrame reqframe, WebSocketFrame resframe)
  
  Transmits a WebSocketFrame back to the client
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  reqframe - The WebSocketFrame containing the request
  
  resframe - The WebSocketFrame to transmit
- sendWsFrame
  
  public static void sendWsFrame(Channel ch, WebSocketFrame reqframe, WebSocketFrame resframe)
  
  Transmits a WebSocketFrame back to the client
  
  Parameters:
  
  ch - The Channel of the connection
  
  reqframe - The WebSocketFrame containing the request
  
  resframe - The WebSocketFrame to transmit
- broadcastWsFrame
  
  public static void broadcastWsFrame(WebSocketFrame resframe)
  
  Transmits a WebSocketFrame to all authenticated clients
  
  Parameters:
  
  resframe - The WebSocketFrame to transmit
- broadcastWsFrame
  
  public static void broadcastWsFrame(String uri, WebSocketFrame resframe)
  
  Transmits a WebSocketFrame to all authenticated clients that are connected to a specific URI
  
  Parameters:
  
  uri - The URI to filter clients by for the broadcast
  
  resframe - The WebSocketFrame to transmit
- getWsSessions
  
  public static Queue<Channel> getWsSessions(String uri)
- registerWsHandler
  
  public static void registerWsHandler(String path, WsFrameHandler handler)
  
  Registers a WS URI path to a WsFrameHandler
  Parameters:
  
  path - The URI path to bind the handler to
  
  handler - The WsFrameHandler that will handle the requests
  
  Throws:
  
  IllegalArgumentException - If path is either already registered, or illegal
  
  See Also:
  
  validateUriPath
- deregisterWsHandler
  
  public static void deregisterWsHandler(String path)
  
  Deregisters a WS URI path
  
  Parameters:
  
  path - The path to deregister

Class WebSocketFrameHandler

Nested Class Summary

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

Field Summary

Method Summary

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

Field Details

ATTR_URI

ATTR_FRAME_HANDLER

ATTR_ALLOW_NON_SSL

Method Details

channelRead0

userEventTriggered

exceptionCaught

prepareTextWebSocketResponse

prepareTextWebSocketResponse

prepareTextWebSocketResponse

prepareBinaryWebSocketResponse

prepareCloseWebSocketFrame

prepareCloseWebSocketFrame

sendWsFrame

sendWsFrame

broadcastWsFrame

broadcastWsFrame

getWsSessions

registerWsHandler

deregisterWsHandler