org.eclipse.jetty.websocket.common

Class UpgradeRequestAdapter

java.lang.Object

org.eclipse.jetty.websocket.common.UpgradeRequestAdapter

All Implemented Interfaces:

UpgradeRequest

public class UpgradeRequestAdapter
extends Object
implements UpgradeRequest

Constructor Summary

Constructors

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

Method Summary

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

UpgradeRequestAdapter

protected UpgradeRequestAdapter()

UpgradeRequestAdapter

public UpgradeRequestAdapter(String requestURI)

UpgradeRequestAdapter

public UpgradeRequestAdapter(URI requestURI)

Method Detail

addExtensions

public void addExtensions(ExtensionConfig... configs)

Specified by:

addExtensions in interface UpgradeRequest

addExtensions

public void addExtensions(String... configs)

Specified by:

addExtensions in interface UpgradeRequest

clearHeaders

public void clearHeaders()

Specified by:

clearHeaders in interface UpgradeRequest

getCookies

public List<HttpCookie> getCookies()

Specified by:

getCookies in interface UpgradeRequest

getExtensions

public List<ExtensionConfig> getExtensions()

Specified by:

getExtensions in interface UpgradeRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface UpgradeRequest

getHeaderInt

public int getHeaderInt(String name)

Specified by:

getHeaderInt in interface UpgradeRequest

getHeaders

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

Specified by:

getHeaders in interface UpgradeRequest

getHeaders

public List<String> getHeaders(String name)

Specified by:

getHeaders in interface UpgradeRequest

getHost

public String getHost()

Specified by:

getHost in interface UpgradeRequest

getHttpVersion

public String getHttpVersion()

Specified by:

getHttpVersion in interface UpgradeRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface UpgradeRequest

getOrigin

public String getOrigin()

Specified by:

getOrigin in interface UpgradeRequest

getParameterMap

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

Returns a map of the query parameters of the request.

Specified by:

getParameterMap in interface UpgradeRequest

Returns:

a unmodifiable map of query parameters of the request.

getProtocolVersion

public String getProtocolVersion()

Specified by:

getProtocolVersion in interface UpgradeRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface UpgradeRequest

getRequestURI

public URI getRequestURI()

Specified by:

getRequestURI in interface UpgradeRequest

getSession

public Object getSession()

Access the Servlet HTTP Session (if present)

Note: Never present on a Client UpgradeRequest.

Specified by:

getSession in interface UpgradeRequest

Returns:

the Servlet HTTPSession on server side UpgradeRequests

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface UpgradeRequest

getUserPrincipal

public Principal getUserPrincipal()

Get the User Principal for this request.

Only applicable when using UpgradeRequest from server side.

Specified by:

getUserPrincipal in interface UpgradeRequest

Returns:

the user principal

hasSubProtocol

public boolean hasSubProtocol(String test)

Specified by:

hasSubProtocol in interface UpgradeRequest

isOrigin

public boolean isOrigin(String test)

Specified by:

isOrigin in interface UpgradeRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface UpgradeRequest

setCookies

public void setCookies(List<HttpCookie> cookies)

Specified by:

setCookies in interface UpgradeRequest

setExtensions

public void setExtensions(List<ExtensionConfig> configs)

Specified by:

setExtensions in interface UpgradeRequest

setHeader

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

Specified by:

setHeader in interface UpgradeRequest

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface UpgradeRequest

setHeaders

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

Specified by:

setHeaders in interface UpgradeRequest

setHttpVersion

public void setHttpVersion(String httpVersion)

Specified by:

setHttpVersion in interface UpgradeRequest

setMethod

public void setMethod(String method)

Specified by:

setMethod in interface UpgradeRequest

setParameterMap

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

setRequestURI

public void setRequestURI(URI uri)

Specified by:

setRequestURI in interface UpgradeRequest

setSession

public void setSession(Object session)

Specified by:

setSession in interface UpgradeRequest

setSubProtocols

public void setSubProtocols(List<String> subProtocols)

Specified by:

setSubProtocols in interface UpgradeRequest

setSubProtocols

public void setSubProtocols(String... protocols)

Set Sub Protocol request list.

Specified by:

setSubProtocols in interface UpgradeRequest

Parameters:

protocols - the sub protocols desired