Refactor compression entity class names for consistency. Renamed to u…

…se 'ing' form (e.g., CompressingEntity) to align with existing conventions like DecompressingEntity. Moved compression/decompression classes to org.apache.hc.client5.http.entity.compress package
apache · Nov 13, 2024 · 153155f · 153155f
1 parent 5b78afd
commit 153155f
Show file tree

Hide file tree

Showing 25 changed files with 199 additions and 147 deletions.
diff --git a/...t/java/org/apache/hc/client5/testing/sync/compress/CompressedResponseHandlingExample.java b/...t/java/org/apache/hc/client5/testing/sync/compress/CompressedResponseHandlingExample.java
@@ -30,7 +30,7 @@
 import java.util.Arrays;
 import java.util.List;
 
-import org.apache.hc.client5.http.entity.CompressorFactory;
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
 import org.apache.hc.client5.http.impl.classic.HttpClients;
 import org.apache.hc.core5.http.ClassicHttpRequest;
@@ -106,7 +106,7 @@ public static void main(final String[] args) {
 
     private static HttpEntity compress(final String data, final String name) {
         final StringEntity originalEntity = new StringEntity(data, ContentType.TEXT_PLAIN);
-        return CompressorFactory.INSTANCE.compressEntity(originalEntity, name);
+        return CompressingFactory.INSTANCE.compressEntity(originalEntity, name);
     }
 
 }
diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliDecompressingEntity.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliDecompressingEntity.java
@@ -26,6 +26,7 @@
  */
 package org.apache.hc.client5.http.entity;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.http.HttpEntity;
 
 /**
@@ -34,7 +35,7 @@
  *
  * @see GzipDecompressingEntity
  * @since 5.2
- * @deprecated Use {@link CompressorFactory} for handling Brotli decompression.
+ * @deprecated Use {@link CompressingFactory} for handling Brotli decompression.
  */
 @Deprecated
 public class BrotliDecompressingEntity extends DecompressingEntity {

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliInputStreamFactory.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliInputStreamFactory.java
@@ -29,6 +29,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 import org.brotli.dec.BrotliInputStream;
@@ -37,7 +38,7 @@
  * {@link InputStreamFactory} for handling Brotli Content Coded responses.
  *
  * @since 5.2
- * @deprecated Use {@link CompressorFactory} for handling Brotli compression.
+ * @deprecated Use {@link CompressingFactory} for handling Brotli compression.
  */
 @Deprecated
 @Contract(threading = ThreadingBehavior.STATELESS)

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DecompressingEntity.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DecompressingEntity.java
@@ -38,7 +38,7 @@
  * Common base class for decompressing {@link HttpEntity} implementations.
  *
  * @since 4.4
- * @deprecated
+ * @deprecated Use {{@link org.apache.hc.client5.http.entity.compress.DecompressingEntity}
  */
 @Deprecated
 public class DecompressingEntity extends HttpEntityWrapper {

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateDecompressingEntity.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateDecompressingEntity.java
@@ -26,6 +26,8 @@
  */
 package org.apache.hc.client5.http.entity;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
+import org.apache.hc.client5.http.entity.compress.DecompressingEntity;
 import org.apache.hc.core5.http.HttpEntity;
 
 /**
@@ -43,10 +45,10 @@
  * @see GzipDecompressingEntity
  *
  * @since 4.1
- * @deprecated Use {@link DecompressEntity} or {@link CompressorFactory} for decompression handling.
+ * @deprecated Use {@link DecompressingEntity} or {@link CompressingFactory} for decompression handling.
  */
 @Deprecated
-public class DeflateDecompressingEntity extends DecompressingEntity {
+public class DeflateDecompressingEntity extends org.apache.hc.client5.http.entity.DecompressingEntity {
 
     /**
      * Creates a new {@link DeflateDecompressingEntity} which will wrap the specified

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStream.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStream.java
@@ -35,10 +35,12 @@
 import java.util.zip.InflaterInputStream;
 import java.util.zip.ZipException;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
+
 /**
  * Deflates an input stream. This class includes logic needed for various RFCs in order
  * to reasonably implement the "deflate" compression algorithm.
- * @deprecated Use {@link CompressorFactory} for handling Deflate compression.
+ * @deprecated Use {@link CompressingFactory} for handling Deflate compression.
  */
 @Deprecated
 public class DeflateInputStream extends FilterInputStream {

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStreamFactory.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStreamFactory.java
@@ -30,14 +30,15 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 
 /**
  * {@link InputStreamFactory} for handling Deflate Content Coded responses.
  *
  * @since 5.0
- * @deprecated Use {@link CompressorFactory}.
+ * @deprecated Use {@link CompressingFactory}.
  */
 @Deprecated
 @Contract(threading = ThreadingBehavior.STATELESS)

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/EntityBuilder.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/EntityBuilder.java
@@ -33,6 +33,8 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
+import org.apache.hc.client5.http.entity.compress.DecompressingEntity;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.HttpEntity;
 import org.apache.hc.core5.http.NameValuePair;
@@ -406,7 +408,7 @@ public HttpEntity build() {
             throw new IllegalStateException("No entity set");
         }
         if (this.compressed) {
-            return new DecompressEntity(e, CompressorFactory.INSTANCE.getFormattedName(contentEncoding));
+            return new DecompressingEntity(e, CompressingFactory.INSTANCE.getFormattedName(contentEncoding));
         }
         return e;
     }

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GZIPInputStreamFactory.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GZIPInputStreamFactory.java
@@ -31,14 +31,15 @@
 import java.io.InputStream;
 import java.util.zip.GZIPInputStream;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 
 /**
  * {@link InputStreamFactory} for handling GZIPContent Coded responses.
  *
  * @since 5.0
- * @deprecated Use {@link CompressorFactory#getCompressorInputStream(String, InputStream, boolean)} instead.
+ * @deprecated Use {@link CompressingFactory#getDecompressorInputStream(String, InputStream, boolean)} instead.
  */
 @Deprecated
 @Contract(threading = ThreadingBehavior.STATELESS)

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipCompressingEntity.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipCompressingEntity.java
@@ -31,6 +31,7 @@
 import java.io.OutputStream;
 import java.util.zip.GZIPOutputStream;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.http.HttpEntity;
 import org.apache.hc.core5.http.io.entity.HttpEntityWrapper;
 import org.apache.hc.core5.util.Args;
@@ -40,7 +41,7 @@
  *
  *
  * @since 4.0
- * @deprecated Use {@link CompressorFactory#compressEntity(HttpEntity, String)} to handle compression.
+ * @deprecated Use {@link CompressingFactory#compressEntity(HttpEntity, String)} to handle compression.
  */
 @Deprecated
 public class GzipCompressingEntity extends HttpEntityWrapper {

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipDecompressingEntity.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipDecompressingEntity.java
@@ -26,14 +26,15 @@
  */
 package org.apache.hc.client5.http.entity;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
 import org.apache.hc.core5.http.HttpEntity;
 
 /**
  * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} for handling
  * gzip Content Coded responses.
  *
  * @since 4.1
- * @deprecated Use {@link CompressorFactory} for handling Gzip decompression.
+ * @deprecated Use {@link CompressingFactory} for handling Gzip decompression.
  */
 @Deprecated
 public class GzipDecompressingEntity extends DecompressingEntity {

diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/entity/InputStreamFactory.java b/httpclient5/src/main/java/org/apache/hc/client5/http/entity/InputStreamFactory.java
@@ -29,11 +29,13 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+import org.apache.hc.client5.http.entity.compress.CompressingFactory;
+
 /**
  * Factory for decorated {@link InputStream}s.
  *
  * @since 4.4
- * @deprecated Use {@link CompressorFactory} to retrieve appropriate {@link InputStream}s for compression handling.
+ * @deprecated Use {@link CompressingFactory} to retrieve appropriate {@link InputStream}s for compression handling.
  */
 @Deprecated
 public interface InputStreamFactory {

diff --git a/...client5/src/main/java/org/apache/hc/client5/http/entity/LazyDecompressingInputStream.java b/...client5/src/main/java/org/apache/hc/client5/http/entity/LazyDecompressingInputStream.java
@@ -35,7 +35,7 @@
 
 /**
  * Lazy initializes from an {@link InputStream} wrapper.
- * @deprecated Use {@link LazyDecompressInputStream}
+ * @deprecated Use {@link org.apache.hc.client5.http.entity.compress.LazyDecompressingInputStream}
  */
 @Deprecated
 class LazyDecompressingInputStream extends FilterInputStream {

diff --git a/...lient5/http/entity/CompressingEntity.java → ...tp/entity/compress/CompressingEntity.java b/...lient5/http/entity/CompressingEntity.java → ...tp/entity/compress/CompressingEntity.java
@@ -24,7 +24,7 @@
  * <http://www.apache.org/>.
  *
  */
-package org.apache.hc.client5.http.entity;
+package org.apache.hc.client5.http.entity.compress;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -40,7 +40,7 @@
  * an output stream. This class supports various compression algorithms based on the
  * specified content encoding.
  *
- * <p>Compression is performed using {@link CompressorFactory}, which returns a corresponding
+ * <p>Compression is performed using {@link CompressingFactory}, which returns a corresponding
  * {@link OutputStream} for the requested compression type. This class does not support
  * reading the content directly through {@link #getContent()} as the content is always compressed
  * during write operations.</p>
@@ -108,20 +108,17 @@ public InputStream getContent() throws IOException {
     @Override
     public void writeTo(final OutputStream outStream) throws IOException {
         Args.notNull(outStream, "Output stream");
-        // Get the compressor based on the specified content encoding
-        final OutputStream compressorStream;
-        try {
-            compressorStream = CompressorFactory.INSTANCE.getCompressorOutputStream(contentEncoding, outStream);
+
+        try (final OutputStream compressorStream = CompressingFactory.INSTANCE.getCompressorOutputStream(contentEncoding, outStream)) {
+            if (compressorStream != null) {
+                // Write compressed data
+                super.writeTo(compressorStream);
+            } else {
+                throw new UnsupportedOperationException("Unsupported compression: " + contentEncoding);
+            }
         } catch (final CompressorException e) {
-            throw new IOException("Error initializing decompression stream", e);
-        }
-        if (compressorStream != null) {
-            // Write compressed data
-            super.writeTo(compressorStream);
-            // Close the compressor stream after writing
-            compressorStream.close();
-        } else {
-            throw new UnsupportedOperationException("Unsupported compression: " + contentEncoding);
+            throw new IOException("Error initializing compression stream", e);
         }
     }
+
 }