Package org.eclipse.jetty.websocket.common

Class UpgradeRequestAdapter

  • All Implemented Interfaces:
    org.eclipse.jetty.websocket.api.UpgradeRequest
    public class UpgradeRequestAdapter
extends Object
implements org.eclipse.jetty.websocket.api.UpgradeRequest

    • Constructor Detail

      • UpgradeRequestAdapter

        protected UpgradeRequestAdapter()

      • UpgradeRequestAdapter

        public UpgradeRequestAdapter​(String requestURI)

      • UpgradeRequestAdapter

        public UpgradeRequestAdapter​(URI requestURI)

    • Method Detail

      • addExtensions

        public void addExtensions​(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig... configs)
        Specified by:
        addExtensions in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • addExtensions

        public void addExtensions​(String... configs)
        Specified by:
        addExtensions in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • clearHeaders

        public void clearHeaders()
        Specified by:
        clearHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getCookies

        public List<HttpCookie> getCookies()
        Specified by:
        getCookies in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getExtensions

        public List<org.eclipse.jetty.websocket.api.extensions.ExtensionConfig> getExtensions()
        Specified by:
        getExtensions in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHeader

        public String getHeader​(String name)
        Specified by:
        getHeader in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHeaderInt

        public int getHeaderInt​(String name)
        Specified by:
        getHeaderInt in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHeaders

        public Map<String,​List<String>> getHeaders()
        Specified by:
        getHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHeaders

        public List<String> getHeaders​(String name)
        Specified by:
        getHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHost

        public String getHost()
        Specified by:
        getHost in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getHttpVersion

        public String getHttpVersion()
        Specified by:
        getHttpVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getMethod

        public String getMethod()
        Specified by:
        getMethod in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getOrigin

        public String getOrigin()
        Specified by:
        getOrigin in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getParameterMap

        public Map<String,​List<String>> getParameterMap()
        Returns a map of the query parameters of the request.
        Specified by:
        getParameterMap in interface org.eclipse.jetty.websocket.api.UpgradeRequest
        Returns:
        a unmodifiable map of query parameters of the request.

      • getProtocolVersion

        public String getProtocolVersion()
        Specified by:
        getProtocolVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getQueryString

        public String getQueryString()
        Specified by:
        getQueryString in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getRequestURI

        public URI getRequestURI()
        Specified by:
        getRequestURI in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getSession

        public Object getSession()
        Access the Servlet HTTP Session (if present)

        Note: Never present on a Client UpgradeRequest.

        Specified by:
        getSession in interface org.eclipse.jetty.websocket.api.UpgradeRequest
        Returns:
        the Servlet HTTPSession on server side UpgradeRequests

      • getSubProtocols

        public List<String> getSubProtocols()
        Specified by:
        getSubProtocols in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getUserPrincipal

        public Principal getUserPrincipal()
        Get the User Principal for this request.

        Only applicable when using UpgradeRequest from server side.

        Specified by:
        getUserPrincipal in interface org.eclipse.jetty.websocket.api.UpgradeRequest
        Returns:
        the user principal

      • hasSubProtocol

        public boolean hasSubProtocol​(String test)
        Specified by:
        hasSubProtocol in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • isOrigin

        public boolean isOrigin​(String test)
        Specified by:
        isOrigin in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • isSecure

        public boolean isSecure()
        Specified by:
        isSecure in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setCookies

        public void setCookies​(List<HttpCookie> cookies)
        Specified by:
        setCookies in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setExtensions

        public void setExtensions​(List<org.eclipse.jetty.websocket.api.extensions.ExtensionConfig> configs)
        Specified by:
        setExtensions in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setHeader

        public void setHeader​(String name,
                      List<String> values)
        Specified by:
        setHeader in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setHeader

        public void setHeader​(String name,
                      String value)
        Specified by:
        setHeader in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setHeaders

        public void setHeaders​(Map<String,​List<String>> headers)
        Specified by:
        setHeaders in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setHttpVersion

        public void setHttpVersion​(String httpVersion)
        Specified by:
        setHttpVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setMethod

        public void setMethod​(String method)
        Specified by:
        setMethod in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setRequestURI

        public void setRequestURI​(URI uri)
        Specified by:
        setRequestURI in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setSession

        public void setSession​(Object session)
        Specified by:
        setSession in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setSubProtocols

        public void setSubProtocols​(List<String> subProtocols)
        Specified by:
        setSubProtocols in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setSubProtocols

        public void setSubProtocols​(String... protocols)
        Set Sub Protocol request list.
        Specified by:
        setSubProtocols in interface org.eclipse.jetty.websocket.api.UpgradeRequest
        Parameters:
        protocols - the sub protocols desired