org.eclipse.jetty.ee10.websocket.server

public Interface JettyServerUpgradeRequest

Known Direct Implementers: org.eclipse.jetty.ee10.websocket.server.internal.DelegatedServerUpgradeRequest
Imports: java.net.InetSocketAddress, .SocketAddress, java.security.cert.X509Certificate, java.util.Enumeration, .List, .Locale, .Map, jakarta.servlet.ServletRequest, jakarta.servlet.http.HttpServletRequest, org.eclipse.jetty.websocket.api.UpgradeRequest

Method Summary

Modifier and Type	Method and Description
public X509Certificate[]	getCertificates() Returns: The `X509Certificate` instance at request attribute "jakarta.servlet.request.X509Certificate" or null.
public HttpServletRequest	getHttpServletRequest() Returns: Immutable version of `HttpServletRequest`
public Locale	getLocale() Returns: The requested Locale
public Enumeration<Locale>	getLocales() Returns: The requested Locales
public SocketAddress	getLocalSocketAddress() Returns: The local requested address, which is typically an `InetSocketAddress`, but may be another derivation of `SocketAddress`
public SocketAddress	getRemoteSocketAddress() Returns: The remote request address, which is typically an `InetSocketAddress`, but may be another derivation of `SocketAddress`
public String	getRequestPath() Returns: The request URI path within the context
public Object	getServletAttribute(String Attribute name name) Returns: Attribute value or null
public Map<String, Object>	getServletAttributes() Returns: Request attribute map
public Map<String, List<String>>	getServletParameters() Returns: Request parameters
public Object	Returns: the Servlet HTTPSession on server side UpgradeRequests getSession() Access the Servlet HTTP Session (if present) Note Never present on a Client UpgradeRequest.
public boolean	isUserInRole(String The user role role) Returns: True if the requests user has the role
public void	setServletAttribute(String Attribute name name, Object Attribute value to set value)

Inherited from org.eclipse.jetty.websocket.api.UpgradeRequest:: getCookies getExtensions getHeader getHeaderInt getHeaders getHeaders getHost getHttpVersion getMethod getOrigin getParameterMap getProtocolVersion getQueryString getRequestURI getSubProtocols getUserPrincipal hasSubProtocol isSecure

Method Detail

getCertificates	back to summary
public X509Certificate[] getCertificates() Returns:X509Certificate[] The `X509Certificate` instance at request attribute "jakarta.servlet.request.X509Certificate" or null.

getHttpServletRequest	back to summary
public HttpServletRequest getHttpServletRequest() Returns:HttpServletRequest Immutable version of `HttpServletRequest`

getLocale	back to summary
public Locale getLocale() Returns:Locale The requested Locale See Also `HttpServletRequest#getLocale()`

getLocales	back to summary
public Enumeration<Locale> getLocales() Returns:Enumeration<Locale> The requested Locales See Also `HttpServletRequest#getLocales()`

getLocalSocketAddress	back to summary
public SocketAddress getLocalSocketAddress() Returns:SocketAddress The local requested address, which is typically an `InetSocketAddress`, but may be another derivation of `SocketAddress` See Also `ServletRequest#getLocalAddr()`, `ServletRequest#getLocalPort()`

getRemoteSocketAddress	back to summary
public SocketAddress getRemoteSocketAddress() Returns:SocketAddress The remote request address, which is typically an `InetSocketAddress`, but may be another derivation of `SocketAddress` See Also `ServletRequest#getRemoteAddr()`, `ServletRequest#getRemotePort()`

getRequestPath	back to summary
public String getRequestPath() Returns:String The request URI path within the context

getServletAttribute	back to summary
public Object getServletAttribute(String name) Parameters name:String Attribute name Returns:Object Attribute value or null See Also `ServletRequest#getAttribute(String)`

getServletAttributes	back to summary
public Map<String, Object> getServletAttributes() Returns:Map<String, Object> Request attribute map

getServletParameters	back to summary
public Map<String, List<String>> getServletParameters() Returns:Map<String, List<String>> Request parameters See Also `ServletRequest#getParameterMap()`

getSession

back to summary

public Object getSession()

Access the Servlet HTTP Session (if present)

Note

Never present on a Client UpgradeRequest.

Returns:Object: the Servlet HTTPSession on server side UpgradeRequests

isUserInRole	back to summary
public boolean isUserInRole(String role) Parameters role:String The user role Returns:boolean True if the requests user has the role See Also `HttpServletRequest#isUserInRole(String)`

setServletAttribute	back to summary
public void setServletAttribute(String name, Object value) Parameters name:String Attribute name value:Object Attribute value to set See Also `ServletRequest#setAttribute(String, Object)`