Record Class ClientHttpConnectorSettings

java.lang.Object

java.lang.Record

org.springframework.boot.http.client.reactive.ClientHttpConnectorSettings

Record Components:

redirects - the follow redirect strategy to use or null to redirect whenever the underlying library allows it

connectTimeout - the connect timeout

readTimeout - the read timeout

sslBundle - the SSL bundle providing SSL configuration

public record ClientHttpConnectorSettings(HttpRedirects redirects, @Nullable Duration connectTimeout, @Nullable Duration readTimeout, @Nullable SslBundle sslBundle)
extends Record

Settings that can be applied when creating a ClientHttpConnector.

Since:

3.5.0

Author:

Phillip Webb

See Also:

• ClientHttpConnectorBuilder

Constructor Summary

Constructors

Constructor	Description
ClientHttpConnectorSettings(@Nullable HttpRedirects redirects, @Nullable Duration connectTimeout, @Nullable Duration readTimeout, @Nullable SslBundle sslBundle)	Creates an instance of a ClientHttpConnectorSettings record class.

Method Summary

Modifier and Type	Method	Description
@Nullable Duration	connectTimeout()	Returns the value of the connectTimeout record component.
static ClientHttpConnectorSettings	defaults()	Use defaults for the ClientHttpConnector which can differ depending on the implementation.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static ClientHttpConnectorSettings	ofSslBundle(@Nullable SslBundle sslBundle)	Return a new ClientHttpConnectorSettings using defaults for all settings other than the provided SSL bundle.
@Nullable Duration	readTimeout()	Returns the value of the readTimeout record component.
HttpRedirects	redirects()	Returns the value of the redirects record component.
@Nullable SslBundle	sslBundle()	Returns the value of the sslBundle record component.
final String	toString()	Returns a string representation of this record class.
ClientHttpConnectorSettings	withConnectTimeout(@Nullable Duration connectTimeout)	Return a new ClientHttpConnectorSettings instance with an updated connect timeout setting.
ClientHttpConnectorSettings	withReadTimeout(@Nullable Duration readTimeout)	Return a new ClientHttpConnectorSettings instance with an updated read timeout setting.
ClientHttpConnectorSettings	withRedirects(@Nullable HttpRedirects redirects)	Return a new ClientHttpConnectorSettings instance with an updated redirect setting.
ClientHttpConnectorSettings	withSslBundle(@Nullable SslBundle sslBundle)	Return a new ClientHttpConnectorSettings instance with an updated SSL bundle setting.
ClientHttpConnectorSettings	withTimeouts(@Nullable Duration connectTimeout, @Nullable Duration readTimeout)	Return a new ClientHttpConnectorSettings instance with an updated connect and read timeout setting.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClientHttpConnectorSettings

public ClientHttpConnectorSettings(@Nullable HttpRedirects redirects,
 @Nullable Duration connectTimeout,
 @Nullable Duration readTimeout,
 @Nullable SslBundle sslBundle)

Creates an instance of a ClientHttpConnectorSettings record class.

Parameters:

redirects - the value for the redirects record component

connectTimeout - the value for the connectTimeout record component

readTimeout - the value for the readTimeout record component

sslBundle - the value for the sslBundle record component

Method Details

withConnectTimeout

public ClientHttpConnectorSettings withConnectTimeout(@Nullable Duration connectTimeout)

Return a new ClientHttpConnectorSettings instance with an updated connect timeout setting.

Parameters:

connectTimeout - the new connect timeout setting

Returns:

a new ClientHttpConnectorSettings instance

withReadTimeout

public ClientHttpConnectorSettings withReadTimeout(@Nullable Duration readTimeout)

Return a new ClientHttpConnectorSettings instance with an updated read timeout setting.

Parameters:

readTimeout - the new read timeout setting

Returns:

a new ClientHttpConnectorSettings instance

withTimeouts

public ClientHttpConnectorSettings withTimeouts(@Nullable Duration connectTimeout,
 @Nullable Duration readTimeout)

Return a new ClientHttpConnectorSettings instance with an updated connect and read timeout setting.

Parameters:

connectTimeout - the new connect timeout setting

readTimeout - the new read timeout setting

Returns:

a new ClientHttpConnectorSettings instance

withSslBundle

public ClientHttpConnectorSettings withSslBundle(@Nullable SslBundle sslBundle)

Return a new ClientHttpConnectorSettings instance with an updated SSL bundle setting.

Parameters:

sslBundle - the new SSL bundle setting

Returns:

a new ClientHttpConnectorSettings instance

withRedirects

public ClientHttpConnectorSettings withRedirects(@Nullable HttpRedirects redirects)

Return a new ClientHttpConnectorSettings instance with an updated redirect setting.

Parameters:

redirects - the new redirects setting

Returns:

a new ClientHttpConnectorSettings instance

ofSslBundle

public static ClientHttpConnectorSettings ofSslBundle(@Nullable SslBundle sslBundle)

Return a new ClientHttpConnectorSettings using defaults for all settings other than the provided SSL bundle.

Parameters:

sslBundle - the SSL bundle setting

Returns:

a new ClientHttpConnectorSettings instance

defaults

public static ClientHttpConnectorSettings defaults()

Use defaults for the ClientHttpConnector which can differ depending on the implementation.

Returns:

default settings

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

redirects

public HttpRedirects redirects()

Returns the value of the redirects record component.

Returns:

the value of the redirects record component

connectTimeout

public @Nullable Duration connectTimeout()

Returns the value of the connectTimeout record component.

Returns:

the value of the connectTimeout record component

readTimeout

public @Nullable Duration readTimeout()

Returns the value of the readTimeout record component.

Returns:

the value of the readTimeout record component

sslBundle

public @Nullable SslBundle sslBundle()

Returns the value of the sslBundle record component.

Returns:

the value of the sslBundle record component