Class MagicWebSocketClient.Builder

java.lang.Object

dev.ua.theroer.magicutils.http.MagicWebSocketClient.Builder

Enclosing class:

MagicWebSocketClient

public static final class MagicWebSocketClient.Builder
extends Object

Builder for MagicWebSocketClient.

Method Summary

Modifier and Type	Method	Description
MagicWebSocketClient.Builder	baseUrl(String baseUrl)	Sets a base URL used for relative paths.
MagicWebSocketClient	build()	Builds the client.
MagicWebSocketClient.Builder	client(HttpClient client)	Overrides the HttpClient instance.
MagicWebSocketClient.Builder	config(HttpClientConfig config)	Overrides the configuration instance.
MagicWebSocketClient.Builder	connectTimeout(Duration timeout)	Sets connect timeout.
MagicWebSocketClient.Builder	followRedirects(boolean follow)	Sets follow-redirects behavior.
MagicWebSocketClient.Builder	header(String name, String value)	Adds a default header.
MagicWebSocketClient.Builder	headers(Map<String,String> headers)	Adds default headers.
MagicWebSocketClient.Builder	httpBuilder(HttpClient.Builder builder)	Overrides the HttpClient builder.
MagicWebSocketClient.Builder	logger(PlatformLogger logger)	Overrides logger used for connection logging.
MagicWebSocketClient.Builder	logging(HttpClientConfig.LoggingSettings logging)	Overrides logging settings.
MagicWebSocketClient.Builder	mapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	Overrides JSON mapper (reserved for future extensions).
MagicWebSocketClient.Builder	subprotocols(List<String> subprotocols)	Sets subprotocols for the connection.
MagicWebSocketClient.Builder	userAgent(String userAgent)	Sets default User-Agent header value.
MagicWebSocketClient.Builder	version(HttpClient.Version version)	Sets HTTP version.

Methods inherited from class Object

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

Method Details

logger

public MagicWebSocketClient.Builder logger(PlatformLogger logger)

Overrides logger used for connection logging.

Parameters:

logger - platform logger

Returns:

this builder

config

public MagicWebSocketClient.Builder config(HttpClientConfig config)

Overrides the configuration instance.

Parameters:

config - configuration to use

Returns:

this builder

logging

public MagicWebSocketClient.Builder logging(HttpClientConfig.LoggingSettings logging)

Overrides logging settings.

Parameters:

logging - logging settings

Returns:

this builder

mapper

public MagicWebSocketClient.Builder mapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Overrides JSON mapper (reserved for future extensions).

Parameters:

mapper - object mapper

Returns:

this builder

baseUrl

public MagicWebSocketClient.Builder baseUrl(String baseUrl)

Sets a base URL used for relative paths.

Parameters:

baseUrl - base URL

Returns:

this builder

userAgent

public MagicWebSocketClient.Builder userAgent(String userAgent)

Sets default User-Agent header value.

Parameters:

userAgent - user agent value

Returns:

this builder

header

public MagicWebSocketClient.Builder header(String name,
 String value)

Adds a default header.

Parameters:

name - header name

value - header value

Returns:

this builder

headers

public MagicWebSocketClient.Builder headers(Map<String,String> headers)

Adds default headers.

Parameters:

headers - header map

Returns:

this builder

connectTimeout

public MagicWebSocketClient.Builder connectTimeout(Duration timeout)

Sets connect timeout.

Parameters:

timeout - connect timeout

Returns:

this builder

followRedirects

public MagicWebSocketClient.Builder followRedirects(boolean follow)

Sets follow-redirects behavior.

Parameters:

follow - follow redirects

Returns:

this builder

version

public MagicWebSocketClient.Builder version(HttpClient.Version version)

Sets HTTP version.

Parameters:

version - http version

Returns:

this builder

subprotocols

public MagicWebSocketClient.Builder subprotocols(List<String> subprotocols)

Sets subprotocols for the connection.

Parameters:

subprotocols - list of subprotocols

Returns:

this builder

client

public MagicWebSocketClient.Builder client(HttpClient client)

Overrides the HttpClient instance.

Parameters:

client - custom HttpClient

Returns:

this builder

httpBuilder

public MagicWebSocketClient.Builder httpBuilder(HttpClient.Builder builder)

Overrides the HttpClient builder.

Parameters:

builder - custom HttpClient builder

Returns:

this builder

build

public MagicWebSocketClient build()

Builds the client.

Returns:

MagicWebSocketClient