Package org.eclipse.jetty.websocket.server.internal

Class DelegatedServerUpgradeRequest

java.lang.Object

org.eclipse.jetty.websocket.server.internal.DelegatedServerUpgradeRequest

All Implemented Interfaces:

UpgradeRequest, JettyServerUpgradeRequest

public class DelegatedServerUpgradeRequest
extends Object
implements JettyServerUpgradeRequest

Constructor Summary

Constructors

Constructor	Description
DelegatedServerUpgradeRequest(ServerUpgradeRequest request)

Method Summary

Modifier and Type	Method	Description
X509Certificate[]	getCertificates()
List<HttpCookie>	getCookies()	Get the list of Cookies on the Upgrade request
List<ExtensionConfig>	getExtensions()	Get the list of WebSocket Extension Configurations for this Upgrade Request.
String	getHeader(String name)	Get a specific Header value from Upgrade Request
int	getHeaderInt(String name)	Get the specific Header value, as an int, from the Upgrade Request.
Map<String,List<String>>	getHeaders()	Get the headers as a Map of keys to value lists.
List<String>	getHeaders(String name)	Get the specific header values (for multi-value headers)
String	getHost()	The host of the Upgrade Request URI
jakarta.servlet.http.HttpServletRequest	getHttpServletRequest()
String	getHttpVersion()	The HTTP version used for this Upgrade Request
Locale	getLocale()
Enumeration<Locale>	getLocales()
SocketAddress	getLocalSocketAddress()
String	getMethod()	The HTTP method for this Upgrade Request.
String	getOrigin()	The WebSocket Origin of this Upgrade Request
Map<String,List<String>>	getParameterMap()	Returns a map of the query parameters of the request.
String	getProtocolVersion()	Get the WebSocket Protocol Version
String	getQueryString()	Get the Query String of the request URI.
SocketAddress	getRemoteSocketAddress()
String	getRequestPath()
URI	getRequestURI()	Get the Request URI
Object	getServletAttribute(String name)
Map<String,Object>	getServletAttributes()
Map<String,List<String>>	getServletParameters()
jakarta.servlet.http.HttpSession	getSession()	Access the Servlet HTTP Session (if present)
List<String>	getSubProtocols()	Get the list of offered WebSocket sub-protocols.
Principal	getUserPrincipal()	Get the User Principal for this request.
boolean	hasSubProtocol(String subprotocol)	Test if a specific sub-protocol is offered
boolean	isSecure()	Test if connection is secure.
boolean	isUserInRole(String role)
void	setServletAttribute(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatedServerUpgradeRequest

public DelegatedServerUpgradeRequest(ServerUpgradeRequest request)

Method Details

getCookies

public List<HttpCookie> getCookies()

Description copied from interface: UpgradeRequest

Get the list of Cookies on the Upgrade request

Specified by:

getCookies in interface UpgradeRequest

Returns:

the list of Cookies

getExtensions

public List<ExtensionConfig> getExtensions()

Description copied from interface: UpgradeRequest

Get the list of WebSocket Extension Configurations for this Upgrade Request.

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

Specified by:

getExtensions in interface UpgradeRequest

Returns:

the list of Extension configurations (in the order they were specified)

getHeader

public String getHeader(String name)

Description copied from interface: UpgradeRequest

Get a specific Header value from Upgrade Request

Specified by:

getHeader in interface UpgradeRequest

Parameters:

name - the name of the header

Returns:

the value of the header (null if header does not exist)

getHeaderInt

public int getHeaderInt(String name)

Description copied from interface: UpgradeRequest

Get the specific Header value, as an int, from the Upgrade Request.

Specified by:

getHeaderInt in interface UpgradeRequest

Parameters:

name - the name of the header

Returns:

the value of the header as an int (-1 if header does not exist)

getHeaders

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

Description copied from interface: UpgradeRequest

Get the headers as a Map of keys to value lists.

Specified by:

getHeaders in interface UpgradeRequest

Returns:

the headers

getHeaders

public List<String> getHeaders(String name)

Description copied from interface: UpgradeRequest

Get the specific header values (for multi-value headers)

Specified by:

getHeaders in interface UpgradeRequest

Parameters:

name - the header name

Returns:

the value list (null if no header exists)

getHost

public String getHost()

Description copied from interface: UpgradeRequest

The host of the Upgrade Request URI

Specified by:

getHost in interface UpgradeRequest

Returns:

host of the request URI

getHttpVersion

public String getHttpVersion()

Description copied from interface: UpgradeRequest

The HTTP version used for this Upgrade Request

As of RFC6455 (December 2011) this is always HTTP/1.1

Specified by:

getHttpVersion in interface UpgradeRequest

Returns:

the HTTP Version used

getMethod

public String getMethod()

Description copied from interface: UpgradeRequest

The HTTP method for this Upgrade Request.

As of RFC6455 (December 2011) this is always GET

Specified by:

getMethod in interface UpgradeRequest

Returns:

the HTTP method used

getOrigin

public String getOrigin()

Description copied from interface: UpgradeRequest

The WebSocket Origin of this Upgrade Request

See RFC6455: Section 10.2 for details.

Equivalent to UpgradeRequest.getHeader(String) passed the "Origin" header.

Specified by:

getOrigin in interface UpgradeRequest

Returns:

the Origin header

getParameterMap

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

Description copied from interface: UpgradeRequest

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()

Description copied from interface: UpgradeRequest

Get the WebSocket Protocol Version

As of RFC6455, Jetty only supports version 13

Specified by:

getProtocolVersion in interface UpgradeRequest

Returns:

the WebSocket protocol version

getQueryString

public String getQueryString()

Description copied from interface: UpgradeRequest

Get the Query String of the request URI.

Specified by:

getQueryString in interface UpgradeRequest

Returns:

the request uri query string

getRequestURI

public URI getRequestURI()

Description copied from interface: UpgradeRequest

Get the Request URI

Specified by:

getRequestURI in interface UpgradeRequest

Returns:

the request URI

getSession

public jakarta.servlet.http.HttpSession getSession()

Description copied from interface: JettyServerUpgradeRequest

Access the Servlet HTTP Session (if present)

Note: Never present on a Client UpgradeRequest.

Specified by:

getSession in interface JettyServerUpgradeRequest

Returns:

the Servlet HTTPSession on server side UpgradeRequests

getSubProtocols

public List<String> getSubProtocols()

Description copied from interface: UpgradeRequest

Get the list of offered WebSocket sub-protocols.

Specified by:

getSubProtocols in interface UpgradeRequest

Returns:

the list of offered sub-protocols

getUserPrincipal

public Principal getUserPrincipal()

Description copied from interface: UpgradeRequest

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 subprotocol)

Description copied from interface: UpgradeRequest

Test if a specific sub-protocol is offered

Specified by:

hasSubProtocol in interface UpgradeRequest

Parameters:

subprotocol - the sub-protocol to test for

Returns:

true if sub-protocol exists on request

isSecure

public boolean isSecure()

Description copied from interface: UpgradeRequest

Test if connection is secure.

Specified by:

isSecure in interface UpgradeRequest

Returns:

true if connection is secure.

getCertificates

public X509Certificate[] getCertificates()

Specified by:

getCertificates in interface JettyServerUpgradeRequest

Returns:

The X509Certificate instance at request attribute "jakarta.servlet.request.X509Certificate" or null.

getHttpServletRequest

public jakarta.servlet.http.HttpServletRequest getHttpServletRequest()

Specified by:

getHttpServletRequest in interface JettyServerUpgradeRequest

Returns:

Immutable version of HttpServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface JettyServerUpgradeRequest

Returns:

The requested Locale

See Also:

• ServletRequest.getLocale()

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface JettyServerUpgradeRequest

Returns:

The requested Locales

See Also:

• ServletRequest.getLocales()

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface JettyServerUpgradeRequest

Returns:

The local requested address, which is typically an InetSocketAddress, but may be another derivation of SocketAddress

See Also:

• ServletRequest.getLocalAddr()
• ServletRequest.getLocalPort()

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface JettyServerUpgradeRequest

Returns:

The remote request address, which is typically an InetSocketAddress, but may be another derivation of SocketAddress

See Also:

• ServletRequest.getRemoteAddr()
• ServletRequest.getRemotePort()

getRequestPath

public String getRequestPath()

Specified by:

getRequestPath in interface JettyServerUpgradeRequest

Returns:

The request URI path within the context

getServletAttribute

public Object getServletAttribute(String name)

Specified by:

getServletAttribute in interface JettyServerUpgradeRequest

Parameters:

name - Attribute name

Returns:

Attribute value or null

See Also:

• ServletRequest.getAttribute(String)

getServletAttributes

public Map<String,Object> getServletAttributes()

Specified by:

getServletAttributes in interface JettyServerUpgradeRequest

Returns:

Request attribute map

getServletParameters

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

Specified by:

getServletParameters in interface JettyServerUpgradeRequest

Returns:

Request parameters

See Also:

• ServletRequest.getParameterMap()

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface JettyServerUpgradeRequest

Parameters:

role - The user role

Returns:

True if the requests user has the role

See Also:

• HttpServletRequest.isUserInRole(String)

setServletAttribute

public void setServletAttribute(String name,
 Object value)

Specified by:

setServletAttribute in interface JettyServerUpgradeRequest

Parameters:

name - Attribute name

value - Attribute value to set

See Also:

• ServletRequest.setAttribute(String, Object)