Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add read timeout setter on HttpComponentsClientHttpRequestFactory

Browse Source 
This commit adds support for HttpComponentsClientHttpRequestFactory to
set a read timeout, used on the underlying client as a RequestTimeout.

This brings the HttpComponentsClientHttpRequestFactory into alignment
with JDK, Jetty, OkHttp3, Reactor and SimpleClient
ClientHttpRequestFactory implementations.

See gh-33556
This commit is contained in:
Carl Magnuson
2024-09-17 14:01:17 -05:00
committed by Simon Baslé
parent 6f09c21f05
commit 453e7961a8
1 changed files with 45 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.java
View File

@@ -73,6 +73,8 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
private long connectionRequestTimeout = -1;
private long readTimeout = -1;
/**
* Create a new instance of the {@code HttpComponentsClientHttpRequestFactory}
@@ -136,7 +138,7 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
* handshakes or CONNECT requests; for that, it is required to
* use the {@link SocketConfig} on the
* {@link HttpClient} itself.
* @param connectTimeout the timeout value in milliseconds
* @param connectTimeout the timeout as {@code Duration}.
* @since 6.1
* @see RequestConfig#getConnectTimeout()
* @see SocketConfig#getSoTimeout
@@ -167,7 +169,7 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
* A timeout value of 0 specifies an infinite timeout.
* <p>Additional properties can be configured by specifying a
* {@link RequestConfig} instance on a custom {@link HttpClient}.
* @param connectionRequestTimeout the timeout value to request a connection in milliseconds
* @param connectionRequestTimeout the timeout value to request a connection as {@code Duration}.
* @since 6.1
* @see RequestConfig#getConnectionRequestTimeout()
*/
@@ -177,6 +179,43 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
this.connectionRequestTimeout = connectionRequestTimeout.toMillis();
}
/**
* Set the response timeout for the underlying {@link RequestConfig}.
* A timeout value of 0 specifies an infinite timeout.
* <p>Additional properties can be configured by specifying a
* {@link RequestConfig} instance on a custom {@link HttpClient}.
* <p>This options does not affect connection timeouts for SSL
* handshakes or CONNECT requests; for that, it is required to
* use the {@link SocketConfig} on the
* {@link HttpClient} itself.
* @param readTimeout the timeout value in milliseconds
* @since 6.2
* @see RequestConfig#getResponseTimeout()
*/
public void setReadTimeout(int readTimeout) {
Assert.isTrue(readTimeout >= 0, "Timeout must be a non-negative value");
this.readTimeout = readTimeout;
}
/**
* Set the response timeout for the underlying {@link RequestConfig}.
* A timeout value of 0 specifies an infinite timeout.
* <p>Additional properties can be configured by specifying a
* {@link RequestConfig} instance on a custom {@link HttpClient}.
* <p>This options does not affect connection timeouts for SSL
* handshakes or CONNECT requests; for that, it is required to
* use the {@link SocketConfig} on the
* {@link HttpClient} itself.
* @param readTimeout the timeout as {@code Duration}.
* @since 6.2
* @see RequestConfig#getResponseTimeout()
*/
public void setReadTimeout(Duration readTimeout) {
Assert.notNull(readTimeout, "ReadTimeout must not be null");
Assert.isTrue(!readTimeout.isNegative(), "Timeout must be a non-negative value");
this.readTimeout = readTimeout.toMillis();
}
/**
* Indicates whether this request factory should buffer the request body internally.
* <p>Default is {@code true}. When sending large amounts of data via POST or PUT, it is
@@ -262,7 +301,7 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
*/
@SuppressWarnings("deprecation") // setConnectTimeout
protected RequestConfig mergeRequestConfig(RequestConfig clientConfig) {
if (this.connectTimeout == -1 && this.connectionRequestTimeout == -1) { // nothing to merge
if (this.connectTimeout == -1 && this.connectionRequestTimeout == -1 && this.readTimeout == -1) { // nothing to merge
return clientConfig;
}
@@ -273,6 +312,9 @@ public class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest
if (this.connectionRequestTimeout >= 0) {
builder.setConnectionRequestTimeout(this.connectionRequestTimeout, TimeUnit.MILLISECONDS);
}
if (this.readTimeout >= 0) {
builder.setResponseTimeout(this.readTimeout, TimeUnit.MILLISECONDS);
}
return builder.build();
}