Package kong.unirest.core

Interface WebSocketRequest

All Known Implementing Classes:
WebSocketRequestImpl
public interface WebSocketRequest

  • Method Details

    • routeParam

      WebSocketRequest routeParam(String name, String value)
      add a route param that replaces the matching {name} For example routeParam("name", "fred") will replace {name} in https://localhost/users/{user} to https://localhost/users/fred
      Parameters:
      name - the name of the param (do not include curly braces {}
      value - the value to replace the placeholder with
      Returns:
      this request builder

    • routeParam

      WebSocketRequest routeParam(Map<String,Object> params)
      add a route param map that replaces the matching {name} For example routeParam(Map.of("name", "fred")) will replace {name} in https://localhost/users/{user} to https://localhost/users/fred
      Parameters:
      params - a map of path params
      Returns:
      this request builder

    • basicAuth

      WebSocketRequest basicAuth(String username, String password)
      Basic auth credentials
      Parameters:
      username - the username
      password - the password
      Returns:
      this request builder

    • accept

      WebSocketRequest accept(String value)
      The Accept header to send (e.g. application/json
      Parameters:
      value - a valid mime type for the Accept header
      Returns:
      this request builder

    • responseEncoding

      WebSocketRequest responseEncoding(String encoding)
      The encoding to expect the response to be for cases where the server fails to respond with the proper encoding
      Parameters:
      encoding - a valid mime type for the Accept header
      Returns:
      this request builder

    • header

      WebSocketRequest header(String name, String value)
      Add a http header, HTTP supports multiple of the same header. This will continue to append new values
      Parameters:
      name - name of the header
      value - value for the header
      Returns:
      this request builder

    • headerReplace

      WebSocketRequest headerReplace(String name, String value)
      Replace a header value or add it if it doesn't exist
      Parameters:
      name - name of the header
      value - value for the header
      Returns:
      this request builder

    • headers

      WebSocketRequest headers(Map<String,String> headerMap)
      Add headers as a map
      Parameters:
      headerMap - a map of headers
      Returns:
      this request builder

    • cookie

      WebSocketRequest cookie(String name, String value)
      Add a simple cookie header
      Parameters:
      name - the name of the cookie
      value - the value of the cookie
      Returns:
      this request builder

    • cookie

      WebSocketRequest cookie(Cookie cookie)
      Add a simple cookie header
      Parameters:
      cookie - a cookie
      Returns:
      this request builder

    • cookie

      WebSocketRequest cookie(Collection<Cookie> cookies)
      Add a collection of cookie headers
      Parameters:
      cookies - a cookie
      Returns:
      this request builder

    • queryString

      WebSocketRequest queryString(String name, Object value)
      add a query param to the url. The value will be URL-Encoded
      Parameters:
      name - the name of the param
      value - the value of the param
      Returns:
      this request builder

    • queryString

      WebSocketRequest queryString(String name, Collection<?> value)
      Add multiple param with the same param name. queryString("name", Arrays.asList("bob", "linda")) will result in ?name=bob&name=linda
      Parameters:
      name - the name of the param
      value - a collection of values
      Returns:
      this request builder

    • queryString

      WebSocketRequest queryString(Map<String,Object> parameters)
      Add query params as a map of name value pairs
      Parameters:
      parameters - a map of params
      Returns:
      this request builder

    • connect

      WebSocketResponse connect(WebSocket.Listener listener)

    • getHeaders

      Headers getHeaders()

    • getUrl

      String getUrl()