ClientHttpRequestFactorySettings (spring-boot 3.4.0)

java.lang.Object

java.lang.Record

org.springframework.boot.http.client.ClientHttpRequestFactorySettings

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 ClientHttpRequestFactorySettings(ClientHttpRequestFactorySettings.Redirects redirects, Duration connectTimeout, Duration readTimeout, SslBundle sslBundle) extends Record

Settings that can be applied when creating a ClientHttpRequestFactory.

Since:

3.4.0

See Also:

ClientHttpRequestFactoryBuilder

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

ClientHttpRequestFactorySettings.Redirects

Redirect strategies.
Constructor Summary

Constructors

Constructor

Description

ClientHttpRequestFactorySettings(ClientHttpRequestFactorySettings.Redirects redirects, Duration connectTimeout, Duration readTimeout, SslBundle sslBundle)

Creates an instance of a ClientHttpRequestFactorySettings record class.
Method Summary

Modifier and Type

Method

Description

Duration

connectTimeout()

Returns the value of the connectTimeout record component.

static ClientHttpRequestFactorySettings

defaults()

Use defaults for the ClientHttpRequestFactory 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 ClientHttpRequestFactorySettings

ofSslBundle(SslBundle sslBundle)

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

Duration

readTimeout()

Returns the value of the readTimeout record component.

ClientHttpRequestFactorySettings.Redirects

redirects()

Returns the value of the redirects record component.

SslBundle

sslBundle()

Returns the value of the sslBundle record component.

final String

toString()

Returns a string representation of this record class.

ClientHttpRequestFactorySettings

withConnectTimeout(Duration connectTimeout)

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

ClientHttpRequestFactorySettings

withReadTimeout(Duration readTimeout)

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

ClientHttpRequestFactorySettings

withRedirects(ClientHttpRequestFactorySettings.Redirects redirects)

Return a new ClientHttpRequestFactorySettings instance with an updated redirect setting.

ClientHttpRequestFactorySettings

withSslBundle(SslBundle sslBundle)

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- ClientHttpRequestFactorySettings
  
  public ClientHttpRequestFactorySettings(ClientHttpRequestFactorySettings.Redirects redirects, Duration connectTimeout, Duration readTimeout, SslBundle sslBundle)
  
  Creates an instance of a ClientHttpRequestFactorySettings 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 ClientHttpRequestFactorySettings withConnectTimeout(Duration connectTimeout)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated connect timeout setting.
  
  Parameters:
  
  connectTimeout - the new connect timeout setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- withReadTimeout
  
  public ClientHttpRequestFactorySettings withReadTimeout(Duration readTimeout)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated read timeout setting.
  
  Parameters:
  
  readTimeout - the new read timeout setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- withSslBundle
  
  public ClientHttpRequestFactorySettings withSslBundle(SslBundle sslBundle)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated SSL bundle setting.
  
  Parameters:
  
  sslBundle - the new SSL bundle setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- withRedirects
  
  public ClientHttpRequestFactorySettings withRedirects(ClientHttpRequestFactorySettings.Redirects redirects)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated redirect setting.
  
  Parameters:
  
  redirects - the new redirects setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- ofSslBundle
  
  public static ClientHttpRequestFactorySettings ofSslBundle(SslBundle sslBundle)
  
  Return a new ClientHttpRequestFactorySettings using defaults for all settings other than the provided SSL bundle.
  
  Parameters:
  
  sslBundle - the SSL bundle setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- defaults
  
  public static ClientHttpRequestFactorySettings defaults()
  
  Use defaults for the ClientHttpRequestFactory 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 ClientHttpRequestFactorySettings.Redirects redirects()
  
  Returns the value of the redirects record component.
  
  Returns:
  
  the value of the redirects record component
- connectTimeout
  
  public Duration connectTimeout()
  
  Returns the value of the connectTimeout record component.
  
  Returns:
  
  the value of the connectTimeout record component
- readTimeout
  
  public Duration readTimeout()
  
  Returns the value of the readTimeout record component.
  
  Returns:
  
  the value of the readTimeout record component
- sslBundle
  
  public SslBundle sslBundle()
  
  Returns the value of the sslBundle record component.
  
  Returns:
  
  the value of the sslBundle record component

Record Class ClientHttpRequestFactorySettings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

ClientHttpRequestFactorySettings

Method Details

withConnectTimeout

withReadTimeout

withSslBundle

withRedirects

ofSslBundle

defaults

toString

hashCode

equals

redirects

connectTimeout

readTimeout

sslBundle