Package org.eclipse.jetty.websocket.servlet

Class ServletUpgradeRequest

    • Method Detail

      • addExtensions

        public void addExtensions​(String... configs)
        Deprecated.
        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

      • complete

        public void complete()
        Deprecated.

      • getExtensions

        public List<ExtensionConfig> getExtensions()
        Deprecated.
        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)
        Deprecated.
        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)
        Deprecated.
        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 List<String> getHeaders​(String name)
        Deprecated.
        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()
        Deprecated.
        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()
        Deprecated.
        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

      • getLocalSocketAddress

        public InetSocketAddress getLocalSocketAddress()
        Deprecated.
        Return a InetSocketAddress for the local socket.

        Warning: this can cause a DNS lookup

        Returns:
        the local socket address

      • getParameterMap

        public Map<String,​List<String>> getParameterMap()
        Deprecated.
        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.

      • getProtocolVersion

        public String getProtocolVersion()
        Deprecated.
        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()
        Deprecated.
        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

      • getRemoteSocketAddress

        public InetSocketAddress getRemoteSocketAddress()
        Deprecated.
        Return a InetSocketAddress for the remote socket.

        Warning: this can cause a DNS lookup

        Returns:
        the remote socket address

      • getRequestPath

        public String getRequestPath()
        Deprecated.

      • getServletAttribute

        public Object getServletAttribute​(String name)
        Deprecated.

      • getServletAttributes

        public Map<String,​Object> getServletAttributes()
        Deprecated.

      • getSubProtocols

        public List<String> getSubProtocols()
        Deprecated.
        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

      • hasSubProtocol

        public boolean hasSubProtocol​(String test)
        Deprecated.
        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)
        Deprecated.
        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()
        Deprecated.
        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)
        Deprecated.

      • setCookies

        public void setCookies​(List<HttpCookie> cookies)
        Deprecated.
        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)
        Deprecated.
        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)
        Deprecated.
        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)
        Deprecated.
        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)
        Deprecated.
        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

      • setRequestURI

        public void setRequestURI​(URI uri)
        Deprecated.
        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)
        Deprecated.

      • setSession

        public void setSession​(Object session)
        Deprecated.
        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)
        Deprecated.
        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)
        Deprecated.
        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