Class ServletUpgradeRequest
- All Implemented Interfaces:
UpgradeRequest
- Direct Known Subclasses:
ServletWebSocketRequest
UpgradeRequest
implementation.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private List
<HttpCookie> private final String
private final UpgradeHttpServletRequest
private final URI
private final boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addExtensions
(String... configs) Add WebSocket Extension Configuration(s) to requestvoid
addExtensions
(ExtensionConfig... configs) Add WebSocket Extension Configuration(s) to Upgrade Request.void
Remove all headers from request.void
complete()
Get the list of Cookies on the Upgrade requestGet the list of WebSocket Extension Configurations for this Upgrade Request.Get a specific Header value from Upgrade Requestint
getHeaderInt
(String name) Get the specific Header value, as anint
, from the Upgrade Request.Get the headers as a Map of keys to value lists.getHeaders
(String name) Get the specific header values (for multi-value headers)getHost()
The host of the Upgrade Request URIjavax.servlet.http.HttpServletRequest
Return the underlying HttpServletRequest that existed at Upgrade time.The HTTP version used for this Upgrade RequestEquivalent toServletRequest.getLocalAddr()
Equivalent toServletRequest.getLocale()
Equivalent toServletRequest.getLocales()
Equivalent toServletRequest.getLocalName()
int
Equivalent toServletRequest.getLocalPort()
Return aInetSocketAddress
for the local socket.The HTTP method for this Upgrade Request.The WebSocket Origin of this Upgrade RequestReturns a map of the query parameters of the request.Deprecated.Get the WebSocket Protocol VersionGet the Query String of the request URI.Equivalent toServletRequest.getRemoteAddr()
Equivalent toServletRequest.getRemoteHost()
int
Equivalent toServletRequest.getRemotePort()
Return aInetSocketAddress
for the remote socket.Get the Request URIgetServletAttribute
(String name) javax.servlet.http.HttpSession
Return the HttpSession if it exists.Get the list of offered WebSocket sub-protocols.Equivalent toHttpServletRequest.getUserPrincipal()
boolean
hasSubProtocol
(String test) Test if a specific sub-protocol is offeredboolean
Test if supplied Origin is the same as the Requestboolean
isSecure()
Test if connection is secure.boolean
isUserInRole
(String role) private String[]
parseProtocols
(String protocol) void
setCookies
(List<HttpCookie> cookies) Set the list of Cookies on the requestvoid
setExtensions
(List<ExtensionConfig> configs) Set the list of WebSocket Extension configurations on the request.void
Set a specific header valuevoid
Set a specific header with multi-value fieldvoid
setHeaders
(Map<String, List<String>> headers) Sets multiple headers on the request.void
setHttpVersion
(String httpVersion) Set the HTTP Version to use.void
Set the HTTP method to use.void
setRequestURI
(URI uri) Set the Request URI to use for this request.void
setServletAttribute
(String name, Object value) void
setSession
(Object session) Set the Session associated with this request.void
setSubProtocols
(String... protocols) Set the offered WebSocket Sub-Protocol list.void
setSubProtocols
(List<String> subProtocols) Set the offered WebSocket Sub-Protocol list.
-
Field Details
-
CANNOT_MODIFY_SERVLET_REQUEST
- See Also:
-
requestURI
-
queryString
-
request
-
secure
private final boolean secure -
cookies
-
parameterMap
-
-
Constructor Details
-
ServletUpgradeRequest
public ServletUpgradeRequest(javax.servlet.http.HttpServletRequest httpRequest) throws URISyntaxException - Throws:
URISyntaxException
-
-
Method Details
-
addExtensions
Description copied from interface:UpgradeRequest
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- Specified by:
addExtensions
in interfaceUpgradeRequest
- Parameters:
configs
- the configuration(s) to add
-
addExtensions
Description copied from interface:UpgradeRequest
Add WebSocket Extension Configuration(s) to requestThis is merely the list of requested Extensions to use, see
UpgradeResponse.getExtensions()
for what was negotiated- Specified by:
addExtensions
in interfaceUpgradeRequest
- Parameters:
configs
- the configuration(s) to add
-
clearHeaders
public void clearHeaders()Description copied from interface:UpgradeRequest
Remove all headers from request.- Specified by:
clearHeaders
in interfaceUpgradeRequest
-
complete
public void complete() -
getCertificates
-
getCookies
Description copied from interface:UpgradeRequest
Get the list of Cookies on the Upgrade request- Specified by:
getCookies
in interfaceUpgradeRequest
- Returns:
- the list of Cookies
-
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 interfaceUpgradeRequest
- Returns:
- the list of Extension configurations (in the order they were specified)
-
getHeader
Description copied from interface:UpgradeRequest
Get a specific Header value from Upgrade Request- Specified by:
getHeader
in interfaceUpgradeRequest
- Parameters:
name
- the name of the header- Returns:
- the value of the header (null if header does not exist)
-
getHeaderInt
Description copied from interface:UpgradeRequest
Get the specific Header value, as anint
, from the Upgrade Request.- Specified by:
getHeaderInt
in interfaceUpgradeRequest
- Parameters:
name
- the name of the header- Returns:
- the value of the header as an
int
(-1 if header does not exist)
-
getHeaders
Description copied from interface:UpgradeRequest
Get the headers as a Map of keys to value lists.- Specified by:
getHeaders
in interfaceUpgradeRequest
- Returns:
- the headers
-
getHeaders
Description copied from interface:UpgradeRequest
Get the specific header values (for multi-value headers)- Specified by:
getHeaders
in interfaceUpgradeRequest
- Parameters:
name
- the header name- Returns:
- the value list (null if no header exists)
-
getHost
Description copied from interface:UpgradeRequest
The host of the Upgrade Request URI- Specified by:
getHost
in interfaceUpgradeRequest
- Returns:
- host of the request URI
-
getHttpServletRequest
public javax.servlet.http.HttpServletRequest getHttpServletRequest()Return the underlying HttpServletRequest that existed at Upgrade time.Note: many features of the HttpServletRequest are invalid when upgraded, especially ones that deal with body content, streams, readers, and responses.
- Returns:
- a limited version of the underlying HttpServletRequest
-
getHttpVersion
Description copied from interface:UpgradeRequest
The HTTP version used for this Upgrade RequestAs of RFC6455 (December 2011) this is always
HTTP/1.1
- Specified by:
getHttpVersion
in interfaceUpgradeRequest
- Returns:
- the HTTP Version used
-
getLocalAddress
Equivalent toServletRequest.getLocalAddr()
- Returns:
- the local address
-
getLocale
Equivalent toServletRequest.getLocale()
- Returns:
- the preferred
Locale
for the client
-
getLocales
Equivalent toServletRequest.getLocales()
- Returns:
- an Enumeration of preferred Locale objects
-
getLocalHostName
Equivalent toServletRequest.getLocalName()
- Returns:
- the local host name
-
getLocalPort
public int getLocalPort()Equivalent toServletRequest.getLocalPort()
- Returns:
- the local port
-
getLocalSocketAddress
Return aInetSocketAddress
for the local socket.Warning: this can cause a DNS lookup
- Returns:
- the local socket address
-
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 interfaceUpgradeRequest
- Returns:
- the HTTP method used
-
getOrigin
Description copied from interface:UpgradeRequest
The WebSocket Origin of this Upgrade RequestSee RFC6455: Section 10.2 for details.
Equivalent to
UpgradeRequest.getHeader(String)
passed the "Origin" header.- Specified by:
getOrigin
in interfaceUpgradeRequest
- Returns:
- the Origin header
-
getParameterMap
Description copied from interface:UpgradeRequest
Returns a map of the query parameters of the request.- Specified by:
getParameterMap
in interfaceUpgradeRequest
- Returns:
- a unmodifiable map of query parameters of the request.
-
getPrincipal
Deprecated.usegetUserPrincipal()
instead- Returns:
- the principal
-
getProtocolVersion
Description copied from interface:UpgradeRequest
Get the WebSocket Protocol VersionAs of RFC6455, Jetty only supports version
13
- Specified by:
getProtocolVersion
in interfaceUpgradeRequest
- Returns:
- the WebSocket protocol version
-
getQueryString
Description copied from interface:UpgradeRequest
Get the Query String of the request URI.- Specified by:
getQueryString
in interfaceUpgradeRequest
- Returns:
- the request uri query string
-
getRemoteAddress
Equivalent toServletRequest.getRemoteAddr()
- Returns:
- the remote address
-
getRemoteHostName
Equivalent toServletRequest.getRemoteHost()
- Returns:
- the remote host name
-
getRemotePort
public int getRemotePort()Equivalent toServletRequest.getRemotePort()
- Returns:
- the remote port
-
getRemoteSocketAddress
Return aInetSocketAddress
for the remote socket.Warning: this can cause a DNS lookup
- Returns:
- the remote socket address
-
getRequestPath
-
getRequestURI
Description copied from interface:UpgradeRequest
Get the Request URI- Specified by:
getRequestURI
in interfaceUpgradeRequest
- Returns:
- the request URI
-
getServletAttribute
-
getServletAttributes
-
getServletParameters
-
getSession
public javax.servlet.http.HttpSession getSession()Return the HttpSession if it exists.Note: this is equivalent to
HttpServletRequest.getSession(boolean)
and will not create a new HttpSession.- Specified by:
getSession
in interfaceUpgradeRequest
- Returns:
- the Servlet HTTPSession on server side UpgradeRequests
-
getSubProtocols
Description copied from interface:UpgradeRequest
Get the list of offered WebSocket sub-protocols.- Specified by:
getSubProtocols
in interfaceUpgradeRequest
- Returns:
- the list of offered sub-protocols
-
getUserPrincipal
Equivalent toHttpServletRequest.getUserPrincipal()
- Specified by:
getUserPrincipal
in interfaceUpgradeRequest
- Returns:
- the user principal
-
hasSubProtocol
Description copied from interface:UpgradeRequest
Test if a specific sub-protocol is offered- Specified by:
hasSubProtocol
in interfaceUpgradeRequest
- Parameters:
test
- the sub-protocol to test for- Returns:
- true if sub-protocol exists on request
-
isOrigin
Description copied from interface:UpgradeRequest
Test if supplied Origin is the same as the Request- Specified by:
isOrigin
in interfaceUpgradeRequest
- Parameters:
test
- the supplied origin- Returns:
- true if the supplied origin matches the request origin
-
isSecure
public boolean isSecure()Description copied from interface:UpgradeRequest
Test if connection is secure.- Specified by:
isSecure
in interfaceUpgradeRequest
- Returns:
- true if connection is secure.
-
isUserInRole
-
parseProtocols
-
setCookies
Description copied from interface:UpgradeRequest
Set the list of Cookies on the request- Specified by:
setCookies
in interfaceUpgradeRequest
- Parameters:
cookies
- the cookies to use
-
setExtensions
Description copied from interface:UpgradeRequest
Set the list of WebSocket Extension configurations on the request.- Specified by:
setExtensions
in interfaceUpgradeRequest
- Parameters:
configs
- the list of extension configurations
-
setHeader
Description copied from interface:UpgradeRequest
Set a specific header with multi-value fieldOverrides any previous value for this named header
- Specified by:
setHeader
in interfaceUpgradeRequest
- Parameters:
name
- the name of the headervalues
- the multi-value field
-
setHeader
Description copied from interface:UpgradeRequest
Set a specific header valueOverrides any previous value for this named header
- Specified by:
setHeader
in interfaceUpgradeRequest
- Parameters:
name
- the header to setvalue
- the value to set it to
-
setHeaders
Description copied from interface:UpgradeRequest
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
UpgradeRequest.setHeader(String, List)
multiple times.- Specified by:
setHeaders
in interfaceUpgradeRequest
- Parameters:
headers
- the headers to set
-
setHttpVersion
Description copied from interface:UpgradeRequest
Set the HTTP Version to use.As of RFC6455 (December 2011) this should always be
HTTP/1.1
- Specified by:
setHttpVersion
in interfaceUpgradeRequest
- Parameters:
httpVersion
- the HTTP version to use.
-
setMethod
Description copied from interface:UpgradeRequest
Set the HTTP method to use.As of RFC6455 (December 2011) this is always
GET
- Specified by:
setMethod
in interfaceUpgradeRequest
- Parameters:
method
- the HTTP method to use.
-
setRequestURI
Description copied from interface:UpgradeRequest
Set the Request URI to use for this request.Must be an absolute URI with scheme
'ws'
or'wss'
- Specified by:
setRequestURI
in interfaceUpgradeRequest
- Parameters:
uri
- the Request URI
-
setServletAttribute
-
setSession
Description copied from interface:UpgradeRequest
Set the Session associated with this request.Typically used to associate the Servlet HttpSession object.
- Specified by:
setSession
in interfaceUpgradeRequest
- Parameters:
session
- the session object to associate with this request
-
setSubProtocols
Description copied from interface:UpgradeRequest
Set the offered WebSocket Sub-Protocol list.- Specified by:
setSubProtocols
in interfaceUpgradeRequest
- Parameters:
subProtocols
- the offered sub-protocol list
-
setSubProtocols
Description copied from interface:UpgradeRequest
Set the offered WebSocket Sub-Protocol list.- Specified by:
setSubProtocols
in interfaceUpgradeRequest
- Parameters:
protocols
- the offered sub-protocol list
-
getUserPrincipal()
instead