Module org.eclipse.jetty.websocket.jetty.server
Package org.eclipse.jetty.websocket.server

Interface JettyServerUpgradeRequest

  • All Superinterfaces:
    org.eclipse.jetty.websocket.api.UpgradeRequest
    public interface JettyServerUpgradeRequest
extends org.eclipse.jetty.websocket.api.UpgradeRequest

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.security.cert.X509Certificate[] getCertificates()  
      jakarta.servlet.http.HttpServletRequest getHttpServletRequest()  
      java.util.Locale getLocale()  
      java.util.Enumeration<java.util.Locale> getLocales()  
      java.net.SocketAddress getLocalSocketAddress()  
      java.net.SocketAddress getRemoteSocketAddress()  
      java.lang.String getRequestPath()  
      java.lang.Object getServletAttribute​(java.lang.String name)  
      java.util.Map<java.lang.String,​java.lang.Object> getServletAttributes()  
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getServletParameters()  
      java.lang.Object getSession()
      Access the Servlet HTTP Session (if present)
      boolean isUserInRole​(java.lang.String role)  
      void setServletAttribute​(java.lang.String name, java.lang.Object value)  

      • Methods inherited from interface 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

      • getSession

        java.lang.Object getSession()
        Access the Servlet HTTP Session (if present)

        Note: Never present on a Client UpgradeRequest.

        Returns:
        the Servlet HTTPSession on server side UpgradeRequests

      • getCertificates

        java.security.cert.X509Certificate[] getCertificates()
        Returns:
        The X509Certificate instance at request attribute "jakarta.servlet.request.X509Certificate" or null.

      • getHttpServletRequest

        jakarta.servlet.http.HttpServletRequest getHttpServletRequest()
        Returns:
        Immutable version of HttpServletRequest

      • getLocale

        java.util.Locale getLocale()
        Returns:
        The requested Locale
        See Also:
        ServletRequest.getLocale()

      • getLocales

        java.util.Enumeration<java.util.Locale> getLocales()
        Returns:
        The requested Locales
        See Also:
        ServletRequest.getLocales()

      • getLocalSocketAddress

        java.net.SocketAddress getLocalSocketAddress()
        Returns:
        The local requested address, which is typically an InetSocketAddress, but may be another derivation of SocketAddress
        See Also:
        ServletRequest.getLocalAddr(), ServletRequest.getLocalPort()

      • getRemoteSocketAddress

        java.net.SocketAddress getRemoteSocketAddress()
        Returns:
        The remote request address, which is typically an InetSocketAddress, but may be another derivation of SocketAddress
        See Also:
        ServletRequest.getRemoteAddr(), ServletRequest.getRemotePort()

      • getRequestPath

        java.lang.String getRequestPath()
        Returns:
        The request URI path within the context

      • getServletAttribute

        java.lang.Object getServletAttribute​(java.lang.String name)
        Parameters:
        name - Attribute name
        Returns:
        Attribute value or null
        See Also:
        ServletRequest.getAttribute(String)

      • getServletAttributes

        java.util.Map<java.lang.String,​java.lang.Object> getServletAttributes()
        Returns:
        Request attribute map

      • getServletParameters

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getServletParameters()
        Returns:
        Request parameters
        See Also:
        ServletRequest.getParameterMap()

      • isUserInRole

        boolean isUserInRole​(java.lang.String role)
        Parameters:
        role - The user role
        Returns:
        True if the requests user has the role
        See Also:
        HttpServletRequest.isUserInRole(String)

      • setServletAttribute

        void setServletAttribute​(java.lang.String name,
                         java.lang.Object value)
        Parameters:
        name - Attribute name
        value - Attribute value to set
        See Also:
        ServletRequest.setAttribute(String, Object)