ServletUpgradeRequest (Jetty :: Websocket :: Servlet Interface 9.4.6.v20170531 API)

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

All Implemented Interfaces:

UpgradeRequest
```
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)`
`void`	`addExtensions(String... configs)`
`void`	`clearHeaders()`
`void`	`complete()`
`X509Certificate[]`	`getCertificates()`
`List<HttpCookie>`	`getCookies()`
`List<ExtensionConfig>`	`getExtensions()`
`String`	`getHeader(String name)`
`int`	`getHeaderInt(String name)`
`Map<String,List<String>>`	`getHeaders()`
`List<String>`	`getHeaders(String name)`
`String`	`getHost()`
`HttpServletRequest`	`getHttpServletRequest()` Return the underlying HttpServletRequest that existed at Upgrade time.
`String`	`getHttpVersion()`
`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()`
`String`	`getOrigin()`
`Map<String,List<String>>`	`getParameterMap()`
`Principal`	`getPrincipal()` Deprecated. use `getUserPrincipal()` instead
`String`	`getProtocolVersion()`
`String`	`getQueryString()`
`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()`
`Object`	`getServletAttribute(String name)`
`Map<String,Object>`	`getServletAttributes()`
`Map<String,List<String>>`	`getServletParameters()`
`HttpSession`	`getSession()` Return the HttpSession if it exists.
`List<String>`	`getSubProtocols()`
`Principal`	`getUserPrincipal()` Equivalent to `HttpServletRequest.getUserPrincipal()`
`boolean`	`hasSubProtocol(String test)`
`boolean`	`isOrigin(String test)`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`setCookies(List<HttpCookie> cookies)`
`void`	`setExtensions(List<ExtensionConfig> configs)`
`void`	`setHeader(String name, List<String> values)`
`void`	`setHeader(String name, String value)`
`void`	`setHeaders(Map<String,List<String>> headers)`
`void`	`setHttpVersion(String httpVersion)`
`void`	`setMethod(String method)`
`void`	`setRequestURI(URI uri)`
`void`	`setServletAttribute(String name, Object value)`
`void`	`setSession(Object session)`
`void`	`setSubProtocols(List<String> subProtocols)`
`void`	`setSubProtocols(String... protocols)`

Methods inherited from class java.lang.Object
clone, equals, finalize, 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)
```
    Specified by:
    
    addExtensions in interface UpgradeRequest
  - addExtensions
```
public void addExtensions(String... configs)
```
    Specified by:
    
    addExtensions in interface UpgradeRequest
  - clearHeaders
```
public void clearHeaders()
```
    Specified by:
    
    clearHeaders in interface UpgradeRequest
  - complete
```
public void complete()
```
  - getCertificates
```
public X509Certificate[] getCertificates()
```
  - getCookies
```
public List<HttpCookie> getCookies()
```
    Specified by:
    
    getCookies in interface UpgradeRequest
  - getExtensions
```
public List<ExtensionConfig> getExtensions()
```
    Specified by:
    
    getExtensions in interface UpgradeRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface UpgradeRequest
  - getHeaderInt
```
public int getHeaderInt(String name)
```
    Specified by:
    
    getHeaderInt in interface UpgradeRequest
  - getHeaders
```
public Map<String,List<String>> getHeaders()
```
    Specified by:
    
    getHeaders in interface UpgradeRequest
  - getHeaders
```
public List<String> getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface UpgradeRequest
  - getHost
```
public String getHost()
```
    Specified by:
    
    getHost in interface UpgradeRequest
  - 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()
```
    Specified by:
    
    getHttpVersion in interface UpgradeRequest
  - 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()
```
    Specified by:
    
    getMethod in interface UpgradeRequest
  - getOrigin
```
public String getOrigin()
```
    Specified by:
    
    getOrigin in interface UpgradeRequest
  - getParameterMap
```
public Map<String,List<String>> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface UpgradeRequest
  - getPrincipal
```
@Deprecated
public Principal getPrincipal()
```
    Deprecated. use getUserPrincipal() instead
    
    Returns:
    
    the principal
  - getProtocolVersion
```
public String getProtocolVersion()
```
    Specified by:
    
    getProtocolVersion in interface UpgradeRequest
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface UpgradeRequest
  - 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()
```
    Specified by:
    
    getRequestURI in interface UpgradeRequest
  - 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
  - getSubProtocols
```
public List<String> getSubProtocols()
```
    Specified by:
    
    getSubProtocols in interface UpgradeRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Equivalent to HttpServletRequest.getUserPrincipal()
    
    Specified by:
    
    getUserPrincipal 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
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface UpgradeRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
  - setCookies
```
public void setCookies(List<HttpCookie> cookies)
```
    Specified by:
    
    setCookies in interface UpgradeRequest
  - setExtensions
```
public void setExtensions(List<ExtensionConfig> configs)
```
    Specified by:
    
    setExtensions in interface UpgradeRequest
  - setHeader
```
public void setHeader(String name,
                      List<String> values)
```
    Specified by:
    
    setHeader in interface UpgradeRequest
  - setHeader
```
public void setHeader(String name,
                      String value)
```
    Specified by:
    
    setHeader in interface UpgradeRequest
  - setHeaders
```
public void setHeaders(Map<String,List<String>> headers)
```
    Specified by:
    
    setHeaders in interface UpgradeRequest
  - setHttpVersion
```
public void setHttpVersion(String httpVersion)
```
    Specified by:
    
    setHttpVersion in interface UpgradeRequest
  - setMethod
```
public void setMethod(String method)
```
    Specified by:
    
    setMethod in interface UpgradeRequest
  - setRequestURI
```
public void setRequestURI(URI uri)
```
    Specified by:
    
    setRequestURI in interface UpgradeRequest
  - setServletAttribute
```
public void setServletAttribute(String name,
                                Object value)
```
  - setSession
```
public void setSession(Object session)
```
    Specified by:
    
    setSession in interface UpgradeRequest
  - setSubProtocols
```
public void setSubProtocols(List<String> subProtocols)
```
    Specified by:
    
    setSubProtocols in interface UpgradeRequest
  - setSubProtocols
```
public void setSubProtocols(String... protocols)
```
    Specified by:
    
    setSubProtocols in interface UpgradeRequest

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