Package org.eclipse.jetty.websocket.common

Class UpgradeRequestAdapter

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addExtensions​(java.lang.String... configs)  
      void addExtensions​(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig... configs)  
      void clearHeaders()  
      java.util.List<java.net.HttpCookie> getCookies()  
      java.util.List<org.eclipse.jetty.websocket.api.extensions.ExtensionConfig> getExtensions()  
      java.lang.String getHeader​(java.lang.String name)  
      int getHeaderInt​(java.lang.String name)  
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()  
      java.util.List<java.lang.String> getHeaders​(java.lang.String name)  
      java.lang.String getHost()  
      java.lang.String getHttpVersion()  
      java.lang.String getMethod()  
      java.lang.String getOrigin()  
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getParameterMap()
      Returns a map of the query parameters of the request.
      java.lang.String getProtocolVersion()  
      java.lang.String getQueryString()  
      java.net.URI getRequestURI()  
      java.lang.Object getSession()
      Access the Servlet HTTP Session (if present)
      java.util.List<java.lang.String> getSubProtocols()  
      java.security.Principal getUserPrincipal()
      Get the User Principal for this request.
      boolean hasSubProtocol​(java.lang.String test)  
      boolean isOrigin​(java.lang.String test)  
      boolean isSecure()  
      void setCookies​(java.util.List<java.net.HttpCookie> cookies)  
      void setExtensions​(java.util.List<org.eclipse.jetty.websocket.api.extensions.ExtensionConfig> configs)  
      void setHeader​(java.lang.String name, java.lang.String value)  
      void setHeader​(java.lang.String name, java.util.List<java.lang.String> values)  
      void setHeaders​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)  
      void setHttpVersion​(java.lang.String httpVersion)  
      void setMethod​(java.lang.String method)  
      protected void setParameterMap​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> parameters)  
      void setRequestURI​(java.net.URI uri)  
      void setSession​(java.lang.Object session)  
      void setSubProtocols​(java.lang.String... protocols)
      Set Sub Protocol request list.
      void setSubProtocols​(java.util.List<java.lang.String> subProtocols)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UpgradeRequestAdapter

        protected UpgradeRequestAdapter()

      • UpgradeRequestAdapter

        public UpgradeRequestAdapter​(java.lang.String requestURI)

      • UpgradeRequestAdapter

        public UpgradeRequestAdapter​(java.net.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​(java.lang.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 java.util.List<java.net.HttpCookie> getCookies()
        Specified by:
        getCookies in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getExtensions

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

      • getHeader

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

      • getHeaderInt

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

      • getHeaders

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

      • getHeaders

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

      • getHost

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

      • getHttpVersion

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

      • getMethod

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

      • getOrigin

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

      • getParameterMap

        public java.util.Map<java.lang.String,​java.util.List<java.lang.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 java.lang.String getProtocolVersion()
        Specified by:
        getProtocolVersion in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getQueryString

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

      • getRequestURI

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

      • getSession

        public java.lang.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 java.util.List<java.lang.String> getSubProtocols()
        Specified by:
        getSubProtocols in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • getUserPrincipal

        public java.security.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​(java.lang.String test)
        Specified by:
        hasSubProtocol in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • isOrigin

        public boolean isOrigin​(java.lang.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​(java.util.List<java.net.HttpCookie> cookies)
        Specified by:
        setCookies in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • setExtensions

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

      • setHeader

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

      • setHeader

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

      • setHeaders

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

      • setHttpVersion

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

      • setMethod

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

      • setParameterMap

        protected void setParameterMap​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> parameters)

      • setRequestURI

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

      • setSession

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

      • setSubProtocols

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

      • setSubProtocols

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