Package org.eclipse.jetty.websocket.client

Class ClientUpgradeRequest

java.lang.Object

org.eclipse.jetty.websocket.common.UpgradeRequestAdapter

org.eclipse.jetty.websocket.client.ClientUpgradeRequest

All Implemented Interfaces:

UpgradeRequest

public class ClientUpgradeRequest
extends UpgradeRequestAdapter

Allowing a generate from a UpgradeRequest

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClientUpgradeRequest()
protected	ClientUpgradeRequest(java.net.URI requestURI)
	ClientUpgradeRequest(WebSocketUpgradeRequest wsRequest)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getKey()
java.lang.Object	getLocalEndpoint()
long	getTimeout()
void	setCookiesFrom(java.net.CookieStore cookieStore)	Deprecated. use either WebSocketClient.setCookieStore(CookieStore) or HttpClient.setCookieStore(CookieStore) instead
void	setLocalEndpoint(java.lang.Object websocket)
void	setRequestURI(java.net.URI uri)	Set the Request URI to use for this request.
void	setTimeout(long timeout, java.util.concurrent.TimeUnit unit)

Methods inherited from class org.eclipse.jetty.websocket.common.UpgradeRequestAdapter

addExtensions, addExtensions, clearHeaders, getCookies, getExtensions, getHeader, getHeaderInt, getHeaders, getHeaders, getHost, getHttpVersion, getMethod, getOrigin, getParameterMap, getProtocolVersion, getQueryString, getRequestURI, getSession, getSubProtocols, getUserPrincipal, hasSubProtocol, isOrigin, isSecure, setCookies, setExtensions, setHeader, setHeader, setHeaders, setHttpVersion, setMethod, setParameterMap, setSession, setSubProtocols, setSubProtocols

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientUpgradeRequest

public ClientUpgradeRequest()

ClientUpgradeRequest

protected ClientUpgradeRequest(java.net.URI requestURI)

ClientUpgradeRequest

public ClientUpgradeRequest(WebSocketUpgradeRequest wsRequest)

Method Detail

getKey

public java.lang.String getKey()

setCookiesFrom

@Deprecated
public void setCookiesFrom(java.net.CookieStore cookieStore)

Deprecated.

use either WebSocketClient.setCookieStore(CookieStore) or HttpClient.setCookieStore(CookieStore) instead

Parameters:

cookieStore - the cookie store to use

setRequestURI

public void setRequestURI(java.net.URI uri)

Description copied from interface: UpgradeRequest

Set the Request URI to use for this request.

Must be an absolute URI with scheme 'ws' or 'wss'

Specified by:

setRequestURI in interface UpgradeRequest

Overrides:

setRequestURI in class UpgradeRequestAdapter

Parameters:

uri - the Request URI

setTimeout

public void setTimeout(long timeout,
                       java.util.concurrent.TimeUnit unit)

Parameters:

timeout - the total timeout for the request/response conversation of the WebSocket handshake; use zero or a negative value to disable the timeout

unit - the timeout unit

getTimeout

public long getTimeout()

Returns:

the total timeout for this request, in milliseconds; zero or negative if the timeout is disabled

setLocalEndpoint

public void setLocalEndpoint(java.lang.Object websocket)

getLocalEndpoint

public java.lang.Object getLocalEndpoint()