io.undertow.websockets.core.protocol

Class Handshake

java.lang.Object

io.undertow.websockets.core.protocol.Handshake

Direct Known Subclasses:

Hybi00Handshake, Hybi07Handshake

public abstract class Handshake
extends Object

Abstract base class for doing a WebSocket Handshake.

Author:

Mike Brock

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	subprotocols

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Handshake(WebSocketVersion version, String hashAlgorithm, String magicNumber, Set<String> subprotocols)

Method Summary

Methods

Modifier and Type	Method and Description
abstract WebSocketChannel	createChannel(WebSocketHttpExchange exchange, org.xnio.StreamConnection channel, org.xnio.Pool<ByteBuffer> pool) Create the WebSocketChannel from the HttpServerExchange
String	getHashAlgorithm() Return the algorithm that is used to hash during the handshake
String	getMagicNumber() Return the magic number which will be mixed in
WebSocketVersion	getVersion() Return the version for which the Handshake can be used.
protected static String	getWebSocketLocation(WebSocketHttpExchange exchange) Return the full url of the websocket location of the given HttpServerExchange
void	handshake(WebSocketHttpExchange exchange, WebSocketConnectionCallback callback) Issue the WebSocket upgrade
protected abstract void	handshakeInternal(WebSocketHttpExchange exchange)
abstract boolean	matches(WebSocketHttpExchange exchange) Return true if this implementation can be used to issue a handshake.
protected void	performUpgrade(WebSocketHttpExchange exchange) Perform the upgrade using no payload
protected void	performUpgrade(WebSocketHttpExchange exchange, byte[] data) convenience method to perform the upgrade
protected void	selectSubprotocol(WebSocketHttpExchange exchange) Selects the first matching supported sub protocol and add it the the headers of the exchange.
protected String	supportedSubprotols(String[] requestedSubprotocolArray)
protected void	upgradeChannel(WebSocketHttpExchange exchange, byte[] data)

Methods inherited from class java.lang.Object

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

Field Detail

subprotocols

protected final Set<String> subprotocols

Constructor Detail

Handshake

protected Handshake(WebSocketVersion version,
         String hashAlgorithm,
         String magicNumber,
         Set<String> subprotocols)

Method Detail

getVersion

public WebSocketVersion getVersion()

Return the version for which the Handshake can be used.

getHashAlgorithm

public String getHashAlgorithm()

Return the algorithm that is used to hash during the handshake

getMagicNumber

public String getMagicNumber()

Return the magic number which will be mixed in

getWebSocketLocation

protected static String getWebSocketLocation(WebSocketHttpExchange exchange)

Return the full url of the websocket location of the given HttpServerExchange

handshake

public final void handshake(WebSocketHttpExchange exchange,
             WebSocketConnectionCallback callback)

Issue the WebSocket upgrade

Parameters:

exchange - The HttpServerExchange for which the handshake and upgrade should occur.

callback - The callback to call once the exchange is upgraded

handshakeInternal

protected abstract void handshakeInternal(WebSocketHttpExchange exchange)

matches

public abstract boolean matches(WebSocketHttpExchange exchange)

Return true if this implementation can be used to issue a handshake.

createChannel

public abstract WebSocketChannel createChannel(WebSocketHttpExchange exchange,
                             org.xnio.StreamConnection channel,
                             org.xnio.Pool<ByteBuffer> pool)

Create the WebSocketChannel from the HttpServerExchange

performUpgrade

protected final void performUpgrade(WebSocketHttpExchange exchange,
                  byte[] data)

convenience method to perform the upgrade

upgradeChannel

protected void upgradeChannel(WebSocketHttpExchange exchange,
                  byte[] data)

performUpgrade

protected final void performUpgrade(WebSocketHttpExchange exchange)

Perform the upgrade using no payload

selectSubprotocol

protected final void selectSubprotocol(WebSocketHttpExchange exchange)
                                throws WebSocketHandshakeException

Selects the first matching supported sub protocol and add it the the headers of the exchange.

Throws:

WebSocketHandshakeException - Get thrown if no subprotocol could be found

supportedSubprotols

protected String supportedSubprotols(String[] requestedSubprotocolArray)