org.glassfish.tyrus.websockets

Class WebSocketEngine

java.lang.Object

org.glassfish.tyrus.websockets.WebSocketEngine

public class WebSocketEngine
extends Object

WebSockets engine implementation (singleton), which handles WebSocketApplications registration, responsible for client and server handshake validation.

Author:

Alexey Stashok

See Also:

WebSocket, WebSocketApplication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketEngine.WebSocketHolder WebSocketHolder object, which gets associated with the Grizzly Connection.
static class	WebSocketEngine.WebSocketHolderListener WebSocketEngine.WebSocketHolder listener.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION
static Version	DEFAULT_VERSION
static String	HOST
static int	MASK_SIZE
static String	ORIGIN_HEADER
static String	RESPONSE_CODE_MESSAGE
static int	RESPONSE_CODE_VALUE
static String	SEC_WS_ACCEPT
static String	SEC_WS_EXTENSIONS_HEADER
static String	SEC_WS_KEY_HEADER
static String	SEC_WS_ORIGIN_HEADER
static String	SEC_WS_PROTOCOL_HEADER
static String	SEC_WS_VERSION
static String	SERVER_KEY_HASH
static String	UPGRADE
static String	WEBSOCKET

Method Summary

Methods

Modifier and Type	Method and Description
static WebSocketEngine	getEngine()
WebSocket	getWebSocket(Connection connection) Get the WebSocket associated with the Grizzly Connection, or null, if there none is associated.
WebSocketEngine.WebSocketHolder	getWebSocketHolder(Connection connection)
void	register(WebSocketApplication app) Registers the specified WebSocketApplication with the WebSocketEngine.
void	removeConnection(Connection connection)
WebSocketEngine.WebSocketHolder	setWebSocketHolder(Connection connection, ProtocolHandler handler, WebSocketRequest request, WebSocket socket, WebSocketApplication application)
static byte[]	toArray(long length)
static long	toLong(byte[] bytes, int start, int end)
static List<String>	toString(byte[] bytes)
void	unregister(WebSocketApplication app) Un-registers the specified WebSocketApplication with the WebSocketEngine.
void	unregisterAll() Un-registers all WebSocketApplication instances with the WebSocketEngine.
boolean	upgrade(Connection connection, WebSocketRequest request) Evaluate whether connection/request is suitable for upgrade and perform it.
boolean	upgrade(Connection connection, WebSocketRequest request, WebSocketEngine.WebSocketHolderListener webSocketHolderListener) Evaluate whether connection/request is suitable for upgrade and perform it.
boolean	webSocketInProgress(Connection connection) Returns true if passed Grizzly Connection is associated with a WebSocket, or false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

SEC_WS_ACCEPT

public static final String SEC_WS_ACCEPT

See Also:

Constant Field Values

SEC_WS_KEY_HEADER

public static final String SEC_WS_KEY_HEADER

See Also:

Constant Field Values

SEC_WS_ORIGIN_HEADER

public static final String SEC_WS_ORIGIN_HEADER

See Also:

Constant Field Values

ORIGIN_HEADER

public static final String ORIGIN_HEADER

See Also:

Constant Field Values

SEC_WS_PROTOCOL_HEADER

public static final String SEC_WS_PROTOCOL_HEADER

See Also:

Constant Field Values

SEC_WS_EXTENSIONS_HEADER

public static final String SEC_WS_EXTENSIONS_HEADER

See Also:

Constant Field Values

SEC_WS_VERSION

public static final String SEC_WS_VERSION

See Also:

Constant Field Values

WEBSOCKET

public static final String WEBSOCKET

See Also:

Constant Field Values

RESPONSE_CODE_MESSAGE

public static final String RESPONSE_CODE_MESSAGE

See Also:

Constant Field Values

RESPONSE_CODE_VALUE

public static final int RESPONSE_CODE_VALUE

See Also:

Constant Field Values

UPGRADE

public static final String UPGRADE

See Also:

Constant Field Values

CONNECTION

public static final String CONNECTION

See Also:

Constant Field Values

HOST

public static final String HOST

See Also:

Constant Field Values

DEFAULT_VERSION

public static final Version DEFAULT_VERSION

SERVER_KEY_HASH

public static final String SERVER_KEY_HASH

See Also:

Constant Field Values

MASK_SIZE

public static final int MASK_SIZE

See Also:

Constant Field Values

Method Detail

getEngine

public static WebSocketEngine getEngine()

toArray

public static byte[] toArray(long length)

toLong

public static long toLong(byte[] bytes,
          int start,
          int end)

toString

public static List<String> toString(byte[] bytes)

upgrade

public boolean upgrade(Connection connection,
              WebSocketRequest request)
                throws IOException

Evaluate whether connection/request is suitable for upgrade and perform it.

Parameters:

connection - connection.

request - request.

Returns:

true if upgrade is performed, false otherwise.

Throws:

IOException - if an I/O error occurred during the upgrade.

upgrade

public boolean upgrade(Connection connection,
              WebSocketRequest request,
              WebSocketEngine.WebSocketHolderListener webSocketHolderListener)
                throws HandshakeException

Evaluate whether connection/request is suitable for upgrade and perform it.

Parameters:

connection - connection.

request - request.

webSocketHolderListener - called when upgrade is going to be performed. Additinally, leaves WebSocket.onConnect() call responsibility to WebSocketEngine.WebSocketHolderListener instance.

Returns:

true if upgrade is performed, false otherwise.

Throws:

HandshakeException - if an error occurred during the upgrade.

register

public void register(WebSocketApplication app)
              throws javax.websocket.DeploymentException

Registers the specified WebSocketApplication with the WebSocketEngine.

Parameters:

app - the WebSocketApplication to register.

Throws:

javax.websocket.DeploymentException - when added applications responds to same path as some already registered application.

unregister

public void unregister(WebSocketApplication app)

Un-registers the specified WebSocketApplication with the WebSocketEngine.

Parameters:

app - the WebSocketApplication to un-register.

unregisterAll

public void unregisterAll()

Un-registers all WebSocketApplication instances with the WebSocketEngine.

webSocketInProgress

public boolean webSocketInProgress(Connection connection)

Returns true if passed Grizzly Connection is associated with a WebSocket, or false otherwise.

Parameters:

connection - Grizzly Connection.

Returns:

true if passed Grizzly Connection is associated with a WebSocket, or false otherwise.

getWebSocket

public WebSocket getWebSocket(Connection connection)

Get the WebSocket associated with the Grizzly Connection, or null, if there none is associated.

Parameters:

connection - Grizzly Connection.

Returns:

the WebSocket associated with the Grizzly Connection, or null, if there none is associated.

getWebSocketHolder

public WebSocketEngine.WebSocketHolder getWebSocketHolder(Connection connection)

setWebSocketHolder

public WebSocketEngine.WebSocketHolder setWebSocketHolder(Connection connection,
                                                 ProtocolHandler handler,
                                                 WebSocketRequest request,
                                                 WebSocket socket,
                                                 WebSocketApplication application)

removeConnection

public void removeConnection(Connection connection)