Package org.springframework.boot.web.client

Record Class ClientHttpRequestFactorySettings

java.lang.Object
java.lang.Record
org.springframework.boot.web.client.ClientHttpRequestFactorySettings
Record Components:
connectTimeout - the connect timeout
readTimeout - the read timeout
sslBundle - the SSL bundle providing SSL configuration
public record ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, SslBundle sslBundle) extends Record
Settings that can be applied when creating a ClientHttpRequestFactory.
Since:
3.0.0
See Also:

  • Field Details

    • DEFAULTS

      public static final ClientHttpRequestFactorySettings DEFAULTS
      Use defaults for the ClientHttpRequestFactory which can differ depending on the implementation.

  • Constructor Details

    • ClientHttpRequestFactorySettings

      @Deprecated(since="3.2.0", forRemoval=true) public ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, Boolean bufferRequestBody)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.2.0 for removal in 3.4.0 as support for buffering has been removed in Spring Framework 6.1
      Create a new ClientHttpRequestFactorySettings instance.
      Parameters:
      connectTimeout - the connection timeout
      readTimeout - the read timeout
      bufferRequestBody - if request body buffering is used

    • ClientHttpRequestFactorySettings

      @Deprecated(since="3.2.0", forRemoval=true) public ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, Boolean bufferRequestBody, SslBundle sslBundle)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.2.0 for removal in 3.4.0 as support for buffering has been removed in Spring Framework 6.1
      Create a new ClientHttpRequestFactorySettings instance.
      Parameters:
      connectTimeout - the connection timeout
      readTimeout - the read timeout
      bufferRequestBody - if request body buffering is used
      sslBundle - the ssl bundle
      Since:
      3.1.0

    • ClientHttpRequestFactorySettings

      public ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, SslBundle sslBundle)
      Creates an instance of a ClientHttpRequestFactorySettings record class.
      Parameters:
      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

    • withBufferRequestBody

      @Deprecated(since="3.2.0", forRemoval=true) public ClientHttpRequestFactorySettings withBufferRequestBody(Boolean bufferRequestBody)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.2.0 for removal in 3.4.0 as support for buffering has been removed in Spring Framework 6.1
      Has no effect as support for buffering has been removed in Spring Framework 6.1.
      Parameters:
      bufferRequestBody - the new buffer request body 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
      Since:
      3.1.0

    • bufferRequestBody

      @Deprecated(since="3.2.0", forRemoval=true) public Boolean bufferRequestBody()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.2.0 for removal in 3.4.0 as support for buffering has been removed in Spring Framework 6.1
      Returns whether request body buffering is used.
      Returns:
      whether request body buffering is used

    • 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.

    • 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