Module org.eclipse.jetty.websocket.jetty.client
Package org.eclipse.jetty.websocket.client

Class ClientUpgradeRequest

  • All Implemented Interfaces:
    org.eclipse.jetty.websocket.api.UpgradeRequest
    public final class ClientUpgradeRequest
extends java.lang.Object
implements org.eclipse.jetty.websocket.api.UpgradeRequest
    Client based UpgradeRequest API

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ABNF_REQUIRED_QUOTING
      ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.

    • Method Summary

      All Methods Static 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)  
      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()  
      java.util.List<java.lang.String> getSubProtocols()  
      java.security.Principal getUserPrincipal()  
      boolean hasSubProtocol​(java.lang.String test)  
      boolean isSecure()  
      static java.lang.String joinValues​(java.util.List<java.lang.String> values)  
      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 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

    • Field Detail

      • ABNF_REQUIRED_QUOTING

        public static final java.lang.String ABNF_REQUIRED_QUOTING
        ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ClientUpgradeRequest

        public ClientUpgradeRequest()

      • ClientUpgradeRequest

        public ClientUpgradeRequest​(java.net.URI uri)

    • 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

      • getCookies

        public java.util.List<java.net.HttpCookie> getCookies()
        Specified by:
        getCookies 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

      • getExtensions

        public java.util.List<org.eclipse.jetty.websocket.api.extensions.ExtensionConfig> getExtensions()
        Specified by:
        getExtensions 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

      • 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()
        Specified by:
        getSession in interface org.eclipse.jetty.websocket.api.UpgradeRequest

      • 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()
        Specified by:
        getUserPrincipal 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

      • setSubProtocols

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

      • hasSubProtocol

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

      • isSecure

        public boolean isSecure()
        Specified by:
        isSecure 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

      • setSession

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

      • joinValues

        public static java.lang.String joinValues​(java.util.List<java.lang.String> values)