Class ServletUpgradeRequest
java.lang.Object
org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest
- All Implemented Interfaces:
UpgradeRequest
Servlet specific
UpgradeRequest implementation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddExtensions(String... configs) voidaddExtensions(ExtensionConfig... configs) voidvoidcomplete()intgetHeaderInt(String name) getHeaders(String name) getHost()javax.servlet.http.HttpServletRequestReturn the underlying HttpServletRequest that existed at Upgrade time.Equivalent toServletRequest.getLocalAddr()Equivalent toServletRequest.getLocale()Equivalent toServletRequest.getLocales()Equivalent toServletRequest.getLocalName()intEquivalent toServletRequest.getLocalPort()Return aInetSocketAddressfor the local socket.Deprecated.Equivalent toServletRequest.getRemoteAddr()Equivalent toServletRequest.getRemoteHost()intEquivalent toServletRequest.getRemotePort()Return aInetSocketAddressfor the remote socket.getServletAttribute(String name) javax.servlet.http.HttpSessionReturn the HttpSession if it exists.Equivalent toHttpServletRequest.getUserPrincipal()booleanhasSubProtocol(String test) booleanbooleanisSecure()booleanisUserInRole(String role) voidsetCookies(List<HttpCookie> cookies) voidsetExtensions(List<ExtensionConfig> configs) voidvoidvoidsetHeaders(Map<String, List<String>> headers) voidsetHttpVersion(String httpVersion) voidvoidsetRequestURI(URI uri) voidsetServletAttribute(String name, Object value) voidsetSession(Object session) voidsetSubProtocols(String... protocols) voidsetSubProtocols(List<String> subProtocols)
-
Constructor Details
-
ServletUpgradeRequest
public ServletUpgradeRequest(javax.servlet.http.HttpServletRequest httpRequest) throws URISyntaxException - Throws:
URISyntaxException
-
-
Method Details
-
addExtensions
- Specified by:
addExtensionsin interfaceUpgradeRequest
-
addExtensions
- Specified by:
addExtensionsin interfaceUpgradeRequest
-
clearHeaders
public void clearHeaders()- Specified by:
clearHeadersin interfaceUpgradeRequest
-
complete
public void complete() -
getCertificates
-
getCookies
- Specified by:
getCookiesin interfaceUpgradeRequest
-
getExtensions
- Specified by:
getExtensionsin interfaceUpgradeRequest
-
getHeader
- Specified by:
getHeaderin interfaceUpgradeRequest
-
getHeaderInt
- Specified by:
getHeaderIntin interfaceUpgradeRequest
-
getHeaders
- Specified by:
getHeadersin interfaceUpgradeRequest
-
getHeaders
- Specified by:
getHeadersin interfaceUpgradeRequest
-
getHost
- Specified by:
getHostin interfaceUpgradeRequest
-
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
- Specified by:
getHttpVersionin interfaceUpgradeRequest
-
getLocalAddress
Equivalent toServletRequest.getLocalAddr()- Returns:
- the local address
-
getLocale
Equivalent toServletRequest.getLocale()- Returns:
- the preferred
Localefor 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 aInetSocketAddressfor the local socket.Warning: this can cause a DNS lookup
- Returns:
- the local socket address
-
getMethod
- Specified by:
getMethodin interfaceUpgradeRequest
-
getOrigin
- Specified by:
getOriginin interfaceUpgradeRequest
-
getParameterMap
- Specified by:
getParameterMapin interfaceUpgradeRequest
-
getPrincipal
Deprecated.usegetUserPrincipal()instead- Returns:
- the principal
-
getProtocolVersion
- Specified by:
getProtocolVersionin interfaceUpgradeRequest
-
getQueryString
- Specified by:
getQueryStringin interfaceUpgradeRequest
-
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 aInetSocketAddressfor the remote socket.Warning: this can cause a DNS lookup
- Returns:
- the remote socket address
-
getRequestPath
-
getRequestURI
- Specified by:
getRequestURIin interfaceUpgradeRequest
-
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:
getSessionin interfaceUpgradeRequest
-
getSubProtocols
- Specified by:
getSubProtocolsin interfaceUpgradeRequest
-
getUserPrincipal
Equivalent toHttpServletRequest.getUserPrincipal()- Specified by:
getUserPrincipalin interfaceUpgradeRequest
-
hasSubProtocol
- Specified by:
hasSubProtocolin interfaceUpgradeRequest
-
isOrigin
- Specified by:
isOriginin interfaceUpgradeRequest
-
isSecure
public boolean isSecure()- Specified by:
isSecurein interfaceUpgradeRequest
-
isUserInRole
-
setCookies
- Specified by:
setCookiesin interfaceUpgradeRequest
-
setExtensions
- Specified by:
setExtensionsin interfaceUpgradeRequest
-
setHeader
- Specified by:
setHeaderin interfaceUpgradeRequest
-
setHeader
- Specified by:
setHeaderin interfaceUpgradeRequest
-
setHeaders
- Specified by:
setHeadersin interfaceUpgradeRequest
-
setHttpVersion
- Specified by:
setHttpVersionin interfaceUpgradeRequest
-
setMethod
- Specified by:
setMethodin interfaceUpgradeRequest
-
setRequestURI
- Specified by:
setRequestURIin interfaceUpgradeRequest
-
setServletAttribute
-
setSession
- Specified by:
setSessionin interfaceUpgradeRequest
-
setSubProtocols
- Specified by:
setSubProtocolsin interfaceUpgradeRequest
-
setSubProtocols
- Specified by:
setSubProtocolsin interfaceUpgradeRequest
-
getUserPrincipal()instead