com.netphantom.server.ws

Class WebSocketServer

java.lang.Object

com.netphantom.common.websocket.WebSocket

com.netphantom.server.ws.WebSocketServer

public class WebSocketServer
extends WebSocket

The WebSocket Server pure socket implementation, updated for RFC 6455 (The WebSocket Protocol, December 2011).

Original implementation based on "HyBi Working Group, draft-ietf-hybi-thewebsocketprotocol-03, October 17, 2010, by I. Fette, Google Inc." — updated to RFC 6455 in March 2026.

See https://tools.ietf.org/html/rfc6455 for more information.

The WebSocket protocol enables two-way communication between a user agent running untrusted code running in a controlled environment to a remote host that has opted-in to communications from that code. The security model used for this is the Origin-based security model commonly used by Web browsers. The protocol consists of an initial handshake followed by basic message framing, layered over TCP. The goal of this technology is to provide a mechanism for browser-based applications that need two-way communication with servers that does not rely on opening multiple HTTP connections (e.g. using XMLHttpRequest or <iframe>s and long polling).

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from class com.netphantom.common.websocket.WebSocket

WebSocket.State

Field Summary

Fields inherited from class com.netphantom.common.websocket.WebSocket

ACCEPT_GUID, CLOSE_GOING_AWAY, CLOSE_NORMAL, CLOSE_PROTOCOL_ERROR, CRLF, input, isSecure, output, protocolVersion, ssubProtocol, state

Constructor Summary

Constructors

Constructor and Description
WebSocketServer(InputStream input, OutputStream output, boolean isSecure) Establishes the WebSocket connection using streams only (no raw Socket reference).
WebSocketServer(Socket socket, boolean isSecure) Establishes the WebSocket connection using an already connected socket.

Method Summary

Modifier and Type	Method and Description
protected boolean	isServerSide() This is the server side of the WebSocket connection.
void	performHandshake(String resource, Map<String,String> headerFields, List<String> subProtocols, boolean doFailForUnsupportedSubProtocol) Performs the WebSocket server-side handshake per RFC 6455 Section 4.2.

Methods inherited from class com.netphantom.common.websocket.WebSocket

close, closeSocket, closeSocketHard, getBinaryMessage, getOldTextProtocol, getProtocolVersion, getServerSubProtocol, getState, getTextMessage, hasBinaryMessage, hasTextMessage, isVerbose, log, log, readMessage, sendBinaryData, sendBinaryData, sendCloseFrame, sendText, setOldTextProtocol, setProtocolVersion, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketServer

public WebSocketServer(Socket socket,
                       boolean isSecure)
                throws IOException

Establishes the WebSocket connection using an already connected socket. This socket can be SSL or plain. The socket can also have undergone some kind of proxy such as Socks or HTTP before ending up here.

Parameters:

socket - The established socket.

isSecure - If the connection is secure.

Throws:

IOException - For failures.

WebSocketServer

public WebSocketServer(InputStream input,
                       OutputStream output,
                       boolean isSecure)
                throws IOException

Establishes the WebSocket connection using streams only (no raw Socket reference). This constructor is used when the caller has an ISocket adapter and the raw java.net.Socket is not directly accessible.

Parameters:

input - The input stream.

output - The output stream.

isSecure - If the connection is secure.

Throws:

IOException - For failures.

Method Detail

isServerSide

protected boolean isServerSide()

This is the server side of the WebSocket connection.

Specified by:

isServerSide in class WebSocket

performHandshake

public void performHandshake(String resource,
                             Map<String,String> headerFields,
                             List<String> subProtocols,
                             boolean doFailForUnsupportedSubProtocol)
                      throws IOException

Performs the WebSocket server-side handshake per RFC 6455 Section 4.2.

The HTTP request has already been read and parsed by the caller (e.g. HttpRequestParser). This method receives the parsed header fields, validates the WebSocket-specific headers, computes the accept hash, and sends the 101 Switching Protocols response.

RFC 6455 handshake summary:

1. Client sends Sec-WebSocket-Key: (16-byte random nonce, Base64)
2. Server computes SHA-1(key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
3. Server responds with Sec-WebSocket-Accept: (SHA-1 result, Base64)

Parameters:

resource - The URL resource path.

headerFields - The header fields of the HTTP request message (keys must be lowercase).

subProtocols - The list of sub-protocols supported by this server, null for none.

doFailForUnsupportedSubProtocol - Flag indicating a WebSocketException is thrown if the client doesn't request any of our supported protocols.

Throws:

IOException - For failures.

WebSocketException - For exceptions relating to Web Sockets (protocol, etc).