ServletUpgradeRequest (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

java.lang.Object
- org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest

All Implemented Interfaces:

UpgradeRequest

Direct Known Subclasses:

ServletWebSocketRequest
```
public class ServletUpgradeRequest
extends Object
implements UpgradeRequest
```
Servlet specific UpgradeRequest implementation.

Constructor Summary

Constructors
Constructor and Description

ServletUpgradeRequest(HttpServletRequest httpRequest)

Constructors
Constructor and Description
`ServletUpgradeRequest(HttpServletRequest httpRequest)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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()` Remove all headers from request.
`void`	`complete()`
`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
`HttpServletRequest`	`getHttpServletRequest()` Return the underlying HttpServletRequest that existed at Upgrade time.
`String`	`getHttpVersion()` The HTTP version used for this Upgrade Request
`String`	`getLocalAddress()` Equivalent to `ServletRequest.getLocalAddr()`
`Locale`	`getLocale()` Equivalent to `ServletRequest.getLocale()`
`Enumeration<Locale>`	`getLocales()` Equivalent to `ServletRequest.getLocales()`
`String`	`getLocalHostName()` Equivalent to `ServletRequest.getLocalName()`
`int`	`getLocalPort()` Equivalent to `ServletRequest.getLocalPort()`
`InetSocketAddress`	`getLocalSocketAddress()` Return a `InetSocketAddress` for the local socket.
`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.
`Principal`	`getPrincipal()` Deprecated. use `getUserPrincipal()` instead
`String`	`getProtocolVersion()` Get the WebSocket Protocol Version
`String`	`getQueryString()` Get the Query String of the request URI.
`String`	`getRemoteAddress()` Equivalent to `ServletRequest.getRemoteAddr()`
`String`	`getRemoteHostName()` Equivalent to `ServletRequest.getRemoteHost()`
`int`	`getRemotePort()` Equivalent to `ServletRequest.getRemotePort()`
`InetSocketAddress`	`getRemoteSocketAddress()` Return a `InetSocketAddress` for the remote socket.
`String`	`getRequestPath()`
`URI`	`getRequestURI()` Get the Request URI
`Object`	`getServletAttribute(String name)`
`Map<String,Object>`	`getServletAttributes()`
`Map<String,List<String>>`	`getServletParameters()`
`HttpSession`	`getSession()` Return the HttpSession if it exists.
`List<String>`	`getSubProtocols()` Get the list of offered WebSocket sub-protocols.
`Principal`	`getUserPrincipal()` Equivalent to `HttpServletRequest.getUserPrincipal()`
`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.
`boolean`	`isUserInRole(String role)`
`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`	`setServletAttribute(String name, Object value)`
`void`	`setSession(Object session)` Set the Session associated with this request.
`void`	`setSubProtocols(List<String> subProtocols)` Set the offered WebSocket Sub-Protocol list.
`void`	`setSubProtocols(String... protocols)` Set the offered WebSocket Sub-Protocol list.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletUpgradeRequest
```
public ServletUpgradeRequest(HttpServletRequest httpRequest)
                      throws URISyntaxException
```
    Throws:
    
    URISyntaxException
- Method Detail
  - addExtensions
```
public void addExtensions(ExtensionConfig... configs)
```
    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 interface UpgradeRequest
    
    Parameters:
    
    configs - the configuration(s) to add
  - addExtensions
```
public void addExtensions(String... configs)
```
    Description copied from interface: UpgradeRequest
    
    Add WebSocket Extension Configuration(s) to request
    This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions() for what was negotiated
    
    Specified by:
    
    addExtensions in interface UpgradeRequest
    
    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 interface UpgradeRequest
  - complete
```
public void complete()
```
  - getCertificates
```
public X509Certificate[] getCertificates()
```
  - 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
  - getHttpServletRequest
```
public 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
```
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
  - getLocalAddress
```
public String getLocalAddress()
```
    Equivalent to ServletRequest.getLocalAddr()
    
    Returns:
    
    the local address
  - getLocale
```
public Locale getLocale()
```
    Equivalent to ServletRequest.getLocale()
    
    Returns:
    
    the preferred Locale for the client
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Equivalent to ServletRequest.getLocales()
    
    Returns:
    
    an Enumeration of preferred Locale objects
  - getLocalHostName
```
public String getLocalHostName()
```
    Equivalent to ServletRequest.getLocalName()
    
    Returns:
    
    the local host name
  - getLocalPort
```
public int getLocalPort()
```
    Equivalent to ServletRequest.getLocalPort()
    
    Returns:
    
    the local port
  - getLocalSocketAddress
```
public InetSocketAddress getLocalSocketAddress()
```
    Return a InetSocketAddress for the local socket.
    Warning: this can cause a DNS lookup
    
    Returns:
    
    the local socket address
  - 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.
  - getPrincipal
```
@Deprecated
public Principal getPrincipal()
```
    Deprecated. use getUserPrincipal() instead
    
    Returns:
    
    the principal
  - 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
  - getRemoteAddress
```
public String getRemoteAddress()
```
    Equivalent to ServletRequest.getRemoteAddr()
    
    Returns:
    
    the remote address
  - getRemoteHostName
```
public String getRemoteHostName()
```
    Equivalent to ServletRequest.getRemoteHost()
    
    Returns:
    
    the remote host name
  - getRemotePort
```
public int getRemotePort()
```
    Equivalent to ServletRequest.getRemotePort()
    
    Returns:
    
    the remote port
  - getRemoteSocketAddress
```
public InetSocketAddress getRemoteSocketAddress()
```
    Return a InetSocketAddress for the remote socket.
    Warning: this can cause a DNS lookup
    
    Returns:
    
    the remote socket address
  - getRequestPath
```
public String getRequestPath()
```
  - getRequestURI
```
public URI getRequestURI()
```
    Description copied from interface: UpgradeRequest
    
    Get the Request URI
    
    Specified by:
    
    getRequestURI in interface UpgradeRequest
    
    Returns:
    
    the request URI
  - getServletAttribute
```
public Object getServletAttribute(String name)
```
  - getServletAttributes
```
public Map<String,Object> getServletAttributes()
```
  - getServletParameters
```
public Map<String,List<String>> getServletParameters()
```
  - getSession
```
public 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 interface UpgradeRequest
    
    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()
```
    Equivalent to HttpServletRequest.getUserPrincipal()
    
    Specified by:
    
    getUserPrincipal in interface UpgradeRequest
    
    Returns:
    
    the user principal
  - hasSubProtocol
```
public boolean hasSubProtocol(String test)
```
    Description copied from interface: UpgradeRequest
    
    Test if a specific sub-protocol is offered
    
    Specified by:
    
    hasSubProtocol in interface UpgradeRequest
    
    Parameters:
    
    test - the sub-protocol to test for
    
    Returns:
    
    true if sub-protocol exists on request
  - isOrigin
```
public boolean isOrigin(String test)
```
    Description copied from interface: UpgradeRequest
    
    Test if supplied Origin is the same as the Request
    
    Specified by:
    
    isOrigin in interface UpgradeRequest
    
    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 interface UpgradeRequest
    
    Returns:
    
    true if connection is secure.
  - isUserInRole
```
public boolean isUserInRole(String role)
```
  - setCookies
```
public void setCookies(List<HttpCookie> cookies)
```
    Description copied from interface: UpgradeRequest
    
    Set the list of Cookies on the request
    
    Specified by:
    
    setCookies in interface UpgradeRequest
    
    Parameters:
    
    cookies - the cookies to use
  - setExtensions
```
public void setExtensions(List<ExtensionConfig> configs)
```
    Description copied from interface: UpgradeRequest
    
    Set the list of WebSocket Extension configurations on the request.
    
    Specified by:
    
    setExtensions in interface UpgradeRequest
    
    Parameters:
    
    configs - the list of extension configurations
  - setHeader
```
public void setHeader(String name,
                      List<String> values)
```
    Description copied from interface: UpgradeRequest
    
    Set a specific header with multi-value field
    Overrides any previous value for this named header
    
    Specified by:
    
    setHeader in interface UpgradeRequest
    
    Parameters:
    
    name - the name of the header
    
    values - the multi-value field
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Description copied from interface: UpgradeRequest
    
    Set a specific header value
    Overrides any previous value for this named header
    
    Specified by:
    
    setHeader in interface UpgradeRequest
    
    Parameters:
    
    name - the header to set
    
    value - the value to set it to
  - setHeaders
```
public void setHeaders(Map<String,List<String>> headers)
```
    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 interface UpgradeRequest
    
    Parameters:
    
    headers - the headers to set
  - setHttpVersion
```
public void setHttpVersion(String httpVersion)
```
    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 interface UpgradeRequest
    
    Parameters:
    
    httpVersion - the HTTP version to use.
  - setMethod
```
public void setMethod(String method)
```
    Description copied from interface: UpgradeRequest
    
    Set the HTTP method to use.
    As of RFC6455 (December 2011) this is always GET
    
    Specified by:
    
    setMethod in interface UpgradeRequest
    
    Parameters:
    
    method - the HTTP method to use.
  - setRequestURI
```
public void setRequestURI(URI uri)
```
    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 interface UpgradeRequest
    
    Parameters:
    
    uri - the Request URI
  - setServletAttribute
```
public void setServletAttribute(String name,
                                Object value)
```
  - setSession
```
public void setSession(Object session)
```
    Description copied from interface: UpgradeRequest
    
    Set the Session associated with this request.
    Typically used to associate the Servlet HttpSession object.
    
    Specified by:
    
    setSession in interface UpgradeRequest
    
    Parameters:
    
    session - the session object to associate with this request
  - setSubProtocols
```
public void setSubProtocols(List<String> subProtocols)
```
    Description copied from interface: UpgradeRequest
    
    Set the offered WebSocket Sub-Protocol list.
    
    Specified by:
    
    setSubProtocols in interface UpgradeRequest
    
    Parameters:
    
    subProtocols - the offered sub-protocol list
  - setSubProtocols
```
public void setSubProtocols(String... protocols)
```
    Description copied from interface: UpgradeRequest
    
    Set the offered WebSocket Sub-Protocol list.
    
    Specified by:
    
    setSubProtocols in interface UpgradeRequest
    
    Parameters:
    
    protocols - the offered sub-protocol list

Class ServletUpgradeRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServletUpgradeRequest

Method Detail

addExtensions

addExtensions

clearHeaders

complete

getCertificates

getCookies

getExtensions

getHeader

getHeaderInt

getHeaders

getHeaders

getHost

getHttpServletRequest

getHttpVersion

getLocalAddress

getLocale

getLocales

getLocalHostName

getLocalPort

getLocalSocketAddress

getMethod

getOrigin

getParameterMap

getPrincipal

getProtocolVersion

getQueryString

getRemoteAddress

getRemoteHostName

getRemotePort

getRemoteSocketAddress

getRequestPath

getRequestURI

getServletAttribute

getServletAttributes

getServletParameters

getSession

getSubProtocols

getUserPrincipal

hasSubProtocol

isOrigin

isSecure

isUserInRole

setCookies

setExtensions

setHeader

setHeader

setHeaders

setHttpVersion

setMethod

setRequestURI

setServletAttribute

setSession

setSubProtocols

setSubProtocols