Package org.glassfish.grizzly.websockets

Class BaseWebSocketFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.websockets.BaseWebSocketFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

WebSocketClientFilter, WebSocketFilter

public abstract class BaseWebSocketFilter
extends BaseFilter

WebSocket Filter implementation, which supposed to be placed into a FilterChain right after HTTP Filter: HttpServerFilter, HttpClientFilter; depending whether it's server or client side. The BaseWebSocketFilter handles websocket connection, handshake phases and, when receives a websocket frame - redirects it to appropriate connection (WebSocketApplication, WebSocket) for processing.

Author:

Alexey Stashok

Constructor Summary

Constructors

Constructor	Description
BaseWebSocketFilter()	Constructs a new BaseWebSocketFilter with a default idle connection timeout of 15 minutes;
BaseWebSocketFilter(long wsTimeoutInSeconds)	Constructs a new BaseWebSocketFilter with a default idle connection timeout of 15 minutes;

Method Summary

Modifier and Type	Method	Description
NextAction	handleClose(FilterChainContext ctx)	Method handles Grizzly Connection close phase.
protected abstract NextAction	handleHandshake(FilterChainContext ctx, HttpContent content)	Handle websocket handshake
NextAction	handleRead(FilterChainContext ctx)	Handle Grizzly Connection read phase.
NextAction	handleWrite(FilterChainContext ctx)	Handle Grizzly Connection write phase.
protected void	onHandshakeFailure(Connection connection, HandshakeException e)	The method is called when WebSocket handshake fails for the Connection.
protected void	setIdleTimeout(FilterChainContext ctx)
protected static boolean	webSocketInProgress(Connection connection)

Methods inherited from class org.glassfish.grizzly.filterchain.BaseFilter

createContext, exceptionOccurred, handleAccept, handleConnect, handleEvent, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Constructor Details

BaseWebSocketFilter

public BaseWebSocketFilter()

Constructs a new BaseWebSocketFilter with a default idle connection timeout of 15 minutes;

BaseWebSocketFilter

public BaseWebSocketFilter(long wsTimeoutInSeconds)

Constructs a new BaseWebSocketFilter with a default idle connection timeout of 15 minutes;

Method Details

handleClose

public NextAction handleClose(FilterChainContext ctx)
                       throws IOException

Method handles Grizzly Connection close phase. Check if the Connection is a WebSocket, if yes - tries to close the websocket gracefully (sending close frame) and calls WebSocket.onClose(DataFrame). If the Grizzly Connection is not websocket - passes processing to the next filter in the chain.

Specified by:

handleClose in interface Filter

Overrides:

handleClose in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleRead

public NextAction handleRead(FilterChainContext ctx)
                      throws IOException

Handle Grizzly Connection read phase. If the Connection has associated WebSocket object (websocket connection), we check if websocket handshake has been completed for this connection, if not - initiate/validate handshake. If handshake has been completed - parse websocket DataFrames one by one and pass processing to appropriate WebSocket: WebSocketApplication for server- and client- side connections.

Specified by:

handleRead in interface Filter

Overrides:

handleRead in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleWrite

public NextAction handleWrite(FilterChainContext ctx)
                       throws IOException

Handle Grizzly Connection write phase. If the Connection has associated WebSocket object (websocket connection), we assume that message is websocket DataFrame and serialize it into a Buffer.

Specified by:

handleWrite in interface Filter

Overrides:

handleWrite in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleHandshake

protected abstract NextAction handleHandshake(FilterChainContext ctx,
 HttpContent content)
                                       throws IOException

Handle websocket handshake

Parameters:

ctx - FilterChainContext

content - HTTP message

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

onHandshakeFailure

protected void onHandshakeFailure(Connection connection,
 HandshakeException e)

The method is called when WebSocket handshake fails for the Connection.

Parameters:

connection -

e -

webSocketInProgress

protected static boolean webSocketInProgress(Connection connection)

setIdleTimeout

protected void setIdleTimeout(FilterChainContext ctx)