org.jwebsocket.kit

Class WebSocketHandshake

java.lang.Object

org.jwebsocket.kit.WebSocketHandshake

public final class WebSocketHandshake
extends Object

Utility class for all the handshaking related request/response.

Version:

$Id:$

Author:

aschulze

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_HEADER_SIZE

Constructor Summary

Constructors

Constructor and Description
WebSocketHandshake(int aVersion, URI aURI, String aProtocol)

Method Summary

Methods

Modifier and Type	Method and Description
static String	calcHybiSecKeyAccept(String aKey)
byte[]	generateC2SRequest()
byte[]	generateC2SRequest(List<HttpCookie> aCookies) Generates the initial Handshake from a Java Client to the WebSocket Server.
static byte[]	generateS2CResponse(Map aRequest) Generates the response for the server to answer an initial client request.
static Map	parseC2SRequest(byte[] aReq, boolean aIsSSL) Parses the response from the client on an initial client's handshake request.
static Map	parseS2CResponse(byte[] aResp)
static byte[]	readS2CResponse(InputStream aIS) Reads the handshake response from the server into an byte array.
void	verifyServerHandshakeHeaders(Map<String,String> aHeaders)
void	verifyServerResponse(Headers aHeaders)
void	verifyServerStatusLine(String aStatusLine)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HEADER_SIZE

public static int MAX_HEADER_SIZE

Constructor Detail

WebSocketHandshake

public WebSocketHandshake(int aVersion,
                  URI aURI,
                  String aProtocol)
                   throws WebSocketException

Parameters:

aURI -

aProtocol -

aVersion -

Throws:

WebSocketException

Method Detail

calcHybiSecKeyAccept

public static String calcHybiSecKeyAccept(String aKey)

parseC2SRequest

public static Map parseC2SRequest(byte[] aReq,
                  boolean aIsSSL)

Parses the response from the client on an initial client's handshake request. This is always performed on the server only when a client - irrespective of if it is a Java Client or Browser Client - initiates a connection.

Parameters:

aReq -

aIsSSL -

Returns:

generateS2CResponse

public static byte[] generateS2CResponse(Map aRequest)

Generates the response for the server to answer an initial client request. This is performed on the server only as an answer to a client's request - irrespective of if it is a Java or Browser Client.

Parameters:

aRequest -

Returns:

readS2CResponse

public static byte[] readS2CResponse(InputStream aIS)

Reads the handshake response from the server into an byte array. This is used on clients only. The browser clients implement that internally.

Parameters:

aIS -

Returns:

parseS2CResponse

public static Map parseS2CResponse(byte[] aResp)

Parameters:

aResp -

Returns:

generateC2SRequest

public byte[] generateC2SRequest(List<HttpCookie> aCookies)

Generates the initial Handshake from a Java Client to the WebSocket Server.

Returns:

generateC2SRequest

public byte[] generateC2SRequest()

verifyServerResponse

public void verifyServerResponse(Headers aHeaders)
                          throws WebSocketException

Parameters:

aBytes -

Throws:

WebSocketException

verifyServerStatusLine

public void verifyServerStatusLine(String aStatusLine)
                            throws WebSocketException

Parameters:

aStatusLine -

Throws:

WebSocketException

verifyServerHandshakeHeaders

public void verifyServerHandshakeHeaders(Map<String,String> aHeaders)
                                  throws WebSocketException

Parameters:

aHeaders -

Throws:

WebSocketException