Package kong.unirest.core
Interface WebSocketRequest
- All Known Implementing Classes:
WebSocketRequestImpl
public interface WebSocketRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe Accept header to send (e.g.Basic auth credentialsconnect
(WebSocket.Listener listener) Add a simple cookie headercookie
(Collection<Cookie> cookies) Add a collection of cookie headersAdd a simple cookie headergetUrl()
Add a http header, HTTP supports multiple of the same header.headerReplace
(String name, String value) Replace a header value or add it if it doesn't existAdd headers as a mapqueryString
(String name, Object value) add a query param to the url.queryString
(String name, Collection<?> value) Add multiple param with the same param name.queryString
(Map<String, Object> parameters) Add query params as a map of name value pairsresponseEncoding
(String encoding) The encoding to expect the response to be for cases where the server fails to respond with the proper encodingrouteParam
(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/fredrouteParam
(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
-
Method Details
-
routeParam
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
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
Basic auth credentials- Parameters:
username
- the usernamepassword
- the password- Returns:
- this request builder
-
accept
The Accept header to send (e.g. application/json- Parameters:
value
- a valid mime type for the Accept header- Returns:
- this request builder
-
responseEncoding
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
Add a http header, HTTP supports multiple of the same header. This will continue to append new values- Parameters:
name
- name of the headervalue
- value for the header- Returns:
- this request builder
-
headerReplace
Replace a header value or add it if it doesn't exist- Parameters:
name
- name of the headervalue
- value for the header- Returns:
- this request builder
-
headers
Add headers as a map- Parameters:
headerMap
- a map of headers- Returns:
- this request builder
-
cookie
Add a simple cookie header- Parameters:
name
- the name of the cookievalue
- the value of the cookie- Returns:
- this request builder
-
cookie
Add a simple cookie header- Parameters:
cookie
- a cookie- Returns:
- this request builder
-
cookie
Add a collection of cookie headers- Parameters:
cookies
- a cookie- Returns:
- this request builder
-
queryString
add a query param to the url. The value will be URL-Encoded- Parameters:
name
- the name of the paramvalue
- the value of the param- Returns:
- this request builder
-
queryString
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 paramvalue
- a collection of values- Returns:
- this request builder
-
queryString
Add query params as a map of name value pairs- Parameters:
parameters
- a map of params- Returns:
- this request builder
-
connect
-
getHeaders
Headers getHeaders() -
getUrl
String getUrl()
-