Merge pull request #4101 from jamezp/RESTEASY-3473-6.2

[RESTEASY-3473] Deprecate the public facing Apache HTTP Client API's …
resteasy · Mar 22, 2024 · 719214c · 719214c
2 parents a1b04b2 + e2545db
commit 719214c
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 3 deletions.
diff --git a/docbook/reference/en/en-US/modules/RESTEasy_Client_Framework.xml b/docbook/reference/en/en-US/modules/RESTEasy_Client_Framework.xml
@@ -136,7 +136,7 @@ public interface SimpleClient
     </para>
     <para>
 
-        RESTEasy has a simple API based on Apache HttpClient. Generate a proxy, then invoke methods on the
+        RESTEasy has a simple API to generate a proxy, then invoke methods on the
         proxy. The invoked method gets translated to an HTTP request based on how the method was annotated
         and posted to the server. Here's how to set this up:
     </para>
@@ -511,6 +511,13 @@ name: b
 
    <section id="transport_layer">
      <title>Apache HTTP Client 4.x and other backends</title>
+       <warning>
+           <para>
+               <emphasis role="bold">Note: </emphasis> The Apache HTTP Client support is deprecated in RESTEasy. The exposed
+               API's will eventually be removed. However, it's still the default client implementation as we prepare for
+               a replacement backing HTTP client.
+           </para>
+       </warning>
 
        <para>
            Network communication between the client and server is handled by default in RESTEasy.
@@ -563,11 +570,11 @@ name: b
                </thead>
                <tbody>
                    <row>
-                       <entry>ApacheHttpClient43Engine</entry>
+                       <entry>ApacheHttpClient43Engine (deprecated)</entry>
                        <entry>Uses HttpComponents HttpClient 4.3+</entry>
                    </row>
                    <row>
-                       <entry>ApacheHttpAsyncClient4Engine</entry>
+                       <entry>ApacheHttpAsyncClient4Engine (deprecated)</entry>
                        <entry>Uses HttpComponents HttpAsyncClient</entry>
                    </row>
                    <row>

diff --git a/...t/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpAsyncClient4Engine.java b/...t/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpAsyncClient4Engine.java
@@ -90,7 +90,11 @@
  * </ul>
  *
  * @author Markus Kull
+ *
+ * @deprecated This will be removed in a future release as the underlying default implementation of the
+ *             {@link org.jboss.resteasy.client.jaxrs.ClientHttpEngine} will be replaced.
  */
+@Deprecated(forRemoval = true, since = "6.2")
 public class ApacheHttpAsyncClient4Engine implements AsyncClientHttpEngine, Closeable {
     protected final CloseableHttpAsyncClient client;
     protected final boolean closeHttpClient;

diff --git a/...lient/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpClient43Engine.java b/...lient/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpClient43Engine.java
@@ -5,7 +5,11 @@
 
 /**
  * An Apache HTTP engine for use with the new Builder Config style.
+ *
+ * @deprecated This will be removed in a future release as the underlying default implementation of the
+ *             {@link org.jboss.resteasy.client.jaxrs.ClientHttpEngine} will be replaced.
  */
+@Deprecated(forRemoval = true, since = "6.2")
 public class ApacheHttpClient43Engine extends ManualClosingApacheHttpClient43Engine {
     public ApacheHttpClient43Engine() {
         super();

diff --git a/...-client/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpClientEngine.java b/...-client/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ApacheHttpClientEngine.java
@@ -5,6 +5,12 @@
 import org.jboss.resteasy.client.jaxrs.ClientHttpEngine;
 import org.jboss.resteasy.spi.config.SizeUnit;
 
+/**
+ *
+ * @deprecated This will be removed in a future release as the underlying default implementation of the
+ *             {@link org.jboss.resteasy.client.jaxrs.ClientHttpEngine} will be replaced.
+ */
+@Deprecated(forRemoval = true, since = "6.2")
 public interface ApacheHttpClientEngine extends ClientHttpEngine {
     /**
      * Enumeration to represent memory units.

diff --git a/...ient/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ClientHttpEngineBuilder43.java b/...ient/src/main/java/org/jboss/resteasy/client/jaxrs/engines/ClientHttpEngineBuilder43.java
@@ -44,6 +44,12 @@
 import org.jboss.resteasy.client.jaxrs.spi.ClientConfigProvider;
 import org.jboss.resteasy.spi.PriorityServiceLoader;
 
+/**
+ *
+ * @deprecated This will be removed in a future release as the underlying default implementation of the
+ *             {@link org.jboss.resteasy.client.jaxrs.ClientHttpEngineBuilder} will be replaced.
+ */
+@Deprecated(forRemoval = true, since = "6.2")
 public class ClientHttpEngineBuilder43 implements ClientHttpEngineBuilder {
 
     private ResteasyClientBuilder that;

diff --git a/...asy-client/src/main/java/org/jboss/resteasy/client/jaxrs/engines/HttpContextProvider.java b/...asy-client/src/main/java/org/jboss/resteasy/client/jaxrs/engines/HttpContextProvider.java
@@ -2,6 +2,7 @@
 
 import org.apache.http.protocol.HttpContext;
 
+@Deprecated(forRemoval = true, since = "6.2")
 public interface HttpContextProvider {
     HttpContext getContext();
 }
diff --git a/...n/java/org/jboss/resteasy/client/jaxrs/engines/ManualClosingApacheHttpClient43Engine.java b/...n/java/org/jboss/resteasy/client/jaxrs/engines/ManualClosingApacheHttpClient43Engine.java
@@ -56,7 +56,11 @@
 
 /**
  * An Apache HTTP engine for use with the new Builder Config style.
+ *
+ * @deprecated This will be removed in a future release as the underlying default implementation of the
+ *             {@link org.jboss.resteasy.client.jaxrs.ClientHttpEngine} will be replaced.
  */
+@Deprecated(forRemoval = true, since = "6.2")
 public class ManualClosingApacheHttpClient43Engine implements ApacheHttpClientEngine {
     private static class CleanupAction implements Runnable {
         private final AtomicBoolean closed;