public interface UpgradeRequest
Modifier and Type | Method and Description |
---|---|
void |
addExtensions(ExtensionConfig... configs)
Add WebSocket Extension Configuration(s) to Upgrade Request.
|
void |
addExtensions(String... configs)
Add WebSocket Extension Configuration(s) to request
|
void |
clearHeaders()
Deprecated.
(no longer supported, as this can undo the required upgrade request headers)
|
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
|
String |
getHttpVersion()
The HTTP version used for this Upgrade Request
|
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.
|
URI |
getRequestURI()
Get the Request URI
|
Object |
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 test)
Test if a specific sub-protocol is offered
|
boolean |
isOrigin(String test)
Test if supplied Origin is the same as the Request
|
boolean |
isSecure()
Test if connection is secure.
|
void |
setCookies(List<HttpCookie> cookies)
Set the list of Cookies on the request
|
void |
setExtensions(List<ExtensionConfig> configs)
Set the list of WebSocket Extension configurations on the request.
|
void |
setHeader(String name,
List<String> values)
Set a specific header with multi-value field
|
void |
setHeader(String name,
String value)
Set a specific header value
|
void |
setHeaders(Map<String,List<String>> headers)
Sets multiple headers on the request.
|
void |
setHttpVersion(String httpVersion)
Set the HTTP Version to use.
|
void |
setMethod(String method)
Set the HTTP method to use.
|
void |
setRequestURI(URI uri)
Set the Request URI to use for this request.
|
void |
setSession(Object session)
Set the Session associated with this request.
|
void |
setSubProtocols(List<String> protocols)
Set the offered WebSocket Sub-Protocol list.
|
void |
setSubProtocols(String... protocols)
Set the offered WebSocket Sub-Protocol list.
|
void addExtensions(ExtensionConfig... configs)
This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions()
for what was
negotiated
configs
- the configuration(s) to addvoid addExtensions(String... configs)
This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions()
for what was
negotiated
configs
- the configuration(s) to add@Deprecated void clearHeaders()
List<HttpCookie> getCookies()
List<ExtensionConfig> getExtensions()
This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions()
for what was
negotiated
String getHeader(String name)
name
- the name of the headerint getHeaderInt(String name)
int
, from the Upgrade Request.name
- the name of the headerint
(-1 if header does not exist)NumberFormatException
- if unable to parse value as an int.Map<String,List<String>> getHeaders()
List<String> getHeaders(String name)
name
- the header nameString getHost()
String getHttpVersion()
As of RFC6455 (December 2011) this is always
HTTP/1.1
String getMethod()
As of RFC6455 (December 2011) this is always GET
String getOrigin()
See RFC6455: Section 10.2 for details.
Equivalent to getHeader(String)
passed the "Origin" header.
Map<String,List<String>> getParameterMap()
String getProtocolVersion()
As of RFC6455, Jetty only supports version
13
String getQueryString()
URI getRequestURI()
Object getSession()
Note: Never present on a Client UpgradeRequest.
List<String> getSubProtocols()
Principal getUserPrincipal()
Only applicable when using UpgradeRequest from server side.
boolean hasSubProtocol(String test)
test
- the sub-protocol to test forboolean isOrigin(String test)
test
- the supplied originboolean isSecure()
void setCookies(List<HttpCookie> cookies)
cookies
- the cookies to usevoid setExtensions(List<ExtensionConfig> configs)
configs
- the list of extension configurationsvoid setHeader(String name, List<String> values)
Overrides any previous value for this named header
name
- the name of the headervalues
- the multi-value fieldvoid setHeader(String name, String value)
Overrides any previous value for this named header
name
- the header to setvalue
- the value to set it tovoid setHeaders(Map<String,List<String>> headers)
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 setHeader(String, List)
multiple times.
headers
- the headers to setvoid setHttpVersion(String httpVersion)
As of RFC6455 (December 2011) this should always be
HTTP/1.1
httpVersion
- the HTTP version to use.void setMethod(String method)
As of RFC6455 (December 2011) this is always GET
method
- the HTTP method to use.void setRequestURI(URI uri)
Must be an absolute URI with scheme 'ws'
or 'wss'
uri
- the Request URIvoid setSession(Object session)
Typically used to associate the Servlet HttpSession object.
session
- the session object to associate with this requestvoid setSubProtocols(List<String> protocols)
protocols
- the offered sub-protocol listvoid setSubProtocols(String... protocols)
protocols
- the offered sub-protocol listCopyright © 2010 - 2020 Adobe. All Rights Reserved