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)
      Add WebSocket Extension Configuration(s) to request
      void addExtensions​(org.eclipse.jetty.websocket.api.ExtensionConfig... configs)
      Add WebSocket Extension Configuration(s) to Upgrade Request.
      java.util.List<java.net.HttpCookie> getCookies()  
      java.util.List<org.eclipse.jetty.websocket.api.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()  
      java.lang.String getProtocolVersion()  
      java.lang.String getQueryString()  
      java.net.URI getRequestURI()  
      java.util.List<java.lang.String> getSubProtocols()  
      long getTimeout()  
      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)
      Set the list of Cookies on the request
      void setExtensions​(java.util.List<org.eclipse.jetty.websocket.api.ExtensionConfig> configs)
      Set the list of WebSocket Extension configurations on the request.
      void setHeader​(java.lang.String name, java.lang.String value)
      Set a specific header value
      void setHeader​(java.lang.String name, java.util.List<java.lang.String> values)
      Set a specific header with multi-value field
      void setHeaders​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)
      Sets multiple headers on the request.
      void setSubProtocols​(java.lang.String... protocols)
      Set the offered WebSocket Sub-Protocol list.
      void setSubProtocols​(java.util.List<java.lang.String> protocols)
      Set the offered WebSocket Sub-Protocol list.
      void setTimeout​(long timeout, java.util.concurrent.TimeUnit unit)  

      • 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

        @Deprecated
public ClientUpgradeRequest​(java.net.URI uri)
        Deprecated.
        use ClientUpgradeRequest() instead.

    • Method Detail

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

      • 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

      • 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

      • 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

      • addExtensions

        public void addExtensions​(org.eclipse.jetty.websocket.api.ExtensionConfig... configs)
        Add WebSocket Extension Configuration(s) to Upgrade Request.

        This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions() for what was negotiated

        Parameters:
        configs - the configuration(s) to add

      • addExtensions

        public void addExtensions​(java.lang.String... configs)
        Add WebSocket Extension Configuration(s) to request

        This is merely the list of requested Extensions to use, see UpgradeResponse.getExtensions() for what was negotiated

        Parameters:
        configs - the configuration(s) to add

      • setCookies

        public void setCookies​(java.util.List<java.net.HttpCookie> cookies)
        Set the list of Cookies on the request
        Parameters:
        cookies - the cookies to use

      • setExtensions

        public void setExtensions​(java.util.List<org.eclipse.jetty.websocket.api.ExtensionConfig> configs)
        Set the list of WebSocket Extension configurations on the request.
        Parameters:
        configs - the list of extension configurations

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.util.List<java.lang.String> values)
        Set a specific header with multi-value field

        Overrides any previous value for this named header

        Parameters:
        name - the name of the header
        values - the multi-value field

      • setHeader

        public void setHeader​(java.lang.String name,
                      java.lang.String value)
        Set a specific header value

        Overrides any previous value for this named header

        Parameters:
        name - the header to set
        value - the value to set it to

      • setHeaders

        public void setHeaders​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)
        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 setHeader(String, List) multiple times.

        Parameters:
        headers - the headers to set

      • setSubProtocols

        public void setSubProtocols​(java.util.List<java.lang.String> protocols)
        Set the offered WebSocket Sub-Protocol list.
        Parameters:
        protocols - the offered sub-protocol list

      • setSubProtocols

        public void setSubProtocols​(java.lang.String... protocols)
        Set the offered WebSocket Sub-Protocol list.
        Parameters:
        protocols - the offered sub-protocol list

      • setTimeout

        public void setTimeout​(long timeout,
                       java.util.concurrent.TimeUnit unit)
        Parameters:
        timeout - the total timeout for the request/response conversation of the WebSocket handshake; use zero or a negative value to disable the timeout
        unit - the timeout unit

      • getTimeout

        public long getTimeout()
        Returns:
        the total timeout for this request, in milliseconds; zero or negative if the timeout is disabled

      • joinValues

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