Module rxmicro.http.client

Package io.rxmicro.http.client

Class HttpClientConfig

java.lang.Object

io.rxmicro.config.Config

io.rxmicro.http.HttpConfig

io.rxmicro.http.client.HttpClientConfig

public class HttpClientConfig
extends HttpConfig

Allows configuring HTTP client options.

Since:

0.1

Author:

nedis

See Also:

Duration

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_HTTP_CLIENT_TIMEOUT_VALUE_IN_SECONDS	Default HTTp client timeout in seconds.

Fields inherited from class io.rxmicro.http.HttpConfig

DEFAULT_HTTP_PORT

Fields inherited from class io.rxmicro.config.Config

RX_MICRO_CONFIG_DIRECTORY_NAME, RX_MICRO_CONFIG_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
HttpClientConfig()	Creates a HTTP client config instance with default settings.

Method Summary

Modifier and Type	Method	Description
String	getAccessKey()	Returns the set access key or null if access key is not configured.
Duration	getRequestTimeout()	Returns the request timeout.
boolean	isFollowRedirects()	Returns true if current HTTP client must follow redirects.
HttpClientConfig	setAccessKey(String accessKey)	Sets the access key that can be used for authentication on the server side.
HttpClientConfig	setConnectionString(String connectionString)
HttpClientConfig	setFollowRedirects(boolean followRedirects)	Sets that current HTTP client must follow redirects or not.
HttpClientConfig	setHost(String host)
HttpClientConfig	setPort(int port)
HttpClientConfig	setRequestTimeout(Duration requestTimeout)	Sets the request timeout.
HttpClientConfig	setSchema(ProtocolSchema schema)
String	toString()

Methods inherited from class io.rxmicro.http.HttpConfig

getConnectionString, getHost, getPort, getSchema

Methods inherited from class io.rxmicro.config.Config

getDefaultNameSpace, getDefaultNameSpace, getNameSpace

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_CLIENT_TIMEOUT_VALUE_IN_SECONDS

public static final int DEFAULT_HTTP_CLIENT_TIMEOUT_VALUE_IN_SECONDS

Default HTTp client timeout in seconds.

See Also:

Constant Field Values

Constructor Detail

HttpClientConfig

public HttpClientConfig()

Creates a HTTP client config instance with default settings.

Method Detail

getAccessKey

public String getAccessKey()

Returns the set access key or null if access key is not configured.

Returns:

the set access key or null if access key is not configured

setAccessKey

@BuilderMethod
public HttpClientConfig setAccessKey(String accessKey)

Sets the access key that can be used for authentication on the server side.

Parameters:

accessKey - the access key

Returns:

the reference to this HttpClientConfig instance

isFollowRedirects

public boolean isFollowRedirects()

Returns true if current HTTP client must follow redirects.

Returns:

true if current HTTP client must follow redirects

setFollowRedirects

@BuilderMethod
public HttpClientConfig setFollowRedirects(boolean followRedirects)

Sets that current HTTP client must follow redirects or not.

Parameters:

followRedirects - follow redirects or not

Returns:

the reference to this HttpClientConfig instance

getRequestTimeout

public Duration getRequestTimeout()

Returns the request timeout.

Returns:

the request timeout

setRequestTimeout

@BuilderMethod
public HttpClientConfig setRequestTimeout(Duration requestTimeout)

Sets the request timeout.

Duration.ZERO means the infinite timeout

Parameters:

requestTimeout - the request timeout

Returns:

the reference to this HttpClientConfig instance

setSchema

public HttpClientConfig setSchema(ProtocolSchema schema)

Overrides:

setSchema in class HttpConfig

setHost

public HttpClientConfig setHost(String host)

Overrides:

setHost in class HttpConfig

setPort

public HttpClientConfig setPort(int port)

Overrides:

setPort in class HttpConfig

setConnectionString

public HttpClientConfig setConnectionString(String connectionString)

Overrides:

setConnectionString in class HttpConfig

toString

public String toString()

Overrides:

toString in class HttpConfig