org.glassfish.tyrus.websockets

Class HandShake

java.lang.Object

org.glassfish.tyrus.websockets.HandShake

Direct Known Subclasses:

HandShake06

public abstract class HandShake
extends Object

Author:

Justin Lee, Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HandShake.HandShakeResponseListener Used to register with HandShake.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandShake(URI url)
protected	HandShake(WebSocketRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
WebSocketRequest	composeRequest() Compose the WebSocketRequest and store it for further use.
static List<Extension>	fromHeaders(List<String> extensionHeaders) Parse Extension from headers (represented as List of strings).
static List<Extension>	fromString(String s) Parsing of one Extension.
protected List<Extension>	getExtensions()
protected <T> String	getHeaderFromList(List<T> list)
String	getLocation()
protected String	getOrigin()
protected WebSocketRequest	getRequest() Gets the WebSocketRequest.
protected List<String>	getSubProtocols()
WebSocketRequest	initiate()
protected String	join(List<String> values)
protected String	joinExtensions(List<Extension> extensions)
void	setExtensions(List<Extension> extensions)
protected abstract void	setHeaders(WebSocketResponse response)
void	setLocation(String location)
void	setOrigin(String origin)
void	setResourcePath(String resourcePath)
void	setResponseListener(HandShake.HandShakeResponseListener responseListener) Set response listener.
void	setSecure(boolean secure)
void	setSubProtocols(List<String> subProtocols)
protected List<String>	split(String header)
void	validateServerResponse(WebSocketResponse response)

Methods inherited from class java.lang.Object

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

Constructor Detail

HandShake

protected HandShake(URI url)

HandShake

protected HandShake(WebSocketRequest request)

Method Detail

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

getOrigin

protected String getOrigin()

setOrigin

public void setOrigin(String origin)

setResourcePath

public void setResourcePath(String resourcePath)

setSecure

public void setSecure(boolean secure)

getSubProtocols

protected List<String> getSubProtocols()

getHeaderFromList

protected <T> String getHeaderFromList(List<T> list)

setSubProtocols

public void setSubProtocols(List<String> subProtocols)

getExtensions

protected List<Extension> getExtensions()

setExtensions

public void setExtensions(List<Extension> extensions)

joinExtensions

protected final String joinExtensions(List<Extension> extensions)

join

protected String join(List<String> values)

getRequest

protected WebSocketRequest getRequest()

Gets the WebSocketRequest. If the request hasn't been composed before using the composeRequest() method, this method is called first.

Returns:

WebSocketRequest created on this HandShake.

composeRequest

public WebSocketRequest composeRequest()

Compose the WebSocketRequest and store it for further use.

Returns:

composed WebSocketRequest.

validateServerResponse

public void validateServerResponse(WebSocketResponse response)

setHeaders

protected abstract void setHeaders(WebSocketResponse response)

split

protected final List<String> split(String header)

fromString

public static List<Extension> fromString(String s)

Parsing of one Extension.

Parameters:

s - String containing Extension.

Returns:

extension represented as Extension.

fromHeaders

public static List<Extension> fromHeaders(List<String> extensionHeaders)

Parse Extension from headers (represented as List of strings).

Parameters:

extensionHeaders - Http Extension headers.

Returns:

list of parsed Extensions.

initiate

public WebSocketRequest initiate()

setResponseListener

public void setResponseListener(HandShake.HandShakeResponseListener responseListener)

Set response listener.

Parameters:

responseListener - HandShake.HandShakeResponseListener.onResponseHeaders(java.util.Map) will be called when response is ready and validated.