Skip to content

Deprecate EntityUtils#toByteArray / EntityUtils#toString methods with no maxResultLength constraint #681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ok2c merged 1 commit into from
Jul 23, 2026
Merged

Deprecate EntityUtils#toByteArray / EntityUtils#toString methods with no maxResultLength constraint #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...testing/src/main/java/org/apache/hc/core5/testing/framework/ClassicTestClientAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public Map<String, Object> execute(final String defaultURI, final Map<String, Ob
try (final ClassicHttpResponse response = client.execute(host, httpRequest, context)) {
// Prepare the response. It will contain status, body, headers, and contentType.
final HttpEntity entity = response.getEntity();
final String body = entity == null ? null : EntityUtils.toString(entity);
final String body = entity == null ? null : EntityUtils.toString(entity, Integer.MAX_VALUE);
final String contentType = entity == null ? null : entity.getContentType();

// prepare the returned information
Expand Down
2 changes: 1 addition & 1 deletion ...g/src/main/java/org/apache/hc/core5/testing/framework/TestingFrameworkRequestHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ public void handle(final ClassicHttpRequest request, final ClassicHttpResponse r
final String expectedBody = (String) requestExpectations.get(BODY);
if (expectedBody != null) {
final HttpEntity entity = request.getEntity();
final String data = EntityUtils.toString(entity);
final String data = EntityUtils.toString(entity, 1024);
if (! data.equals(expectedBody)) {
throw new TestingFrameworkException("Expected body not found. " +
" Body=" + data + "; expected=" + expectedBody);
Expand Down
14 changes: 7 additions & 7 deletions ...-testing/src/test/java/org/apache/hc/core5/testing/classic/ClassicAuthenticationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
package org.apache.hc.core5.testing.classic;


import org.junit.jupiter.api.Assertions;
import java.nio.charset.StandardCharsets;
import java.util.Random;

Expand Down Expand Up @@ -61,6 +60,7 @@
import org.apache.hc.core5.testing.extension.classic.HttpRequesterResource;
import org.apache.hc.core5.testing.extension.classic.HttpServerResource;
import org.apache.hc.core5.util.Timeout;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

Expand Down Expand Up @@ -135,14 +135,14 @@ void testGetRequestAuthentication() throws Exception {
final ClassicHttpRequest request1 = new BasicClassicHttpRequest(Method.GET, "/stuff");
try (final ClassicHttpResponse response1 = requester.execute(target, request1, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response1.getCode());
final String body1 = EntityUtils.toString(response1.getEntity());
final String body1 = EntityUtils.toString(response1.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("You shall not pass!!!", body1);
}
final ClassicHttpRequest request2 = new BasicClassicHttpRequest(Method.GET, "/stuff");
request2.setHeader(HttpHeaders.AUTHORIZATION, "let me pass");
try (final ClassicHttpResponse response2 = requester.execute(target, request2, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode());
final String body1 = EntityUtils.toString(response2.getEntity());
final String body1 = EntityUtils.toString(response2.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("", body1);
}
}
Expand All @@ -163,15 +163,15 @@ void testPostRequestAuthentication() throws Exception {
request1.setEntity(new ByteArrayEntity(stuff, ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response1 = requester.execute(target, request1, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response1.getCode());
final String body1 = EntityUtils.toString(response1.getEntity());
final String body1 = EntityUtils.toString(response1.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("You shall not pass!!!", body1);
}
final ClassicHttpRequest request2 = new BasicClassicHttpRequest(Method.POST, "/stuff");
request2.setHeader(HttpHeaders.AUTHORIZATION, "let me pass");
request2.setEntity(new ByteArrayEntity(stuff, ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response2 = requester.execute(target, request2, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode());
final String body1 = EntityUtils.toString(response2.getEntity());
final String body1 = EntityUtils.toString(response2.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals(new String(stuff, StandardCharsets.US_ASCII), body1);
}
}
Expand All @@ -193,7 +193,7 @@ void testPostRequestAuthenticationNoExpectContinue() throws Exception {
request1.setEntity(new ByteArrayEntity(stuff, ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response1 = requester.execute(target, request1, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response1.getCode());
final String body1 = EntityUtils.toString(response1.getEntity());
final String body1 = EntityUtils.toString(response1.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("You shall not pass!!!", body1);
}
final ClassicHttpRequest request2 = new BasicClassicHttpRequest(Method.POST, "/stuff");
Expand All @@ -202,7 +202,7 @@ void testPostRequestAuthenticationNoExpectContinue() throws Exception {
request2.setEntity(new ByteArrayEntity(stuff, ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response2 = requester.execute(target, request2, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode());
final String body1 = EntityUtils.toString(response2.getEntity());
final String body1 = EntityUtils.toString(response2.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals(new String(stuff, StandardCharsets.US_ASCII), body1);
}
}
Expand Down
15 changes: 8 additions & 7 deletions ...sting/src/test/java/org/apache/hc/core5/testing/classic/ClassicHttpCoreTransportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,21 +78,21 @@ void testSequentialRequests() throws Exception {
request1.setEntity(new StringEntity("some stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response1 = requester.execute(target, request1, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode());
final String body1 = EntityUtils.toString(response1.getEntity());
final String body1 = EntityUtils.toString(response1.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some stuff", body1);
}
final ClassicHttpRequest request2 = new BasicClassicHttpRequest(Method.POST, "/other-stuff");
request2.setEntity(new StringEntity("some other stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response2 = requester.execute(target, request2, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode());
final String body2 = EntityUtils.toString(response2.getEntity());
final String body2 = EntityUtils.toString(response2.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some other stuff", body2);
}
final ClassicHttpRequest request3 = new BasicClassicHttpRequest(Method.POST, "/more-stuff");
request3.setEntity(new StringEntity("some more stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response3 = requester.execute(target, request3, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode());
final String body3 = EntityUtils.toString(response3.getEntity());
final String body3 = EntityUtils.toString(response3.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some more stuff", body3);
}
}
Expand All @@ -108,21 +108,21 @@ void testSequentialRequestsNonPersistentConnection() throws Exception {
request1.setEntity(new StringEntity("some stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response1 = requester.execute(target, request1, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode());
final String body1 = EntityUtils.toString(response1.getEntity());
final String body1 = EntityUtils.toString(response1.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some stuff", body1);
}
final ClassicHttpRequest request2 = new BasicClassicHttpRequest(Method.POST, "/no-keep-alive/other-stuff");
request2.setEntity(new StringEntity("some other stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response2 = requester.execute(target, request2, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode());
final String body2 = EntityUtils.toString(response2.getEntity());
final String body2 = EntityUtils.toString(response2.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some other stuff", body2);
}
final ClassicHttpRequest request3 = new BasicClassicHttpRequest(Method.POST, "/no-keep-alive/more-stuff");
request3.setEntity(new StringEntity("some more stuff", ContentType.TEXT_PLAIN));
try (final ClassicHttpResponse response3 = requester.execute(target, request3, TIMEOUT, context)) {
Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode());
final String body3 = EntityUtils.toString(response3.getEntity());
final String body3 = EntityUtils.toString(response3.getEntity(), Integer.MAX_VALUE);
Assertions.assertEquals("some more stuff", body3);
}
}
Expand All @@ -149,7 +149,8 @@ void testMultiThreadedRequests() throws Exception {
request1.setEntity(new StringEntity("some stuff", ContentType.TEXT_PLAIN));
requester.execute(target, request1, TIMEOUT, context, response -> {
Assertions.assertEquals(HttpStatus.SC_OK, response.getCode());
Assertions.assertEquals("some stuff", EntityUtils.toString(response.getEntity()));
Assertions.assertEquals("some stuff",
EntityUtils.toString(response.getEntity(), 1024));
return null;
});
} catch (final Exception ex) {
Expand Down
Loading
Loading