org.eclipse.jetty.websocket.server

Class ServletWebSocketRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.eclipse.jetty.websocket.server.ServletWebSocketRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest, UpgradeRequest

public class ServletWebSocketRequest
extends HttpServletRequestWrapper
implements UpgradeRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
ServletWebSocketRequest(HttpServletRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtensions(String... extConfigs)
Map<String,String>	getCookieMap()
List<ExtensionConfig>	getExtensions()
String	getHost()
String	getHttpEndPointName() Get the endpoint of the WebSocket connection.
String	getOrigin()
List<String>	getSubProtocols()
boolean	hasSubProtocol(String test)
boolean	isOrigin(String test)
protected String[]	parseProtocols(String protocol)
void	setSubProtocols(String protocol) Not implemented (not relevant) on server side.
void	setValidExtensions(List<Extension> valid)

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.websocket.core.api.UpgradeRequest

getHeader

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

ServletWebSocketRequest

public ServletWebSocketRequest(HttpServletRequest request)

Method Detail

addExtensions

public void addExtensions(String... extConfigs)

Specified by:

addExtensions in interface UpgradeRequest

getCookieMap

public Map<String,String> getCookieMap()

Specified by:

getCookieMap in interface UpgradeRequest

getExtensions

public List<ExtensionConfig> getExtensions()

Specified by:

getExtensions in interface UpgradeRequest

getHost

public String getHost()

Specified by:

getHost in interface UpgradeRequest

getHttpEndPointName

public String getHttpEndPointName()

Get the endpoint of the WebSocket connection.

Per the Opening Handshake (RFC 6455)

Specified by:

getHttpEndPointName in interface UpgradeRequest

getOrigin

public String getOrigin()

Specified by:

getOrigin in interface UpgradeRequest

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface UpgradeRequest

hasSubProtocol

public boolean hasSubProtocol(String test)

Specified by:

hasSubProtocol in interface UpgradeRequest

isOrigin

public boolean isOrigin(String test)

Specified by:

isOrigin in interface UpgradeRequest

parseProtocols

protected String[] parseProtocols(String protocol)

setSubProtocols

public void setSubProtocols(String protocol)

Not implemented (not relevant) on server side.

Specified by:

setSubProtocols in interface UpgradeRequest

See Also:

UpgradeRequest.setSubProtocols(java.lang.String)

setValidExtensions

public void setValidExtensions(List<Extension> valid)