Deprecate io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5, fix #…

…1632
quarkiverse · Feb 6, 2025 · 9468def · 9468def
1 parent f5ebd3f
commit 9468def
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 5 deletions.
diff --git a/...modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc b/...modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc
@@ -6,13 +6,15 @@
 :cq-artifact-id: quarkus-cxf-rt-transports-http-hc5
 :cq-group-id: io.quarkiverse.cxf
 :cq-status: Stable
-:cq-deprecated: false
+:cq-deprecated: true
 :cq-since: 1.1.0
 
 ifeval::[{doc-show-badges} == true]
-Stable • Since 1.1.0
+Stable • Since 1.1.0 • ⚠️Deprecated
 endif::[]
 
+*Deprecated since {quarkus-cxf-project-name} 3.19.0, scheduled for removal in 3.21.0*
+
 Implement async SOAP Clients using Apache HttpComponents HttpClient 5.
 
 

diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc
@@ -7,7 +7,7 @@
 The following table shows the {quarkus-cxf-project-name} extensions.
 Click the extension names to learn more about how to configure and use them, and about any known limitations.
 
-[cols="4,1,1,4"]
+[cols="5,2,1,5"]
 |===
 | Quarkus CXF extension | Support level | Since | Supported standards
 // standards: START
@@ -51,6 +51,7 @@ Click the extension names to learn more about how to configure and use them, and
 | xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[Quarkus CXF HTTP Async Transport] +
 `quarkus-cxf-rt-transports-http-hc5`
 |Stable
+⚠️Deprecated
 |1.1.0
 |
 

diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/async-client.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/async-client.adoc
@@ -0,0 +1,45 @@
+[[async-client]]
+= Asynchronous client
+
+== Synchronous vs. asynchronous
+
+Before {quarkus-cxf-project-name} 3.17.0, CXF clients based on `VertxHttpClientHTTPConduit` could only be called synchronously:
+
+[source,java]
+----
+@CXFClient("hello")
+HelloService hello;
+
+String callHello() {
+    // Synchronous CXF client call
+    hello.hello("Joe");
+}
+----
+
+{quarkus-cxf-project-name} 3.17.0 introduces the asynchronous mode for `VertxHttpClientHTTPConduit`-based clients:
+
+[source,java]
+----
+import io.smallrye.mutiny.Uni;
+
+@CXFClient("hello")
+HelloService hello;
+
+Uni<String> callHelloAsync() {
+    return Uni.createFrom()
+            // Asynchronous CXF client call returning java.util.concurrent.Future
+            .future(hello.helloAsync("Joe"))
+            .map(HelloResponse::getReturn);
+}
+----
+
+This works much like with the existing `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[Apache HttpClient 5 Async HTTP Transport]`.
+The main difference is that you do not need to add the `io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5` dependency to your application anymore.
+
+You still need to
+xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#extensions-quarkus-cxf-rt-transports-http-hc5-usage-generate-async-methods[generate the async methods]
+using the embedded `wsdl2java` tool.
+
+We plan to https://github.com/quarkiverse/quarkus-cxf/issues/1619[add a new documentation page] dedicated to this topic.
+
+We plan to deprecate `io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5` once the asynchronous mode of `VertxHttpClientHTTPConduit` passes some battle testing.
diff --git a/extensions/transports-http-hc5/runtime/pom.xml b/extensions/transports-http-hc5/runtime/pom.xml
@@ -14,6 +14,7 @@
 
     <properties>
         <cq.since>1.1.0</cq.since>
+        <quarkus.metadata.deprecated>true</quarkus.metadata.deprecated>
     </properties>
 
     <dependencies>

diff --git a/extensions/transports-http-hc5/runtime/src/main/doc/intro.adoc b/extensions/transports-http-hc5/runtime/src/main/doc/intro.adoc
@@ -1 +1,7 @@
-Implement async SOAP Clients using Apache HttpComponents HttpClient 5.
+[IMPORTANT]
+====
+This extension is deprecated since {quarkus-cxf-project-name} 3.19.0 and is scheduled for removal in 3.21.0.
+Use 
+====
+
+Implement async SOAP Clients using Apache HttpComponents HttpClient 5.
diff --git a/extensions/transports-http-hc5/runtime/src/main/resources/META-INF/quarkus-extension.yaml b/extensions/transports-http-hc5/runtime/src/main/resources/META-INF/quarkus-extension.yaml
@@ -9,3 +9,5 @@ metadata:
   categories:
     - "integration"
   guide: "https://quarkiverse.github.io/quarkiverse-docs/quarkus-cxf/dev/reference/extensions/quarkus-cxf-rt-transports-http-hc5.html"
+  status: "deprecated"
+  unlisted: true
diff --git a/pom.xml b/pom.xml
@@ -76,7 +76,7 @@
 
         <supported-maven.versions>[3.6.2,)</supported-maven.versions>
 
-        <cq-maven-plugin.version>4.16.1</cq-maven-plugin.version>
+        <cq-maven-plugin.version>4.16.2-SNAPSHOT</cq-maven-plugin.version>
         <exec-maven-plugin.version>3.5.0</exec-maven-plugin.version>
         <groovy-maven-plugin.version>2.1.1</groovy-maven-plugin.version>
         <groovy.version>3.0.23</groovy.version>