Module org.eclipse.jetty.websocket.client

Package org.eclipse.jetty.websocket.client

Class ClientUpgradeRequest

java.lang.Object

org.eclipse.jetty.websocket.client.ClientUpgradeRequest

All Implemented Interfaces:

org.eclipse.jetty.websocket.api.UpgradeRequest

public final class ClientUpgradeRequest
extends Object
implements org.eclipse.jetty.websocket.api.UpgradeRequest

Client based UpgradeRequest API

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABNF_REQUIRED_QUOTING	ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.

Constructor Summary

Constructors

Constructor	Description
ClientUpgradeRequest()
ClientUpgradeRequest(URI uri)	Deprecated. use ClientUpgradeRequest() instead.

Method Summary

Modifier and Type	Method	Description
void	addExtensions(String... configs)	Add WebSocket Extension Configuration(s) to request
void	addExtensions(org.eclipse.jetty.websocket.api.ExtensionConfig... configs)	Add WebSocket Extension Configuration(s) to Upgrade Request.
List<HttpCookie>	getCookies()
List<org.eclipse.jetty.websocket.api.ExtensionConfig>	getExtensions()
String	getHeader(String name)
int	getHeaderInt(String name)
Map<String,List<String>>	getHeaders()
List<String>	getHeaders(String name)
String	getHost()
String	getHttpVersion()
String	getMethod()
String	getOrigin()
Map<String,List<String>>	getParameterMap()
String	getProtocolVersion()
String	getQueryString()
URI	getRequestURI()
List<String>	getSubProtocols()
long	getTimeout()
Principal	getUserPrincipal()
boolean	hasSubProtocol(String test)
boolean	isSecure()
static String	joinValues(List<String> values)
void	setCookies(List<HttpCookie> cookies)	Set the list of Cookies on the request
void	setExtensions(List<org.eclipse.jetty.websocket.api.ExtensionConfig> configs)	Set the list of WebSocket Extension configurations on the request.
void	setHeader(String name, String value)	Set a specific header value
void	setHeader(String name, List<String> values)	Set a specific header with multi-value field
void	setHeaders(Map<String,List<String>> headers)	Sets multiple headers on the request.
void	setSubProtocols(String... protocols)	Set the offered WebSocket Sub-Protocol list.
void	setSubProtocols(List<String> protocols)	Set the offered WebSocket Sub-Protocol list.
void	setTimeout(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Details

ABNF_REQUIRED_QUOTING

public static final String ABNF_REQUIRED_QUOTING

ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.

See Also:

• Constant Field Values

Constructor Details

ClientUpgradeRequest

public ClientUpgradeRequest()

ClientUpgradeRequest

@Deprecated
public ClientUpgradeRequest(URI uri)

Deprecated.

use ClientUpgradeRequest() instead.

Method Details

getCookies

public List<HttpCookie> getCookies()

Specified by:

getCookies in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getExtensions

public List<org.eclipse.jetty.websocket.api.ExtensionConfig> getExtensions()

Specified by:

getExtensions in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHeaderInt

public int getHeaderInt(String name)

Specified by:

getHeaderInt in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHeaders

public Map<String,List<String>> getHeaders()

Specified by:

getHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHeaders

public List<String> getHeaders(String name)

Specified by:

getHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHost

public String getHost()

Specified by:

getHost in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getHttpVersion

public String getHttpVersion()

Specified by:

getHttpVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getOrigin

public String getOrigin()

Specified by:

getOrigin in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getParameterMap

public Map<String,List<String>> getParameterMap()

Specified by:

getParameterMap in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getRequestURI

public URI getRequestURI()

Specified by:

getRequestURI in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface org.eclipse.jetty.websocket.api.UpgradeRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface org.eclipse.jetty.websocket.api.UpgradeRequest

hasSubProtocol

public boolean hasSubProtocol(String test)

Specified by:

hasSubProtocol in interface org.eclipse.jetty.websocket.api.UpgradeRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface org.eclipse.jetty.websocket.api.UpgradeRequest

addExtensions

public void addExtensions(org.eclipse.jetty.websocket.api.ExtensionConfig... configs)

Add WebSocket Extension Configuration(s) to Upgrade Request.

This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions() for what was negotiated

Parameters:

configs - the configuration(s) to add

addExtensions

public void addExtensions(String... configs)

Add WebSocket Extension Configuration(s) to request

This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions() for what was negotiated

Parameters:

configs - the configuration(s) to add

setCookies

public void setCookies(List<HttpCookie> cookies)

Set the list of Cookies on the request

Parameters:

cookies - the cookies to use

setExtensions

public void setExtensions(List<org.eclipse.jetty.websocket.api.ExtensionConfig> configs)

Set the list of WebSocket Extension configurations on the request.

Parameters:

configs - the list of extension configurations

setHeader

public void setHeader(String name,
 List<String> values)

Set a specific header with multi-value field

Overrides any previous value for this named header

Parameters:

name - the name of the header

values - the multi-value field

setHeader

public void setHeader(String name,
 String value)

Set a specific header value

Overrides any previous value for this named header

Parameters:

name - the header to set

value - the value to set it to

setHeaders

public void setHeaders(Map<String,List<String>> headers)

Sets multiple headers on the request.

Only sets those headers provided, does not remove headers that exist on request and are not provided in the parameter for this method.

Convenience method vs calling setHeader(String, List) multiple times.

Parameters:

headers - the headers to set

setSubProtocols

public void setSubProtocols(List<String> protocols)

Set the offered WebSocket Sub-Protocol list.

Parameters:

protocols - the offered sub-protocol list

setSubProtocols

public void setSubProtocols(String... protocols)

Set the offered WebSocket Sub-Protocol list.

Parameters:

protocols - the offered sub-protocol list

setTimeout

public void setTimeout(long timeout,
 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

joinValues

public static String joinValues(List<String> values)