Package kong.unirest.core
Class WebSocketRequestImpl
java.lang.Object
kong.unirest.core.WebSocketRequestImpl
- All Implemented Interfaces:
WebSocketRequest
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Config
private Integer
private Instant
protected Headers
protected HttpMethod
private Optional
<ObjectMapper> private String
protected Path
-
Constructor Summary
Constructors -
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
-
Field Details
-
creation
-
objectMapper
-
responseEncoding
-
headers
-
config
-
method
-
url
-
connectTimeout
-
-
Constructor Details
-
WebSocketRequestImpl
-
-
Method Details
-
routeParam
Description copied from interface:WebSocketRequest
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- Specified by:
routeParam
in interfaceWebSocketRequest
- 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
Description copied from interface:WebSocketRequest
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- Specified by:
routeParam
in interfaceWebSocketRequest
- Parameters:
params
- a map of path params- Returns:
- this request builder
-
basicAuth
Description copied from interface:WebSocketRequest
Basic auth credentials- Specified by:
basicAuth
in interfaceWebSocketRequest
- Parameters:
username
- the usernamepassword
- the password- Returns:
- this request builder
-
accept
Description copied from interface:WebSocketRequest
The Accept header to send (e.g. application/json- Specified by:
accept
in interfaceWebSocketRequest
- Parameters:
value
- a valid mime type for the Accept header- Returns:
- this request builder
-
responseEncoding
Description copied from interface:WebSocketRequest
The encoding to expect the response to be for cases where the server fails to respond with the proper encoding- Specified by:
responseEncoding
in interfaceWebSocketRequest
- Parameters:
encoding
- a valid mime type for the Accept header- Returns:
- this request builder
-
header
Description copied from interface:WebSocketRequest
Add a http header, HTTP supports multiple of the same header. This will continue to append new values- Specified by:
header
in interfaceWebSocketRequest
- Parameters:
name
- name of the headervalue
- value for the header- Returns:
- this request builder
-
headerReplace
Description copied from interface:WebSocketRequest
Replace a header value or add it if it doesn't exist- Specified by:
headerReplace
in interfaceWebSocketRequest
- Parameters:
name
- name of the headervalue
- value for the header- Returns:
- this request builder
-
headers
Description copied from interface:WebSocketRequest
Add headers as a map- Specified by:
headers
in interfaceWebSocketRequest
- Parameters:
headerMap
- a map of headers- Returns:
- this request builder
-
cookie
Description copied from interface:WebSocketRequest
Add a simple cookie header- Specified by:
cookie
in interfaceWebSocketRequest
- Parameters:
name
- the name of the cookievalue
- the value of the cookie- Returns:
- this request builder
-
cookie
Description copied from interface:WebSocketRequest
Add a simple cookie header- Specified by:
cookie
in interfaceWebSocketRequest
- Parameters:
cookie
- a cookie- Returns:
- this request builder
-
cookie
Description copied from interface:WebSocketRequest
Add a collection of cookie headers- Specified by:
cookie
in interfaceWebSocketRequest
- Parameters:
cookies
- a cookie- Returns:
- this request builder
-
queryString
Description copied from interface:WebSocketRequest
add a query param to the url. The value will be URL-Encoded- Specified by:
queryString
in interfaceWebSocketRequest
- Parameters:
name
- the name of the paramvalue
- the value of the param- Returns:
- this request builder
-
queryString
Description copied from interface:WebSocketRequest
Add multiple param with the same param name. queryString("name", Arrays.asList("bob", "linda")) will result in ?name=bob&name=linda- Specified by:
queryString
in interfaceWebSocketRequest
- Parameters:
name
- the name of the paramvalue
- a collection of values- Returns:
- this request builder
-
queryString
Description copied from interface:WebSocketRequest
Add query params as a map of name value pairs- Specified by:
queryString
in interfaceWebSocketRequest
- Parameters:
parameters
- a map of params- Returns:
- this request builder
-
connect
- Specified by:
connect
in interfaceWebSocketRequest
-
getHeaders
- Specified by:
getHeaders
in interfaceWebSocketRequest
-
getUrl
- Specified by:
getUrl
in interfaceWebSocketRequest
-