Deprecated misplaced method that introduced a dependency between the …

…protocol layer and generic utility code
apache · Sep 15, 2023 · bfba5f9 · bfba5f9
1 parent f44526e
commit bfba5f9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/EntityUtils.java b/httpcore5/src/main/java/org/apache/hc/core5/http/io/entity/EntityUtils.java
@@ -41,6 +41,7 @@
 import java.util.Map;
 
 import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.EntityDetails;
 import org.apache.hc.core5.http.HttpEntity;
 import org.apache.hc.core5.http.NameValuePair;
 import org.apache.hc.core5.http.ParseException;
@@ -111,6 +112,14 @@ private static int toContentLength(final int contentLength) {
         return contentLength < 0 ? DEFAULT_BYTE_BUFFER_SIZE : contentLength;
     }
 
+    static long checkContentLength(final EntityDetails entityDetails) {
+        // -1 is a special value,
+        // 0 is allowed as well,
+        // but never more than Integer.MAX_VALUE.
+        return Args.checkRange(entityDetails.getContentLength(), -1, Integer.MAX_VALUE,
+                "HTTP entity too large to be buffered in memory)");
+    }
+
     /**
      * Reads the contents of an entity and return it as a byte array.
      *
@@ -122,7 +131,7 @@ private static int toContentLength(final int contentLength) {
      */
     public static byte[] toByteArray(final HttpEntity entity) throws IOException {
         Args.notNull(entity, "HttpEntity");
-        final int contentLength = toContentLength((int) Args.checkContentLength(entity));
+        final int contentLength = toContentLength((int) checkContentLength(entity));
         try (final InputStream inStream = entity.getContent()) {
             if (inStream == null) {
                 return null;
@@ -150,7 +159,7 @@ public static byte[] toByteArray(final HttpEntity entity) throws IOException {
      */
     public static byte[] toByteArray(final HttpEntity entity, final int maxResultLength) throws IOException {
         Args.notNull(entity, "HttpEntity");
-        final int contentLength = toContentLength((int) Args.checkContentLength(entity));
+        final int contentLength = toContentLength((int) checkContentLength(entity));
         try (final InputStream inStream = entity.getContent()) {
             if (inStream == null) {
                 return null;
@@ -206,7 +215,7 @@ private static CharArrayBuffer toCharArrayBuffer(final InputStream inStream, fin
     private static String toString(final HttpEntity entity, final ContentType contentType, final int maxResultLength)
             throws IOException {
         Args.notNull(entity, "HttpEntity");
-        final int contentLength = toContentLength((int) Args.checkContentLength(entity));
+        final int contentLength = toContentLength((int) checkContentLength(entity));
         try (final InputStream inStream = entity.getContent()) {
             if (inStream == null) {
                 return null;
@@ -396,7 +405,7 @@ public static List<NameValuePair> parse(final HttpEntity entity) throws IOExcept
      */
     public static List<NameValuePair> parse(final HttpEntity entity, final int maxStreamLength) throws IOException {
         Args.notNull(entity, "HttpEntity");
-        final int contentLength = toContentLength((int) Args.checkContentLength(entity));
+        final int contentLength = toContentLength((int) checkContentLength(entity));
         final ContentType contentType = ContentType.parse(entity.getContentType());
         if (!ContentType.APPLICATION_FORM_URLENCODED.isSameMimeType(contentType)) {
             return Collections.emptyList();

diff --git a/httpcore5/src/main/java/org/apache/hc/core5/util/Args.java b/httpcore5/src/main/java/org/apache/hc/core5/util/Args.java
@@ -54,6 +54,10 @@ public static void check(final boolean expression, final String message, final O
         }
     }
 
+    /**
+     * @deprecated Use {@link #checkRange(long, long, long, String)}.
+     */
+    @Deprecated
     public static long checkContentLength(final EntityDetails entityDetails) {
         // -1 is a special value,
         // 0 is allowed as well,