Package org.threadly.litesockets.protocols.websocket

Class WSUtils

java.lang.Object

org.threadly.litesockets.protocols.websocket.WSUtils

public class WSUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
WSUtils()

Method Summary

Modifier and Type	Method	Description
static int	getFrameLength(java.nio.ByteBuffer bb)	Gives the total length of the next Frame in the provided ByteBuffer.
static int	getFrameLength(org.threadly.litesockets.buffers.MergedByteBuffers mbb)	Gives the total length of the next Frame in the provided MergedByteBuffers.
static java.lang.String	makeKeyResponse(java.lang.String str)	Makes a Sec-WebSocket-Key response string.
static java.lang.String	makeSecretKey()	Makes a Sec-WebSocket-Key that is 20 Bytes long.
static java.lang.String	makeSecretKey(int size)	Makes a Sec-WebSocket-Key that is however long you make it.
static java.nio.ByteBuffer	maskData(java.nio.ByteBuffer nbb, int mask)	This will mask or unmask data against provided mask.
static boolean	validateKeyResponse(java.lang.String orig, java.lang.String response)	Validates the Sec-WebSocket-Accept header response for a websocket request.
static boolean	validateKeyResponse(java.lang.String origKey, HTTPHeaders headers)	Validates the Sec-WebSocket-Accept header response for a websocket request.

Methods inherited from class java.lang.Object

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

Constructor Detail

WSUtils

public WSUtils()

Method Detail

makeSecretKey

public static java.lang.String makeSecretKey()

Makes a Sec-WebSocket-Key that is 20 Bytes long.

Returns:

a Random 20 bytes Base64 encoded.

makeSecretKey

public static java.lang.String makeSecretKey(int size)

Makes a Sec-WebSocket-Key that is however long you make it.

Parameters:

size - the size in bytes of the random key.

Returns:

a Random amount of bytes Base64 encoded.

makeKeyResponse

public static java.lang.String makeKeyResponse(java.lang.String str)

Makes a Sec-WebSocket-Key response string.

Parameters:

str - base64 string passed in the Sec-WebSocket-Key header.

Returns:

a base64 string to set as the Sec-WebSocket-Key response.

validateKeyResponse

public static boolean validateKeyResponse(java.lang.String origKey,
                                          HTTPHeaders headers)

Validates the Sec-WebSocket-Accept header response for a websocket request.

Parameters:

origKey - the original key used.

headers - the HTTPHeader object

Returns:

true if the key is correct, false if its not.

validateKeyResponse

public static boolean validateKeyResponse(java.lang.String orig,
                                          java.lang.String response)

Validates the Sec-WebSocket-Accept header response for a websocket request.

Parameters:

origKey - the original key used.

response - the String value of the response.

Returns:

true if the key is correct, false if its not.

maskData

public static java.nio.ByteBuffer maskData(java.nio.ByteBuffer nbb,
                                           int mask)

This will mask or unmask data against provided mask.

Parameters:

nbb - the ByteBuffer to apply the mask to.

mask - the mask to apply to the ByteBuffer.

Returns:

ByteBuffer with the provided mask applyed to it.

getFrameLength

public static int getFrameLength(org.threadly.litesockets.buffers.MergedByteBuffers mbb)

Gives the total length of the next Frame in the provided MergedByteBuffers. This does not modify the MergedByteBuffers.

Parameters:

mbb - MergedByteBuffers to get the Frame length from.

Returns:

size of the frame in bytes, or -1 is there is not enough data to make figure out the frame length.

getFrameLength

public static int getFrameLength(java.nio.ByteBuffer bb)

Gives the total length of the next Frame in the provided ByteBuffer. This does not modify the ByteBuffer.

Parameters:

bb - the ByteBuffer to find the frame length on.

Returns:

the size of the frame in this ByteBuffer.