org.eclipse.jetty.websocket.api

Class UpgradeRequest

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeRequest

Direct Known Subclasses:

ClientUpgradeRequest, ServletUpgradeRequest

public class UpgradeRequest
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpgradeRequest()
	UpgradeRequest(String requestURI)
	UpgradeRequest(URI requestURI)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtensions(ExtensionConfig... configs)
void	addExtensions(String... configs)
void	clearHeaders()
List<HttpCookie>	getCookies()
List<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() Returns a map of the query parameters of the request.
String	getProtocolVersion()
String	getQueryString()
URI	getRequestURI()
Object	getSession() Access the Servlet HTTP Session (if present)
List<String>	getSubProtocols()
Principal	getUserPrincipal() Get the User Principal for this request.
boolean	hasSubProtocol(String test)
boolean	isOrigin(String test)
boolean	isSecure()
void	setCookies(List<HttpCookie> cookies)
void	setExtensions(List<ExtensionConfig> configs)
void	setHeader(String name, List<String> values)
void	setHeader(String name, String value)
void	setHeaders(Map<String,List<String>> headers)
void	setHttpVersion(String httpVersion)
void	setMethod(String method)
protected void	setParameterMap(Map<String,List<String>> parameters)
void	setRequestURI(URI uri)
void	setSession(Object session)
void	setSubProtocols(List<String> subProtocols)
void	setSubProtocols(String... protocols) Set Sub Protocol request list.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeRequest

protected UpgradeRequest()

UpgradeRequest

public UpgradeRequest(String requestURI)

UpgradeRequest

public UpgradeRequest(URI requestURI)

Method Detail

addExtensions

public void addExtensions(ExtensionConfig... configs)

addExtensions

public void addExtensions(String... configs)

clearHeaders

public void clearHeaders()

getCookies

public List<HttpCookie> getCookies()

getExtensions

public List<ExtensionConfig> getExtensions()

getHeader

public String getHeader(String name)

getHeaderInt

public int getHeaderInt(String name)

getHeaders

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

getHeaders

public List<String> getHeaders(String name)

getHost

public String getHost()

getHttpVersion

public String getHttpVersion()

getMethod

public String getMethod()

getOrigin

public String getOrigin()

getParameterMap

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

Returns a map of the query parameters of the request.

Returns:

a unmodifiable map of query parameters of the request.

getProtocolVersion

public String getProtocolVersion()

getQueryString

public String getQueryString()

getRequestURI

public URI getRequestURI()

getSession

public Object getSession()

Access the Servlet HTTP Session (if present)

Note: Never present on a Client UpgradeRequest.

Returns:

the Servlet HTTPSession on server side UpgradeRequests

getSubProtocols

public List<String> getSubProtocols()

getUserPrincipal

public Principal getUserPrincipal()

Get the User Principal for this request.

Only applicable when using UpgradeRequest from server side.

Returns:

the user principal

hasSubProtocol

public boolean hasSubProtocol(String test)

isOrigin

public boolean isOrigin(String test)

isSecure

public boolean isSecure()

setCookies

public void setCookies(List<HttpCookie> cookies)

setExtensions

public void setExtensions(List<ExtensionConfig> configs)

setHeader

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

setHeader

public void setHeader(String name,
             String value)

setHeaders

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

setHttpVersion

public void setHttpVersion(String httpVersion)

setMethod

public void setMethod(String method)

setParameterMap

protected void setParameterMap(Map<String,List<String>> parameters)

setRequestURI

public void setRequestURI(URI uri)

setSession

public void setSession(Object session)

setSubProtocols

public void setSubProtocols(List<String> subProtocols)

setSubProtocols

public void setSubProtocols(String... protocols)

Set Sub Protocol request list.

Parameters:

protocols - the sub protocols desired