Package kong.unirest.core

Class WebSocketRequestImpl

java.lang.Object

kong.unirest.core.WebSocketRequestImpl

All Implemented Interfaces:

WebSocketRequest

public class WebSocketRequestImpl
extends Object
implements WebSocketRequest

Field Summary

Fields

Modifier and Type	Field	Description
protected Config	config
protected Headers	headers
protected HttpMethod	method
protected Path	url

Constructor Summary

Constructors

Constructor	Description
WebSocketRequestImpl(Config config, String url)

Method Summary

Modifier and Type	Method	Description
WebSocketRequest	accept(String value)	The Accept header to send (e.g. application/json
WebSocketRequest	basicAuth(String username, String password)	Basic auth credentials
WebSocketResponse	connect(WebSocket.Listener listener)
WebSocketRequest	cookie(String name, String value)	Add a simple cookie header
WebSocketRequest	cookie(Collection<Cookie> cookies)	Add a collection of cookie headers
WebSocketRequest	cookie(Cookie cookie)	Add a simple cookie header
Headers	getHeaders()
String	getUrl()
WebSocketRequest	header(String name, String value)	Add a http header, HTTP supports multiple of the same header.
WebSocketRequest	headerReplace(String name, String value)	Replace a header value or add it if it doesn't exist
WebSocketRequest	headers(Map<String,String> headerMap)	Add headers as a map
WebSocketRequest	queryString(String name, Object value)	add a query param to the url.
WebSocketRequest	queryString(String name, Collection<?> value)	Add multiple param with the same param name.
WebSocketRequest	queryString(Map<String,Object> parameters)	Add query params as a map of name value pairs
WebSocketRequest	responseEncoding(String encoding)	The encoding to expect the response to be for cases where the server fails to respond with the proper encoding
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
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

headers

protected Headers headers

config

protected final Config config

method

protected HttpMethod method

url

protected Path url

Constructor Detail

WebSocketRequestImpl

public WebSocketRequestImpl(Config config,
                            String url)

Method Detail

routeParam

public WebSocketRequest routeParam(String name,
                                   String value)

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 interface WebSocketRequest

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

public WebSocketRequest routeParam(Map<String,Object> params)

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 interface WebSocketRequest

Parameters:

params - a map of path params

Returns:

this request builder

basicAuth

public WebSocketRequest basicAuth(String username,
                                  String password)

Description copied from interface: WebSocketRequest

Basic auth credentials

Specified by:

basicAuth in interface WebSocketRequest

Parameters:

username - the username

password - the password

Returns:

this request builder

accept

public WebSocketRequest accept(String value)

Description copied from interface: WebSocketRequest

The Accept header to send (e.g. application/json

Specified by:

accept in interface WebSocketRequest

Parameters:

value - a valid mime type for the Accept header

Returns:

this request builder

responseEncoding

public WebSocketRequest responseEncoding(String encoding)

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 interface WebSocketRequest

Parameters:

encoding - a valid mime type for the Accept header

Returns:

this request builder

header

public WebSocketRequest header(String name,
                               String value)

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 interface WebSocketRequest

Parameters:

name - name of the header

value - value for the header

Returns:

this request builder

headerReplace

public WebSocketRequest headerReplace(String name,
                                      String value)

Description copied from interface: WebSocketRequest

Replace a header value or add it if it doesn't exist

Specified by:

headerReplace in interface WebSocketRequest

Parameters:

name - name of the header

value - value for the header

Returns:

this request builder

headers

public WebSocketRequest headers(Map<String,String> headerMap)

Description copied from interface: WebSocketRequest

Add headers as a map

Specified by:

headers in interface WebSocketRequest

Parameters:

headerMap - a map of headers

Returns:

this request builder

cookie

public WebSocketRequest cookie(String name,
                               String value)

Description copied from interface: WebSocketRequest

Add a simple cookie header

Specified by:

cookie in interface WebSocketRequest

Parameters:

name - the name of the cookie

value - the value of the cookie

Returns:

this request builder

cookie

public WebSocketRequest cookie(Cookie cookie)

Description copied from interface: WebSocketRequest

Add a simple cookie header

Specified by:

cookie in interface WebSocketRequest

Parameters:

cookie - a cookie

Returns:

this request builder

cookie

public WebSocketRequest cookie(Collection<Cookie> cookies)

Description copied from interface: WebSocketRequest

Add a collection of cookie headers

Specified by:

cookie in interface WebSocketRequest

Parameters:

cookies - a cookie

Returns:

this request builder

queryString

public WebSocketRequest queryString(String name,
                                    Object value)

Description copied from interface: WebSocketRequest

add a query param to the url. The value will be URL-Encoded

Specified by:

queryString in interface WebSocketRequest

Parameters:

name - the name of the param

value - the value of the param

Returns:

this request builder

queryString

public WebSocketRequest queryString(String name,
                                    Collection<?> value)

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 interface WebSocketRequest

Parameters:

name - the name of the param

value - a collection of values

Returns:

this request builder

queryString

public WebSocketRequest queryString(Map<String,Object> parameters)

Description copied from interface: WebSocketRequest

Add query params as a map of name value pairs

Specified by:

queryString in interface WebSocketRequest

Parameters:

parameters - a map of params

Returns:

this request builder

connect

public WebSocketResponse connect(WebSocket.Listener listener)

Specified by:

connect in interface WebSocketRequest

getHeaders

public Headers getHeaders()

Specified by:

getHeaders in interface WebSocketRequest

getUrl

public String getUrl()

Specified by:

getUrl in interface WebSocketRequest