From 40e9d7172bf6865919fbd9cc51a5f9462b190b4c Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 11:37:33 +0100 Subject: [PATCH 01/31] Make filename and asciidoc identifers consistent Comments in nav --- docs/modules/ROOT/nav.adoc | 11 +- .../ROOT/pages/contributor-guide/index.adoc | 2 +- docs/modules/ROOT/pages/index.adoc | 2 +- .../reference/extensions/quarkus-cxf.adoc | 4 +- docs/modules/ROOT/pages/reference/index.adoc | 4 +- .../ROOT/pages/release-notes/2.2.0.adoc | 31 ----- .../ROOT/pages/release-notes/2.2.1.adoc | 15 --- .../ROOT/pages/release-notes/2.2.2.adoc | 9 -- .../ROOT/pages/release-notes/2.3.0.adoc | 9 -- .../ROOT/pages/release-notes/2.3.1.adoc | 51 ------- .../ROOT/pages/release-notes/2.4.0.adoc | 19 --- .../ROOT/pages/release-notes/2.5.0.adoc | 39 ------ .../ROOT/pages/release-notes/2.6.0.adoc | 68 ---------- .../ROOT/pages/release-notes/2.6.1.adoc | 8 -- .../ROOT/pages/release-notes/2.7.0.adoc | 71 ---------- .../ROOT/pages/release-notes/2.7.1.adoc | 8 -- .../ROOT/pages/release-notes/3.10.0.adoc | 46 ------- .../ROOT/pages/release-notes/3.11.0.adoc | 53 -------- .../ROOT/pages/release-notes/3.11.1.adoc | 14 -- .../ROOT/pages/release-notes/3.12.0.adoc | 13 -- .../ROOT/pages/release-notes/3.13.0.adoc | 102 -------------- .../ROOT/pages/release-notes/3.13.1.adoc | 25 ---- .../ROOT/pages/release-notes/3.14.0.adoc | 41 ------ .../ROOT/pages/release-notes/3.15.0.adoc | 62 --------- .../ROOT/pages/release-notes/3.8.0.adoc | 45 ------- .../ROOT/pages/release-notes/3.8.1.adoc | 92 ------------- .../ROOT/pages/release-notes/3.8.2.adoc | 29 ---- .../ROOT/pages/release-notes/3.8.3.adoc | 9 -- .../ROOT/pages/release-notes/3.8.4.adoc | 50 ------- .../ROOT/pages/release-notes/3.8.5.adoc | 16 --- .../ROOT/pages/release-notes/3.8.6.adoc | 40 ------ .../ROOT/pages/release-notes/3.9.0.adoc | 28 ---- .../ROOT/pages/release-notes/index.adoc | 1 + docs/modules/ROOT/pages/release-planning.adoc | 1 + .../ROOT/pages/security-guide/index.adoc | 8 +- .../ws-securitypolicy-auth.adoc | 10 +- .../cdi-scope-of-cxfclient.adoc | 3 +- .../client-endpoint-url-defaults.adoc | 1 + .../configure-multiple-clients.adoc | 1 + .../dynamic-client-configuration.adoc | 1 + .../prevent-resource-leaks.adoc | 2 +- ...matic-client-configuration-at-startup.adoc | 1 + .../pure-client-applications.adoc | 2 +- .../user-guide/advanced-service-topics.adoc | 1 + .../jax-ws-providers.adoc | 2 +- .../running-behind-a-reverse-proxy.adoc | 1 + .../advanced-soap-client-topics.adoc | 1 + docs/modules/ROOT/pages/user-guide/auth.adoc | 70 ---------- .../pages/user-guide/camel-integration.adoc | 1 + .../ROOT/pages/user-guide/configuration.adoc | 1 + .../user-guide/contract-first-code-first.adoc | 1 + .../generate-java-from-wsdl.adoc | 1 + .../generate-wsdl-from-java.adoc | 1 + .../ROOT/pages/user-guide/create-project.adoc | 1 + .../ROOT/pages/user-guide/examples.adoc | 1 + .../pages/user-guide/first-soap-client.adoc | 1 + .../user-guide/first-soap-web-service.adoc | 2 +- docs/modules/ROOT/pages/user-guide/index.adoc | 2 +- .../interceptors-features-handlers.adoc | 1 + .../cxf-interceptors-and-features.adoc | 2 +- .../jax-ws-handlers.adoc | 4 +- .../package-for-jvm-and-native.adoc | 1 + .../pages/user-guide/payload-logging.adoc | 1 + .../user-guide/soap-payloads-with-jaxb.adoc | 1 + docs/modules/ROOT/pages/user-guide/ssl.adoc | 126 ------------------ update-upstream.py | 75 +++++++++++ 66 files changed, 131 insertions(+), 1214 deletions(-) delete mode 100644 docs/modules/ROOT/pages/release-notes/2.2.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.2.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.2.2.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.3.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.3.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.4.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.5.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.6.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.6.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.7.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/2.7.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.10.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.11.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.11.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.12.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.13.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.13.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.14.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.15.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.0.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.1.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.2.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.3.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.4.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.5.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.8.6.adoc delete mode 100644 docs/modules/ROOT/pages/release-notes/3.9.0.adoc delete mode 100644 docs/modules/ROOT/pages/user-guide/auth.adoc delete mode 100644 docs/modules/ROOT/pages/user-guide/ssl.adoc create mode 100644 update-upstream.py diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index b38894467..0c8c5d36b 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,3 +1,4 @@ +// user-guide * xref:user-guide/index.adoc[User guide] ** xref:user-guide/create-project.adoc[Create a new project] ** xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] @@ -28,10 +29,13 @@ ** xref:user-guide/camel-integration.adoc[Camel Integration] ** xref:user-guide/examples.adoc[Examples] * xref:security-guide/index.adoc[Security guide] -** xref:user-guide/ssl.adoc[SSL, TLS and HTTPS] +** xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] ** xref:user-guide/auth.adoc[Authentication and authorization] ** xref:security-guide/ws-securitypolicy-auth.adoc[WS-SecurityPolicy Authentication] + +// release-notes * xref:release-notes/index.adoc[Release notes] + ifeval::[{doc-is-main} == true] ** xref:release-notes/3.15.0.adoc[3.15.0 LTS] ** xref:release-notes/3.14.0.adoc[3.14.0] @@ -61,10 +65,15 @@ ifeval::[{doc-is-main} == true] ** xref:release-notes/2.2.1.adoc[2.2.1 LTS] ** xref:release-notes/2.2.0.adoc[2.2.0 LTS] endif::[] + +// release-planning * xref:release-planning.adoc[Release planning] * xref:contributor-guide/index.adoc[Contributor guide] ** xref:contributor-guide/releasing.adoc[Releasing] + +// reference * xref:reference/index.adoc[Reference] + // extensions: START ** xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF] ** xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] diff --git a/docs/modules/ROOT/pages/contributor-guide/index.adoc b/docs/modules/ROOT/pages/contributor-guide/index.adoc index 5c5789005..147057733 100644 --- a/docs/modules/ROOT/pages/contributor-guide/index.adoc +++ b/docs/modules/ROOT/pages/contributor-guide/index.adoc @@ -1,4 +1,4 @@ -[[contributor-guide]] +[[contributor-guide-index]] = Contributor guide diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index ac157e3da..7950f1dcb 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,4 +1,4 @@ -[[cxf-extension-for-quarkus]] +[[{quarkus-cxf-project-name}-index]] = {quarkus-cxf-project-name} This project aims at porting http://cxf.apache.org/[Apache CXF] to https://quarkus.io/[Quarkus] runtime diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc index 43f574ece..8de0c0c6e 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc @@ -57,8 +57,8 @@ There are several chapters in the xref:user-guide/index.adoc[User guide] coverin * xref:user-guide/configuration.adoc[Configuration] * xref:user-guide/package-for-jvm-and-native.adoc[Package for JVM and native] * xref:user-guide/payload-logging.adoc[Logging] -* xref:user-guide/ssl.adoc[SSL] -* xref:user-guide/auth.adoc[Authentication and authorization] +* xref:user-guide/ssl-tls-https.adoc[SSL] +* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] * xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] * xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[Running behind a reverse proxy] * xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index 404d0522c..92e9d1fc3 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -1,4 +1,4 @@ -[[reference]] +[[reference-index]] = Reference [[extensions]] @@ -95,7 +95,7 @@ Out of https://cxf.apache.org/docs/transports.html[CXF Transports] only the foll * `quarkus-cxf` implements its own custom transport based on Quarkus and Vert.x for serving SOAP endpoints * HTTP client via `xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]`, including -** xref:user-guide/auth.adoc#_client_http_basic_authentication[Basic Authentication] +** xref:user-guide/authentication-authorization.adoc#_client_http_basic_authentication[Basic Authentication] * https://cxf.apache.org/docs/asynchronous-client-http-transport.html[Asynchronous Client HTTP Transport] via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` diff --git a/docs/modules/ROOT/pages/release-notes/2.2.0.adoc b/docs/modules/ROOT/pages/release-notes/2.2.0.adoc deleted file mode 100644 index a5fdd1a01..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.2.0.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= {quarkus-cxf-project-name} 2.2.0 LTS release notes - -== Important dependency upgrades: - -* Quarkus 3.1.0.Final -> 3.2.0.Final - https://quarkus.io/blog/quarkus-3-2-0-final-released/[Quarkus 3.2.0.Final release notes] -* CXF 4.0.1 -> 4.0.2 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.1+++...+++cxf-4.0.2[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== XJC plugin options are now tested and documented - -See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC plugins] reference page. - -=== Metrics Feature tested and documented - -The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] extension has got -a proper https://github.com/quarkiverse/quarkus-cxf/tree/2.7.0/integration-tests/metrics[test] -and a basic xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide]. - -[NOTE] -==== -This extension is still considered experimental. -==== - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/907[`wsdl2java` does not work when the module is built from another directory using `mvn -f "module/pom.xml"`] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.1.0+++...+++2.2.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.2.1.adoc b/docs/modules/ROOT/pages/release-notes/2.2.1.adoc deleted file mode 100644 index a68afdaad..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.2.1.adoc +++ /dev/null @@ -1,15 +0,0 @@ -= {quarkus-cxf-project-name} 2.2.1 LTS release notes - -== New and noteworthy in {quarkus-cxf-project-name} - -=== HTTP Async Transport extension stable - -The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/939[`org.apache.wss4j.dom.transform.STRTransform` broken in WSS4j 3.0.0] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.2.0+++...+++2.2.1 diff --git a/docs/modules/ROOT/pages/release-notes/2.2.2.adoc b/docs/modules/ROOT/pages/release-notes/2.2.2.adoc deleted file mode 100644 index 4d594199a..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.2.2.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= {quarkus-cxf-project-name} 2.2.2 LTS release notes - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/860[io.quarkus.builder.ChainBuildException: Cycle detected] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.2.1+++...+++2.2.2 diff --git a/docs/modules/ROOT/pages/release-notes/2.3.0.adoc b/docs/modules/ROOT/pages/release-notes/2.3.0.adoc deleted file mode 100644 index 05ea42216..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.3.0.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= {quarkus-cxf-project-name} 2.3.0 release notes - -== Important dependency upgrades: - -* Quarkus 3.2.0 -> 3.3.0 - https://quarkus.io/blog/quarkus-3-3-0-released/[Quarkus 3.3.0 release notes] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.2.2+++...+++2.3.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.3.1.adoc b/docs/modules/ROOT/pages/release-notes/2.3.1.adoc deleted file mode 100644 index 3e6a403f4..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.3.1.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= {quarkus-cxf-project-name} 2.3.1 release notes - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Client timeouts, proxy settings, etc. configurable through `application.properties` - -In plain CXF, these are set via `HTTPClientPolicy`. -{quarkus-cxf-project-name} now offers configuration options to set them: - -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-timeout[quarkus.cxf.client."client-name".connection-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-receive-timeout[quarkus.cxf.client."client-name".receive-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-request-timeout[quarkus.cxf.client."client-name".connection-request-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-max-retransmits[quarkus.cxf.client."client-name".max-retransmits]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-allow-chunking[quarkus.cxf.client."client-name".allow-chunking]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunking-threshold[quarkus.cxf.client."client-name".chunking-threshold]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunk-length[quarkus.cxf.client."client-name".chunk-length]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept[quarkus.cxf.client."client-name".accept]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-language[quarkus.cxf.client."client-name".accept-language]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-encoding[quarkus.cxf.client."client-name".accept-encoding]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-content-type[quarkus.cxf.client."client-name".content-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-host[quarkus.cxf.client."client-name".host]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection[quarkus.cxf.client."client-name".connection]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-cache-control[quarkus.cxf.client."client-name".cache-control]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-decoupled-endpoint[quarkus.cxf.client."client-name".decoupled-endpoint]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server[quarkus.cxf.client."client-name".proxy-server]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-port[quarkus.cxf.client."client-name".proxy-server-port]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-non-proxy-hosts[quarkus.cxf.client."client-name".non-proxy-hosts]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-type[quarkus.cxf.client."client-name".proxy-server-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-username[quarkus.cxf.client."client-name".proxy-username]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-password[quarkus.cxf.client."client-name".proxy-password]` - -=== `HTTPConduitFactory` configurable through `application.properties` - -There is a new option -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[quarkus.cxf.client."client-name".http-conduit-factory]` -intended primarily as a workaround for https://issues.apache.org/jira/browse/CXF-8885[CXF-8885] -and https://github.com/quarkiverse/quarkus-cxf/issues/992[#992]. -Those are about `java.net.http.HttpClient`-based CXF clients leaking threads. -The default value `QuarkusCXFDefault` prevents this issue -while the option still allows using `java.net.http.HttpClient`-based clients by using the `HttpClientHTTPConduitFactory` value. - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/953[QuarkusCxfProcessor is too noisy: "Generated class ..."] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.3.0+++...+++2.3.1 diff --git a/docs/modules/ROOT/pages/release-notes/2.4.0.adoc b/docs/modules/ROOT/pages/release-notes/2.4.0.adoc deleted file mode 100644 index 4f5ba2d0c..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.4.0.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= {quarkus-cxf-project-name} 2.4.0 release notes - -== Important dependency upgrades: - -* Quarkus 3.3.0 -> 3.4.1 - https://quarkus.io/blog/quarkus-3-4-1-released/[Quarkus 3.4.1 release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== More `wsdl2java` options configurable through `application.properties` - -See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] page. - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/491[Injected CXFClientInfo does not reflect the wsdl and client-endpoint-url set in application.properties] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.3.1+++...+++2.4.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.5.0.adoc b/docs/modules/ROOT/pages/release-notes/2.5.0.adoc deleted file mode 100644 index 1f9c3bc00..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.5.0.adoc +++ /dev/null @@ -1,39 +0,0 @@ -= {quarkus-cxf-project-name} 2.5.0 release notes - -== Important dependency upgrades: - -* CXF 4.0.2 -> 4.0.3 - https://cxf.apache.org/download.html[release notes], https://github.com/apache/cxf/compare/cxf-4.0.2+++...+++cxf-4.0.3[changelog] -* Quarkus 3.4.0 -> 3.5.0 - https://quarkus.io/blog/quarkus-3-5-0-released/[Quarkus 3.5.0 release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== `TLSClientParameters` configurable through `application.properties` - -The trust store and host name verifier of a client are now configurable through some new configuration properties: - -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-hostname-verifier[quarkus.cxf.client."client-name".hostname-verifier] - -=== `LoggingFeature` configurable through `application.properties` - -See the xref:user-guide/payload-logging.adoc[Logging] page. - -=== WS-Security configurable through `application.properties` - -See the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[Configuration] section of the WS-Security reference page. - -[NOTE] -==== -Many of the new options are exprimental because they are https://github.com/quarkiverse/quarkus-cxf/issues/1052[not yet covered by tests]. -==== - -== Fixed bugs - -* https://github.com/quarkiverse/quarkus-cxf/issues/1031[soap-binding property ignored in version 2.4.0] -* https://github.com/quarkiverse/quarkus-cxf/issues/628[HTTPS enforced via HttpsToken WS-SecurityPolicy does not work] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.4.0+++...+++2.5.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.6.0.adoc b/docs/modules/ROOT/pages/release-notes/2.6.0.adoc deleted file mode 100644 index 9d507cb2e..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.6.0.adoc +++ /dev/null @@ -1,68 +0,0 @@ -= {quarkus-cxf-project-name} 2.6.0 release notes - -== Important dependency upgrades: - -* Santuario XML Security 3.0.2 -> 3.0.3 - https://github.com/apache/santuario-xml-security-java/compare/xmlsec-3.0.2+++...+++xmlsec-3.0.3[changelog] -* WSS4J 3.0.1 -> 3.0.2 - link:https://github.com/apache/ws-wss4j/compare/wss4j-3.0.1+++...+++wss4j-3.0.2[changelog] -* Quarkus 3.5.0 -> 3.6.0 - https://quarkus.io/blog/quarkus-3-6-0-released/[Quarkus 3.6.0 release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Logging extension is deprecated - -The Logging functionality and all associated -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-logging-enabled-for[configuration options] were moved to `io.quarkiverse.cxf:quarkus-cxf` extension. -The `io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` extension is now deprecated and you can remove it from your projects. -It will be removed altogether in the future. - -=== `quarkus.cxf.http-conduit-factory` fixed - -See https://github.com/quarkiverse/quarkus-cxf/issues/1047[#1047] - -=== Configurable destination folder of `wsdl2java` - -The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable -via the `xref:reference/extensions/quarkus-cxf#quarkus-cxf_quarkus.cxf.codegen.wsdl2java.output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property. - -=== Possible thread leaks with CXF clients using `java.net.http.HttpClient` - -[NOTE] -==== -This issue was originally reported as https://issues.apache.org/jira/browse/CXF-8885[CXF-8885]. -==== - -CXF client proxies implement `java.io.Closeable`. -Therefore, it is important to call `((Closeable) proxy).close()` once the client is not needed anymore -to free all associated system resources, such as threads. - -{quarkus-cxf-project-name} now takes care for closing the clients injected via `@io.quarkiverse.cxf.annotation.CXFClient` automatically -as soon as they are disposed by the CDI container. - -For client proxies created manually, it is up to you to call `((Closeable) proxy).close()`. - -For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] section of the user guide. - -=== Large responses not written slowly anymore - -Before {quarkus-cxf-project-name} 2.6.0, large responses were written slowly due to allocating too small buffers. -This https://github.com/quarkiverse/quarkus-cxf/issues/1066[issue] is now fixed. - - -=== More WS-Security configuration options covered by tests - -We are continually improving the test coverage of the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[WS-Security configuration options]. -There is now less options marked with the warning - -[quote] -____ -This option is experimental, because it is not covered by tests yet. -____ - -=== Documentation improvements - -* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[X-Forwarded support] page - - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.5.0+++...+++2.6.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.6.1.adoc b/docs/modules/ROOT/pages/release-notes/2.6.1.adoc deleted file mode 100644 index d6597f99b..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.6.1.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= {quarkus-cxf-project-name} 2.6.1 release notes - -This maintenance release brings no fixes visible in end user applications. -It is rather fixing some project internal build and testing issues. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.6.0+++...+++2.6.1 diff --git a/docs/modules/ROOT/pages/release-notes/2.7.0.adoc b/docs/modules/ROOT/pages/release-notes/2.7.0.adoc deleted file mode 100644 index 93b16c6da..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.7.0.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= {quarkus-cxf-project-name} 2.7.0 release notes - -== Important dependency upgrades: - -* Quarkus 3.6.0 -> 3.7.0 - https://quarkus.io/blog/quarkus-3-7-released/[Quarkus 3.7 release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Java 17 required - -Following the Java baseline https://github.com/quarkusio/quarkus/pull/37335[upgrade in Quarkus], {quarkus-cxf-project-name} now also requires Java 17 or newer to build -and run your applications. - -=== WS-ReliableMessaging (WS-RM) supported - -The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. -Both was added in this release and thus the extension status could be promoted from `experimental` to `stable`. - -Check the following resources: - -* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-usage[Usage] section of the reference page -* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-configuration[Configuration options]. - -=== Metrics Feature supported - -Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature]'s support status is now `stable`, -after we have improved -the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide] -and added some xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-configuration[Configuration options]. - -=== New OpenTelemetry tracing extension - -There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] extension. -It currently supports only tracing. -OpenTelemetry Metrics and Logging and not implemented yet. - -=== DevUI - -When you start Quarkus in dev mode using `mvn quarkus:dev` then you can find the DevUI at http://localhost:8080/q/dev-ui[http://localhost:8080/q/dev-ui]. -There are now separate cards listing CXF http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/clients[clients] and http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/service-endpoints[services]. - -Here is a screenshot of the http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/service-endpoints[Service endpoints] card: - -image::release-notes-2.7.0-devui-services.png[DevUI] - - -=== Schema validation configurable via `application.properties` - -See `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-schema-validation-enabled-for[quarkus.cxf.client."client-name".schema-validation.enabled-for]` - -=== Basic authentication for the WSDL - -{quarkus-cxf-project-name} now sends the -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[username] -and xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[password] -when getting the WSDL document, -as long as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` is `true`. - - - -=== Documentation improvements - -* New `xref:user-guide/ssl.adoc[SSL guide]` -* New `xref:user-guide/auth.adoc[Authentication and authorization guide]` -* Improved the xref:user-guide/payload-logging.adoc[Logging guide] -* Improved the documentation of `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` - and `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.6.1+++...+++2.7.0 diff --git a/docs/modules/ROOT/pages/release-notes/2.7.1.adoc b/docs/modules/ROOT/pages/release-notes/2.7.1.adoc deleted file mode 100644 index 5570cab2f..000000000 --- a/docs/modules/ROOT/pages/release-notes/2.7.1.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= {quarkus-cxf-project-name} 2.7.1 release notes - -This maintenance release brings no fixes visible in end user applications. -It is rather fixing some project internal build and testing issues. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.7.0+++...+++2.7.1 diff --git a/docs/modules/ROOT/pages/release-notes/3.10.0.adoc b/docs/modules/ROOT/pages/release-notes/3.10.0.adoc deleted file mode 100644 index dcd361f88..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.10.0.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= {quarkus-cxf-project-name} 3.10.0 release notes - -== Important dependency upgrades - -* Quarkus 3.9.x -> 3.10.0 - https://quarkus.io/blog/quarkus-3-10-0-released/[3.10 release notes] -* Woodstox 6.6.1 -> 6.6.2 link:https://github.com/FasterXML/woodstox/compare/woodstox-core-6.6.1+++...+++woodstox-core-6.6.2[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Windows CI - -We started testing every pull request on Windows. -Unfortunately, we have to skip all integration tests that require a container, -because GitHub Actions Windows workers do not allow running Linux containers yet. - -=== In-App SmallRye Config SPI implementations work again - -The bug https://github.com/quarkiverse/quarkus-cxf/issues/1332[#1332] alias https://github.com/quarkusio/quarkus/issues/[quarkus#39689] -got fixed in {quarkus-cxf-project-name} 3.10.0. - -=== Sevice methods with the same name in the same Java package - -If there are two SEIs in one Java package, both having a `@WebMethod` with the same name but different signature, -then the default name for the ASM-generated request, response and possibly other classes is the same for both methods of both classes. - -Before {quarkus-cxf-project-name} 3.10.0 and 3.8.4, no exception was thrown when this happened during the class generation. -At runtime, only one set of those classes was present and calls to one of the clients failed inevitably. - -Since {quarkus-cxf-project-name} 3.10.0 and 3.8.4, the problem is detected at build time and the build fails. - -This was reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/1326[#1326]. -We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether a proper solution is possible in CXF. - -=== Documentation Improvements - -* All configuration properties are now tagged with the version of {quarkus-cxf-project-name} since which they exist. -+ -image::release-notes-2.10.0-since.png[The new since tag] -+ -* We added the xref:release-notes/index.adoc[Version table] to the Release notes page showing which version of - {quarkus-cxf-project-name} uses which CXF version and which Quarkus Platform `.` you should use - to get the given {quarkus-cxf-project-name} version. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.9.0+++...+++3.10.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.11.0.adoc b/docs/modules/ROOT/pages/release-notes/3.11.0.adoc deleted file mode 100644 index 5cb106e5e..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.11.0.adoc +++ /dev/null @@ -1,53 +0,0 @@ -= {quarkus-cxf-project-name} 3.11.0 release notes - -== Important dependency upgrades - -* Quarkus 3.10.x -> 3.11.0 - https://quarkus.io/blog/quarkus-3-11-0-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== `@CXFEndpoint("/my-service")` - a new annotation for specifying the service endpoint path - -Since this {quarkus-cxf-project-name} 3.11.0, there is a new way to expose an endpoint under a specific path: -the `@io.quarkiverse.cxf.annotation.CXFEndpoint` annotation. -The path is set through its non-optional attribute `value` and it is relative to `quarkus.cxf.path` much like when this is done via `application.properties`. - -Here is basic example: - -[source,java] ----- -@CXFEndpoint("/path-annotation") -@WebService(serviceName = "HelloService", targetNamespace = "https://acme.org/my-service") -public class HelloServiceImpl implements HelloService { - @Override - public String hello(String person) { - ... - } -} ----- - -You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths]. - -=== Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container - -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package -were only instantiated using reflection. -Due to this, injecting beans and configuration values into them did not work. - -Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, those interceptors are looked up in the CDI container first -and reflexive instantiation is used only as a fallback. -Injecting other beans and configuration values into interceptor beans created by the CDI container will work flawlessly. - -=== `@WebService(wsdlLocation="my-service.wsdl")` now honored - -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, when a web service implementation had an annotation like `@WebService(wsdlLocation="my-service.wsdl")`, -then only an auto-generated WSDL without policies and other important parts was served on `http://localhost:8080/services/foo?wsdl` -instead the local WSDL file. - -Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, the `wsdlLocation` attribute of the `@WebService` annotation is honored properly. - -This was originally reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/557[#557]. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.10.0+++...+++3.11.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.11.1.adoc b/docs/modules/ROOT/pages/release-notes/3.11.1.adoc deleted file mode 100644 index 083eb31b8..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.11.1.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= {quarkus-cxf-project-name} 3.11.1 release notes - -== New and noteworthy in {quarkus-cxf-project-name} - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1399[#1399] Beans not injected into a service impl with `@CXFEndpoint("/my-path")` - -In {quarkus-cxf-project-name} 3.11.0, we added a new feature allowing to specify service endpoint paths through a new annotation `@CXFEndpoint("/myPath")`. -The new code did not work well for service implementation classes having both `@WebService` and `@CXFEndpoint` annotations. -In those cases, if the service had some `@Inject` fields, those fields were left blank and the service call has thrown a `NullPointerException`. -This issue was fixed in In {quarkus-cxf-project-name} 3.11.1. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.11.0+++...+++3.11.1 diff --git a/docs/modules/ROOT/pages/release-notes/3.12.0.adoc b/docs/modules/ROOT/pages/release-notes/3.12.0.adoc deleted file mode 100644 index 57f5ddc73..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.12.0.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= {quarkus-cxf-project-name} 3.12.0 release notes - -== Important dependency upgrades - -* Quarkus 3.11.x -> 3.12.0 - https://quarkus.io/blog/quarkus-3-12-0-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -There are no changes with a direct user impact in this release. We just did some housekeeping. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.11.1+++...+++3.12.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.13.0.adoc b/docs/modules/ROOT/pages/release-notes/3.13.0.adoc deleted file mode 100644 index 935bbc4c5..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.13.0.adoc +++ /dev/null @@ -1,102 +0,0 @@ -= {quarkus-cxf-project-name} 3.13.0 release notes - -== Important dependency upgrades - -* Quarkus 3.12.x -> 3.13.0 - https://quarkus.io/blog/quarkus-3-13-0-released/[release notes] -* Woodstox 6.6.2 -> 7.0.0 - link:https://github.com/FasterXML/woodstox/blob/master/release-notes/VERSION[release notes], link:https://github.com/FasterXML/woodstox/compare/woodstox-core-6.6.2+++...+++woodstox-core-7.0.0[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Vert.x HttpClient based HTTP Conduit - -As Vert.x is the preferred HTTP stack on Quarkus, we decided to implement a new HTTP Conduit based on Vert.x -https://vertx.io/docs/apidocs/io/vertx/core/http/HttpClient.html[HttpClient]. -Although the client per se is non-blocking and asynchronous, our new `VertxHttpClientHTTPConduit` -currently supports only the synchronous usage. -We plan to add the https://github.com/quarkiverse/quarkus-cxf/issues/1447[support for asynchronous mode] in near future. - -To give it a try, set the `http-conduit-factory` configuration option -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[globally] -or -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[per client]: - -.application.properties -[source,properties] ----- -# Set the conduit factory for all clients -quarkus.cxf.http-conduit-factory = VertxHttpClientHTTPConduitFactory - -# Set the conduit factory only for the hello client -quarkus.cxf.client.hello.http-conduit-factory = VertxHttpClientHTTPConduitFactory ----- - -You are welcome to try it and give feedback either on https://github.com/quarkiverse/quarkus-cxf/issues[GitHub Issues] -or https://github.com/quarkiverse/quarkus-cxf/discussions[Discussions]. - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1425[#1425] Injection of `WebServiceContext` into service implementations with `@CXFEndpoint("/my-path")` - -The issue https://github.com/quarkiverse/quarkus-cxf/issues/1425[#1425] made us figure out -that we had no tests at all for injecting `jakarta.xml.ws.WebServiceContext` using the `@jakarta.annotation.Resource` and `@jakarta.annotation.Resources` annotations. -We not only added the the tests and fixed the malfunctioning case with `@CXFEndpoint("/my-path")`, -but we also changed how injecting `@Resource WebServiceContext` was implemented. -Instead of relying on the reflective CXF code that was run at application start, -the scanning is now done at build time by Arc, the CDI container of Quarkus. - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` - -Before {quarkus-cxf-project-name} 3.13.0, the values specified in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` -were wrongly passed as a single comma-separated value of the `-p` option, -leading to `BadUsageException: -p has invalid character!`. - -Since {quarkus-cxf-project-name} 3.13.0, if `quarkus.cxf.codegen.wsdl2java.package-names` specifies multiple mappings, such as - -.application.properties -[source,properties] ----- -quarkus.cxf.codegen.wsdl2java.package-names = - http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add, - http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply ----- - -then they are properly passed to `wsdl2java` as multiple `-p` options: - -.application.properties -[source,console] ----- -wsdl2java \ - -p http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add \ - -p http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply \ - ... ----- - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1427[#1427] Better exception message when a service interface is not available in Jandex - -{quarkus-cxf-project-name} relies heavily on Quarkus class index, a.k.a. https://smallrye.io/blog/jandex-3-0-0/[Jandex], -when inspecting various aspects of the application at build time. - -Before {quarkus-cxf-project-name} 3.13.0, if some important dependency of the application, -for example the one containing the service interfaces, was not indexed, -a `NullPointerException` without any meaningful message was thrown upon looking up a class from that dependency in the index. - -Since {quarkus-cxf-project-name} 3.13.0, the exception became informative, suggesting the user -to add index to the dependency using either `quarkus.index-dependency.*` family of options -or by adding `io.smallrye:jandex-maven-plugin` to the module containing sources of the missing class. -Check {link-quarkus-docs-base}/cdi-reference#how-to-generate-a-jandex-index[How to Generate a Jandex Index] section of -Quarkus Contexts and dependency injection guide for more details. - -=== Documentation improvements - -* https://github.com/quarkiverse/quarkus-cxf/issues/1424[#1424] Replaced references to the non-existent `quarkus.cxf.logging.enabled` option for the correct `quarkus.cxf.logging.enabled-for` option. -* User guide navigation was restructured: some chapters moved under new nodes -** xref:user-guide/contract-first-code-first.adoc[Contract first and code first approaches] -** xref:user-guide/interceptors-features-handlers.adoc[CXF Interceptors and Features, JAX-WS Handlers] -** xref:user-guide/advanced-service-topics.adoc[Advanced service topics] -** xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] -* New chapters: -** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] -** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.12.0+++...+++3.13.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.13.1.adoc b/docs/modules/ROOT/pages/release-notes/3.13.1.adoc deleted file mode 100644 index ca32e8903..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.13.1.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= {quarkus-cxf-project-name} 3.13.1 release notes - -== Important dependency upgrades - -* CXF 4.0.4 -> 4.0.5 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.4+++...+++cxf-4.0.5[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1455[#1455] Vert.x HTTP client is incorrectly used as the default - -We introduced xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 -and it was not supposed to replace the original `HttpURLConnection` based default conduit. -However, we screwed the default handling which resulted in using `VertxHttpClientHTTPConduit` as a default in some cases. -This was fixed in {quarkus-cxf-project-name} 3.13.1. -`HttpURLConnection` based conduit is now used as a default in all situations as it was the case before 3.13.0. -We are sorry for the inconvenience. - -=== Documentation improvements - -* We added a paragraph explaining xref:user-guide/create-project.adoc#quarkus-platform[Quarkus Platform] -* We added the xref:release-planning.adoc[Release planning] page explaining how and when we release {quarkus-cxf-project-name} - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.13.0+++...+++3.13.1 diff --git a/docs/modules/ROOT/pages/release-notes/3.14.0.adoc b/docs/modules/ROOT/pages/release-notes/3.14.0.adoc deleted file mode 100644 index 5cf656223..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.14.0.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= {quarkus-cxf-project-name} 3.14.0 release notes - -== Important dependency upgrades - -* Quarkus 3.13.x -> 3.14.0 - https://quarkus.io/blog/quarkus-3-14-1-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1460[#1460] IllegalArgumentException: port p must be in range 0 <= p <= 65535 when using client-endpoint-url without explicit port - -When using the xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], -the handling of default ports for `http` and `https` client endpoint URLs was broken resulting in an `IllegalArgumentException`. -This was fixed in {quarkus-cxf-project-name} 3.14.0. - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1476[#1476] Missing dependency for OpenTelemetryCustomizer when OTEL is globally disabled - -If OpenTelemetry was disabled via `quarkus.otel.enabled = false`, -then any Quarkus CXF application using `quarkus-cxf-integration-tracing-opentelemetry` would fail at application start -throwing an exception like the following: - ----- -Failed to start quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors - [error]: Build step io.quarkus.arc.deployment.ArcProcessor#validate threw an exception: jakarta.enterprise.inject.spi.DeploymentException: jakarta.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type io.opentelemetry.api.OpenTelemetry and qualifiers [@Default] - - injection target: io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer#openTelemetry - - declared on CLASS bean [types=[io.quarkiverse.cxf.CxfClientProducer$ClientFactoryCustomizer, io.quarkiverse.cxf.transport.CxfHandler$EndpointFactoryCustomizer, java.lang.Object, io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer], qualifiers=[@Default, @Any], target=io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer] ----- - -Since version 3.14.0, the `quarkus-cxf-integration-tracing-opentelemetry` extension checks the value of `quarkus.otel.enabled` at build time -and if the value is `false`, it disables OpenTelemetry for CXF too. - -=== Documentation improvements - -Some substantial refactoring took place in the way how we generate the documentation for the -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[configuration] -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[options]. -Although there are not many https://github.com/quarkiverse/quarkus-cxf/commit/b8913f7fcc58ced6cec9b7c1dc505cfcdd9088f4[observable changes], -please do not hesitate to https://github.com/quarkiverse/quarkus-cxf/issues/new[file an issue] if you spot some irregularity. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.13.1+++...+++3.14.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.15.0.adoc b/docs/modules/ROOT/pages/release-notes/3.15.0.adoc deleted file mode 100644 index d3ab935eb..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.15.0.adoc +++ /dev/null @@ -1,62 +0,0 @@ -= {quarkus-cxf-project-name} 3.15.0 LTS release notes - -This is the first release in the new 3.15 https://quarkus.io/blog/lts-releases/[LTS stream]. -As usual, where we plan to produce patch releases with bug and security fixes for 12 months. - -== Important dependency upgrades - -* Quarkus 3.14.x -> 3.15.0 - https://quarkus.io/blog/quarkus-3-15-1-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1492[#1492] Support using CXF ``TagsCustomizer``s and deprecate dynamic usage of ``MeterFilter``s - -Before {quarkus-cxf-project-name} 3.15.0, it was possible to have a `MeterFilter` adding a `Tag` to a meter -relying on a value retrieved from a `@RequestScoped` bean in the following way: - -[source,java] ----- -import io.micrometer.core.instrument.Meter; -import io.micrometer.core.instrument.Tag; -import io.micrometer.core.instrument.config.MeterFilter; -import jakarta.inject.Inject; -import jakarta.inject.Singleton; - -@Singleton -public class DynamicMeterFilter implements MeterFilter { - - /** A @RequestScoped bean holding a value of an HTTP header */ - @Inject - RequestScopedHeader requestScopedHeader; - - @Override - public Meter.Id map(Meter.Id id) { - if (id.getName().startsWith("http.client") || id.getName().startsWith("cxf.client")) { - return id.withTag(Tag.of("my-header", requestScopedHeader.getHeaderValue())); - } else { - return id; - } - } -} ----- - -The `map()` method would be called on every request and thus the set of tags could be different for every service invocation. - -Since {quarkus-cxf-project-name} 3.15.0, this kind of dynamic `MeterFilter` usage is not possible anymore. -It is due to the upgrade to Micrometer 1.13 brought by Quarkus 3.15.0 that caches return values of `MeterFilter` -methods. Those are therefore called only once. - -==== How to add Tags to Meters with {quarkus-cxf-project-name} 3.15.0+ - -If the old way does not work anymore, how can you do the same with {quarkus-cxf-project-name} 3.15.0 or newer? - -The answer consists in providing a bean implementing `org.apache.cxf.metrics.micrometer.provider.TagsCustomizer` -and making CXF aware of it via the new `xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf_quarkus-cxf-metrics-tags-customizers[quarkus.cxf.metrics.tags-customizers]` configuration property. - -There is an example in our https://github.com/quarkiverse/quarkus-cxf/tree/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5[Apache HTTP Client v5 integration test]. -The crucial parts are the https://github.com/quarkiverse/quarkus-cxf/blob/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5/src/main/java/io/quarkiverse/cxf/hc5/it/HeaderToMetricsTagsCustomizer.java[`TagsCustomizer` implementation] -and the `quarkus.cxf.metrics.tags-customizers = #headerToMetricsTagsCustomizer` line in `https://github.com/quarkiverse/quarkus-cxf/blob/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5/src/main/resources/application.properties#L10[application.properties]`. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.14.0+++...+++3.15.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.0.adoc b/docs/modules/ROOT/pages/release-notes/3.8.0.adoc deleted file mode 100644 index 1e614df44..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.0.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.0 (LTS) release notes - -== Changes in Quarkus - -* See https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.8[Quarkus 3.8 migration guide]. - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Keeping `major.minor` version in sync with Quarkus - -The most significant change in this release is the increment of major version of {quarkus-cxf-project-name} from 2 to 3 -so that our `major.minor` matches the `major.minor` version of Quarkus. - -We did this mostly for practical reasons, so that it is easier for everybody to understand which version of {quarkus-cxf-project-name} -is compatible with which version of Quarkus. - -=== Logging extension removed from the documentation and {link-quarkus-code-generator} - -`io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` is deprecated since {quarkus-cxf-project-name} 2.7.0, -when all its functionality including configuration properties moved to `io.quarkiverse.cxf:quarkus-cxf`. -In 3.8.0, we stopped mentioning it in the documentation and we removed it from {link-quarkus-code-generator}. -To keep backwards compatibility, a dummy `io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` artifact still exists -doing nothing else, but outputting a warning. -You should remove the extension from your projects. - -=== Santuario XMLSec extension moved to {quarkus-cxf-project-name} - -Santuario XMLSec extension was originally hosted under a https://github.com/quarkiverse/quarkus-xmlsec[separate project] -and published as `io.quarkiverse.xmlsec:quarkus-xmlsec`. -As {quarkus-cxf-project-name} is the primary user of it, we decided to move it here to simplify the maintenance. -The new Maven coordinates starting with {quarkus-cxf-project-name} 3.8.0 are `io.quarkiverse.cxf:quarkus-cxf-santuario-xmlsec`. - -=== Improved documentation - -The following parts of the documentation were improved: - -* The Reference page now contains xref:reference/index.adoc#_supported_cxf_annotations[List of supported CXF annotations]. -* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page] -** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy] -** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient] -* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page] with a more detailed example - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/2.7.1+++...+++3.8.0 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.1.adoc b/docs/modules/ROOT/pages/release-notes/3.8.1.adoc deleted file mode 100644 index ce5120881..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.1.adoc +++ /dev/null @@ -1,92 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.1 (LTS) release notes - -== Important dependency upgrades: - -* Quarkus 3.8.0 -> 3.8.2 - https://quarkus.io/blog/quarkus-3-8-released/[3.8.1 release notes], https://quarkus.io/blog/quarkus-3-8-2-released/[3.8.2 release notes] -* CXF 4.0.3 -> 4.0.4 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.3+++...+++cxf-4.0.4[changelog] -* WSS4J 3.0.2 -> 3.0.3 - link:https://github.com/apache/ws-wss4j/compare/wss4j-3.0.2+++...+++wss4j-3.0.3[changelog] -* Santuario XMLSec 3.0.3 -> 3.0.4 link:https://github.com/apache/santuario-xml-security-java/compare/xmlsec-3.0.3+++...+++xmlsec-3.0.4[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Mutual TLS (mTLS) - -Mutual TLS (mTLS) is now xref:user-guide/ssl.adoc#mtls[documented], -https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/mtls[tested] -and and can be configured for clients via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key*]` family of options. - -=== Keystores and truststores now looked up in the file system - -The keystores and truststores are now https://github.com/quarkiverse/quarkus-cxf/issues/1280[really looked up in the file system] -unless they are available in the classpath as documented in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` -and -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key-store]`. - -=== Running on systems with FIPS assertions enabled - -Changes in CXF 4.0.4 and {quarkus-cxf-project-name} 3.8.1 make it possible to run applications using WS-Security on systems with https://en.wikipedia.org/wiki/FIPS_140[FIPS] assertions enabled. - -Those changes are twofold: - -1. Bouncy Castle security provider is not present in the class path anymore. -+ -If your project depends directly or transitively on `org.bouncycastle:bcprov-jdk18on` and you want to keep using it, -then {quarkus-cxf-project-name} will suggest you at build time to exclude `io.quarkiverse.cxf:quarkus-cxf-bc-stub` from `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security`. -`io.quarkiverse.cxf:quarkus-cxf-bc-stub` contains some empty methods to allow native compilation with GraalVM -when Bouncy Castle is not present in class path. - -2. Before CXF 4.0.4 and {quarkus-cxf-project-name} 3.8.1 there was no way to select encryption algorithms compatible with FIPS. -Now there is a way to do so via security policy and Quarkus configuration. -+ -In the policy file, the `AlgorithmSuite` has to be set to `CustomAlgorithmSuite`: -+ -[[custom-algorithm-suite-example]] -[source,xml] ----- - - - - - - ... - - - - - - ... - - - ... - - - ----- -+ -FIPS complaint xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-custom-digest-algorithm[algorithms] can then be set in `application.properties`. -Here, we list the default values that are FIPS complaint already: -+ -[source,properties] ----- -quarkus.cxf.client."client-name".security.custom.digest.algorithm = http://www.w3.org/2001/04/xmlenc#sha256 -quarkus.cxf.client."client-name".security.custom.encryption.algorithm = http://www.w3.org/2009/xmlenc11#aes256-gcm -quarkus.cxf.client."client-name".security.custom.symmetric.key.encryption.algorithm = http://www.w3.org/2001/04/xmlenc#kw-aes256 -quarkus.cxf.client."client-name".security.custom.asymmetric.key.encryption.algorithm = http://www.w3.org/2001/04/xmlenc#rsa-1_5 -quarkus.cxf.client."client-name".security.custom.encryption.key.derivation = http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1 -quarkus.cxf.client."client-name".security.custom.signature.key.derivation = http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1 -quarkus.cxf.client."client-name".security.custom.encryption.derived.key.length = 256 -quarkus.cxf.client."client-name".security.custom.signature.derived.key.length = 192 -quarkus.cxf.client."client-name".security.custom.minimum.symmetric.key.length = 256 -quarkus.cxf.client."client-name".security.custom.maximum.symmetric.key.length = 256 -quarkus.cxf.client."client-name".security.custom.minimum.asymmetric.key.length = 1024 -quarkus.cxf.client."client-name".security.custom.maximum.asymmetric.key.length = 4096 ----- - - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.0+++...+++3.8.1 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.2.adoc b/docs/modules/ROOT/pages/release-notes/3.8.2.adoc deleted file mode 100644 index 2177e55b2..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.2.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.2 (LTS) release notes - -== Important dependency upgrades: - -* Quarkus 3.8.2 -> 3.8.3 - https://quarkus.io/blog/quarkus-3-8-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Change in `org.graalvm.sdk:*` dependencies - -{quarkus-cxf-project-name} extensions now depend on `org.graalvm.sdk:nativeimage` instead of `org.graalvm.sdk:graal-sdk`. -Using `org.graalvm.sdk:graal-sdk` was an oversight on our side. -`org.graalvm.sdk:nativeimage` is just enough for implementing the GraalVM substitutions we need. -If you rely on other transitive dependencies of `org.graalvm.sdk:graal-sdk`, such as `org.graalvm.sdk:polyglot` or `org.graalvm.sdk:collections`, -you will have to add them yourself. - -=== `cxf-rt-databinding-aegis` and `cxf-rt-javascript` not required by `quarkus-cxf-deployment` anymore. - -`io.quarkiverse.cxf:quarkus-cxf-deployment` takes care for build time tasks related to `io.quarkiverse.cxf:quarkus-cxf`. -Before this release, it depended transitively on `org.apache.cxf:cxf-rt-databinding-aegis` and `org.apache.cxf:cxf-rt-javascript` via `org.apache.cxf:cxf-tools-java2ws`. -It was an oversight on our side. -We never intended to support using Aegis or Javascript at runtime or build time. -We have made that by listing them under xref:reference/index.adoc#unsupported[Unsupported CXF modules]. -The current change makes it impossible to generate WSDL from Aegis model classes at build time. -The `java2js` functionality was never accessible via `io.quarkiverse.cxf:quarkus-cxf-deployment`. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.1+++...+++3.8.2 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.3.adoc b/docs/modules/ROOT/pages/release-notes/3.8.3.adoc deleted file mode 100644 index a54b9e4af..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.3.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.3 (LTS) release notes - -== New and noteworthy in {quarkus-cxf-project-name} - -This release contains just two bug fixes. Check the changelog below for details. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.2+++...+++3.8.3 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.4.adoc b/docs/modules/ROOT/pages/release-notes/3.8.4.adoc deleted file mode 100644 index c69dea59e..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.4.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.4 (LTS) release notes - -== Important dependency upgrades: - -* Quarkus 3.8.3 -> 3.8.4 - https://quarkus.io/blog/quarkus-3-8-4-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Sevice methods with the same name in the same Java package - -If there are two SEIs in one Java package, both having a `@WebMethod` with the same name but different signature, -then the default name for the ASM-generated request, response and possibly other classes is the same for both methods of both classes. - -Before {quarkus-cxf-project-name} 3.10.0 and 3.8.4, no exception was thrown when this happened during the class generation. -At runtime, only one set of those classes was present and calls to one of the clients failed inevitably. - -Since {quarkus-cxf-project-name} 3.10.0 and 3.8.4, the problem is detected at build time and the build fails. - -This was reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/1326[#1326]. -We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether a proper solution is possible in CXF. - -=== Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container - -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package -were only instantiated using reflection. -Due to this, injecting beans and configuration values into them did not work. - -Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, those interceptors are looked up in the CDI container first -and reflexive instantiation is used only as a fallback. -Injecting other beans and configuration values into interceptor beans created by the CDI container will work flawlessly. - -=== `@WebService(wsdlLocation="my-service.wsdl")` now honored - -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, when a web service implementation had an annotation like `@WebService(wsdlLocation="my-service.wsdl")`, -then only an auto-generated WSDL without policies and other important parts was served on `http://localhost:8080/services/foo?wsdl` -instead the local WSDL file. - -Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, the `wsdlLocation` attribute of the `@WebService` annotation is honored properly. - -This was originally reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/557[#557]. - -=== Other minor changes - -* Improved FIPS and OpenTelemetry related test coverage -* Typos and minor rewordings in the documentation -* Dependency management improvements - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.3+++...+++3.8.4 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.5.adoc b/docs/modules/ROOT/pages/release-notes/3.8.5.adoc deleted file mode 100644 index 247ff98c1..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.5.adoc +++ /dev/null @@ -1,16 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.5 (LTS) release notes - -== Important dependency upgrades: - -* Quarkus 3.8.4 -> 3.8.5 - https://quarkus.io/blog/quarkus-3-8-5-released/[release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Support for `@CXFEndpoint("/myPath")` reverted - -In {quarkus-cxf-project-name} 3.8.4 we mistakenly backported a new feature to the 3.8 maintenance branch. -This change was reverted in 3.8.5. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.4+++...+++3.8.5 diff --git a/docs/modules/ROOT/pages/release-notes/3.8.6.adoc b/docs/modules/ROOT/pages/release-notes/3.8.6.adoc deleted file mode 100644 index 63b14c196..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.8.6.adoc +++ /dev/null @@ -1,40 +0,0 @@ -= {quarkus-cxf-project-name} 3.8.6 (LTS) release notes - -== Important dependency upgrades: - -* Quarkus 3.8.5 -> 3.8.6 - https://quarkus.io/blog/quarkus-3-8-6-released/[release notes] -* CXF 4.0.4 -> 4.0.5 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.4+++...+++cxf-4.0.5[changelog] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` - -Before {quarkus-cxf-project-name} 3.13.0 and 3.8.6, the values specified in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` -were wrongly passed as a single comma-separated value of the `-p` option, -leading to `BadUsageException: -p has invalid character!`. - -Since {quarkus-cxf-project-name} 3.13.0 and 3.8.6, if `quarkus.cxf.codegen.wsdl2java.package-names` specifies multiple mappings, such as - -.application.properties -[source,properties] ----- -quarkus.cxf.codegen.wsdl2java.package-names = - http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add, - http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply ----- - -then they are properly passed to `wsdl2java` as multiple `-p` options: - -.application.properties -[source,console] ----- -wsdl2java \ - -p http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add \ - -p http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply \ - ... ----- - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.5+++...+++3.8.6 diff --git a/docs/modules/ROOT/pages/release-notes/3.9.0.adoc b/docs/modules/ROOT/pages/release-notes/3.9.0.adoc deleted file mode 100644 index 835dccb40..000000000 --- a/docs/modules/ROOT/pages/release-notes/3.9.0.adoc +++ /dev/null @@ -1,28 +0,0 @@ -= {quarkus-cxf-project-name} 3.9.0 release notes - -== Important dependency upgrades - -* Quarkus 3.8.2 -> 3.9.0 - https://quarkus.io/blog/quarkus-3-9-1-released/[3.9 release notes] - -== New and noteworthy in {quarkus-cxf-project-name} - -=== Change in `org.graalvm.sdk:*` dependencies - -{quarkus-cxf-project-name} extensions now depend on `org.graalvm.sdk:nativeimage` instead of `org.graalvm.sdk:graal-sdk`. -Using `org.graalvm.sdk:graal-sdk` was an oversight on our side. -`org.graalvm.sdk:nativeimage` is just enough for implementing the GraalVM substitutions we need. -If you rely on other transitive dependencies of `org.graalvm.sdk:graal-sdk`, such as `org.graalvm.sdk:polyglot` or `org.graalvm.sdk:collections`, -you will have to add them yourself. - -=== Improved documentation - -The following parts of the documentation were improved: - -* We published a bunch of xref:release-notes/index.adoc[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. -* Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling. -* We added xref:release-notes/index.adoc#version-table[Version table] to the release notes page. - It shows which Quarkus CXF version is available in which Quarkus Platform version and which CXF version it depends on. - -== Full changelog - -https://github.com/quarkiverse/quarkus-cxf/compare/3.8.1+++...+++3.9.0 diff --git a/docs/modules/ROOT/pages/release-notes/index.adoc b/docs/modules/ROOT/pages/release-notes/index.adoc index f2a5da4dd..f5f7a0cab 100644 --- a/docs/modules/ROOT/pages/release-notes/index.adoc +++ b/docs/modules/ROOT/pages/release-notes/index.adoc @@ -1,3 +1,4 @@ +[[release-notes-index]] = Release notes ifeval::[{doc-is-main} != true] diff --git a/docs/modules/ROOT/pages/release-planning.adoc b/docs/modules/ROOT/pages/release-planning.adoc index af25d4f8e..32f162919 100644 --- a/docs/modules/ROOT/pages/release-planning.adoc +++ b/docs/modules/ROOT/pages/release-planning.adoc @@ -1,3 +1,4 @@ +[[release-planning]] = Release planning == Major and minor releases diff --git a/docs/modules/ROOT/pages/security-guide/index.adoc b/docs/modules/ROOT/pages/security-guide/index.adoc index c4d34fc44..6463adac5 100644 --- a/docs/modules/ROOT/pages/security-guide/index.adoc +++ b/docs/modules/ROOT/pages/security-guide/index.adoc @@ -1,8 +1,8 @@ -[[security-guide]] +[[security-guide-index]] = Security guide The Security guide documents various security related aspects of {quarkus-cxf-project-name}: -* xref:user-guide/ssl.adoc[SSL, TLS and HTTPS] -* xref:user-guide/auth.adoc[Authentication and authorization] -* xref:security-guide/ws-securitypolicy-auth.adoc[Authentication enforced by WS-SecurityPolicy] +* xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] +* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] +* xref:security-guide/ws-securitypolicy-authentication-authorization.adoc[Authentication enforced by WS-SecurityPolicy] diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc index 356c39595..a145e5d83 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc @@ -1,8 +1,8 @@ [[ws-securitypolicy-auth]] = Authentication enforced by WS-SecurityPolicy -You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/auth.adoc#_client_http_basic_authentication[clients] -and xref:user-guide/auth.adoc#_securing_service_endpoints[services]. +You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc#_client_http_basic_authentication[clients] +and xref:user-guide/authentication-authorization.adoc#_securing_service_endpoints[services]. To enforce authentication through WS-SecurityPolicy, follow these steps: @@ -50,7 +50,7 @@ There are two ways how you can associate this policy file with a service endpoin .UsernameTokenPolicyHelloService.java [source,java] ---- -include::example$ws-security-policy/UsernameTokenPolicyHelloService.java[tag=ws-securitypolicy-auth.adoc] +include::example$ws-security-policy/UsernameTokenPolicyHelloService.java[tag=ws-securitypolicy-authentication-authorization.adoc] ... } ---- @@ -63,9 +63,9 @@ When you have the policy in place, configure the credentials on the service endp .application.properties [source,properties] ---- -include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-auth.adoc-service] +include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-authentication-authorization.adoc-service] -include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-auth.adoc-client] +include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-authentication-authorization.adoc-client] ---- In the above listing, `usernameTokenPasswordCallback` is a name of a `@jakarta.inject.Named` bean implementing `javax.security.auth.callback.CallbackHandler`. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc index 9ee7aa75a..5674f625f 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc @@ -1,3 +1,4 @@ +[[cdi-scope-of-cxfclient]] = CDI scope of clients injected via `@CXFClient` {quarkus-cxf-project-name} produces all clients injected via `@io.quarkiverse.cxf.annotation.CXFClient` in the default `@Dependent` scope. @@ -8,4 +9,4 @@ If the client is injected into an `@RequestScoped` bean, then the the client ins This behavior comes in handy if you need to xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[configure clients dynamically] -after the application was started. \ No newline at end of file +after the application was started. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc index b5ab42ccd..ec53219d6 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc @@ -1,3 +1,4 @@ +[[client-endpoint-url-defaults]] = `client-endpoint-url` defaults If you omit the `client-endpoint-url` property in `application.properties`, diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/configure-multiple-clients.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/configure-multiple-clients.adoc index 93fd92201..72716ef6c 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/configure-multiple-clients.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/configure-multiple-clients.adoc @@ -1,3 +1,4 @@ +[[configure-multiple-clients]] = Configure multiple clients In the example above, we configured just a single client called `myCalculator`. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc index d00e5d167..70f2ac74e 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc @@ -1,3 +1,4 @@ +[[dynamic-client-configuration]] = Dynamic client configuration Sometimes you need to reconfigure the client after the application has diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/prevent-resource-leaks.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/prevent-resource-leaks.adoc index 016d3947f..7a8e7219d 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/prevent-resource-leaks.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/prevent-resource-leaks.adoc @@ -1,4 +1,4 @@ -[[resource-leaks]] +[[prevent-resource-leaks]] = Prevent resource leaks CXF client proxies implement `java.io.Closeable`. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc index fc9e64f77..e57b09fb6 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc @@ -1,3 +1,4 @@ +[[programmatic-client-configuration-at-startup]] = Programmatic client configuration at startup To configure all clients at application startup, you can implement an `HTTPConduitConfigurer` diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/pure-client-applications.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/pure-client-applications.adoc index 1063622a9..e350739f8 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/pure-client-applications.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/pure-client-applications.adoc @@ -1,4 +1,4 @@ -[[pure-client]] +[[pure-client-applications]] = Pure client applications Quarkus batch (e.g. periodically scheduled), or command line applications, may do without an HTTP server. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc index 964485abe..070252250 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc @@ -1,3 +1,4 @@ +[[advanced-service-topics]] = Advanced service topics Check the following chapters for more details about implementing SOAP service endpoints: diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/jax-ws-providers.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/jax-ws-providers.adoc index 3d76f0cd1..774685078 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/jax-ws-providers.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/jax-ws-providers.adoc @@ -1,4 +1,4 @@ -[[providers]] +[[jax-ws-providers]] = JAX-WS Providers https://cxf.apache.org/docs/provider-services.html[JAX-WS Providers] are fully supported, and can be implemented as shown below. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc index fb2ad7aca..8fbb7b059 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc @@ -1,3 +1,4 @@ +[[running-behind-a-reverse-proxy]] = Running behind a reverse proxy SOAP requests aimed towards services running on Quarkus can be routed through proxies that generate additional headers diff --git a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc index 49b8ca5c7..0133d4a9c 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc @@ -1,3 +1,4 @@ +[[advanced-soap-client-topics]] = Advanced SOAP client topics Check the following chapters for more details about implementing SOAP clients: diff --git a/docs/modules/ROOT/pages/user-guide/auth.adoc b/docs/modules/ROOT/pages/user-guide/auth.adoc deleted file mode 100644 index f23e91dba..000000000 --- a/docs/modules/ROOT/pages/user-guide/auth.adoc +++ /dev/null @@ -1,70 +0,0 @@ -[[authentication-authorization]] -= Authentication and authorization - -[NOTE] -==== -The sample code snippets shown in this section come from the -https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/client-server[Client and server integration test] -in the source tree of {quarkus-cxf-project-name}. You may want to use it as a runnable example. -==== - -== Client HTTP basic authentication - -Use the following client configuration options provided by -`xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]` extension -to pass the username and password for HTTP basic authentication: - -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[quarkus.cxf.client."client-name".username]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[quarkus.cxf.client."client-name".password]` - -Here is an example: - -.application.properties -[source,properties] ----- -include::example$client-server/application.properties[tag=client-basic-auth] ----- - -=== Accessing WSDL protected by basic authentication - -By default, the clients created by {quarkus-cxf-project-name} do not send the `Authorization` header, -unless you set the `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` to `true`: - -.application.properties -[source,properties] ----- -include::example$client-server/application.properties[tag=client-basic-auth-wsdl] ----- - -== Mutual TLS (mTLS) authentication - -See the xref:user-guide/ssl.adoc#mtls[Mutual TLS (mTLS) authentication] section in SSL, TLS and HTTPS guide. - -== Securing service endpoints - -The server-side authentication and authorization is driven by {link-quarkus-docs-base}/security-overview[Quarkus Security], -especially when it comes to - -* {link-quarkus-docs-base}/security-authentication-mechanisms[Authentication mechanisms] -* {link-quarkus-docs-base}/security-identity-providers[Identity providers] -* {link-quarkus-docs-base}/security-authorize-web-endpoints-reference[Role-based access control (RBAC)] - -There is a basic example in our https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/client-server[Client and server integration test]. -Its key parts are: - -* `io.quarkus:quarkus-elytron-security-properties-file` dependency as an Identity provider -* Basic authentication enabled and users with their roles configured in `application.properties`: -+ -.application.properties -[source,properties] ----- -include::example$client-server/application.properties[tag=users-and-roles] ----- -+ -* Role-based access control enfoced via `@RolesAllowed` annotation: - -.BasicAuthHelloServiceImpl.java -[source,properties] ----- -include::example$client-server/BasicAuthHelloServiceImpl.java[] ----- diff --git a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc index 02f31c00b..fc007a9d5 100644 --- a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc +++ b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc @@ -1,3 +1,4 @@ +[[camel-integration]] = Camel Integration {link-camel-quarkus-docs-index}[Camel Quarkus] supports CXF since its version 2.12.0. diff --git a/docs/modules/ROOT/pages/user-guide/configuration.adoc b/docs/modules/ROOT/pages/user-guide/configuration.adoc index ce36079a1..86bb91d0b 100644 --- a/docs/modules/ROOT/pages/user-guide/configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/configuration.adoc @@ -1,3 +1,4 @@ +[[configuration]] = Configuration {quarkus-cxf-project-name} exposes a large number of configuration options. diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc index 424b2121f..1ba4830e8 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc @@ -1,3 +1,4 @@ +[[contract-first-code-first]] = Contract first and code first approaches Both contract first and code first development modes are fully supported by {quarkus-cxf-project-name}. diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc index 9e9286d4e..cf15a1643 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc @@ -1,3 +1,4 @@ +[[generate-java-from-wsdl]] = Generate the Model classes from WSDL `quarkus-cxf` extension supports generating Java classes from WSDL during Quarkus code generation phase. diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc index 6a9ece500..ddad464e7 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc @@ -1,3 +1,4 @@ +[[generate-wsdl-from-java]] = Generate WSDL document from Java If the WSDL served by your service at `+http://your-host/your-service?wsdl+` is not enough diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index 86795e36c..caed377ad 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -1,3 +1,4 @@ +[[create-oroject]] = Create a new project This guide explains how to set up a new project for a Quarkus application hosting a CXF client or server or both. diff --git a/docs/modules/ROOT/pages/user-guide/examples.adoc b/docs/modules/ROOT/pages/user-guide/examples.adoc index 9cd4ab9c9..15711133a 100644 --- a/docs/modules/ROOT/pages/user-guide/examples.adoc +++ b/docs/modules/ROOT/pages/user-guide/examples.adoc @@ -1,3 +1,4 @@ +[[examples]] = Examples The https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests[`integration-tests` folder] of the codebase provides various examples diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc index 57976b661..8aa2cc5b5 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc @@ -1,3 +1,4 @@ +[[first-soap-client]] = Your first SOAP Client on Quarkus In this guide we explain how to create a simple Quarkus application acting as a client of a remote Web service. diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc index 2388883f2..59b095250 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc @@ -1,4 +1,4 @@ -[[first-steps]] +[[first-soap-web-service]] = Your first SOAP Web service on Quarkus In this guide we explain how to create a Quarkus application exposing a simple SOAP Web service. diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc index 57c317b6e..82daf4cf5 100644 --- a/docs/modules/ROOT/pages/user-guide/index.adoc +++ b/docs/modules/ROOT/pages/user-guide/index.adoc @@ -1,4 +1,4 @@ -[[user-guide]] +[[user-guide-index]] = User guide This User guide explains typical use cases of {quarkus-cxf-project-name}. diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc index e0473b951..4254ec7b0 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc @@ -1,3 +1,4 @@ +[[interceptors-features-handlers]] = CXF Interceptors and Features, JAX-WS Handlers Check the following chapters to learn a bout various ways to customize the processing of SOAP requests and responses: diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc index b35b5a88c..16d3e3a66 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc @@ -1,4 +1,4 @@ -[[interceptors-and-features]] +[[cxf-interceptors-and-features]] = CXF Interceptors and Features https://cxf.apache.org/docs/interceptors.html[CXF interceptors] and https://cxf.apache.org/docs/featureslist.html[CXF features] can be added to both your client or server using either annotations or `application.properties` configurations. diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/jax-ws-handlers.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/jax-ws-handlers.adoc index 0c3eb4e9d..5dcb57438 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/jax-ws-handlers.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/jax-ws-handlers.adoc @@ -1,4 +1,4 @@ -[[handlers]] +[[jax-ws-handlers]] = JAX-WS Handlers As an alternative to the `@HandlerChain` annotation, @@ -38,4 +38,4 @@ public class MySOAPHandler implements SOAPHandler { The `SOAPHandler` classes are loaded via CDI first.. If no CDI beans are available, the constructor without parameters will be invoked to instantiate each class. -==== \ No newline at end of file +==== diff --git a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc index 1d4220c31..5c6777874 100644 --- a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc +++ b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc @@ -1,3 +1,4 @@ +[[package-for-jvm-and-native]] = Package for running on a JVM or natively In this chapter, we explain how to package a Quarkus CXF application for running on a JVM or for running it natively. diff --git a/docs/modules/ROOT/pages/user-guide/payload-logging.adoc b/docs/modules/ROOT/pages/user-guide/payload-logging.adoc index 004ec6c15..6e1307216 100644 --- a/docs/modules/ROOT/pages/user-guide/payload-logging.adoc +++ b/docs/modules/ROOT/pages/user-guide/payload-logging.adoc @@ -1,3 +1,4 @@ +[[payload-logging]] = Logging Refer to Quarkus {link-quarkus-docs-base}/logging[Logging guide] for basic information about logging on Quarkus, such as diff --git a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc index af3cc9478..00aa761c5 100644 --- a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc +++ b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc @@ -1,3 +1,4 @@ +[[soap-payloads-with-jaxb]] = Complex SOAP payloads with JAXB Our introductory guides for Quarkus xref:user-guide/first-soap-client.adoc[SOAP client] diff --git a/docs/modules/ROOT/pages/user-guide/ssl.adoc b/docs/modules/ROOT/pages/user-guide/ssl.adoc deleted file mode 100644 index e8a75aee7..000000000 --- a/docs/modules/ROOT/pages/user-guide/ssl.adoc +++ /dev/null @@ -1,126 +0,0 @@ -[[ssl-tls-https]] -= SSL, TLS and HTTPS - -This section documents various use cases related to SSL, TLS and HTTPS. - -[NOTE] -==== -The sample code snippets used in this section come from the - {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy[WS-SecurityPolicy integration test] - in the source tree of {quarkus-cxf-project-name} -==== - - -== Client SSL configuration - -If your client is going to communicate with a server whose SSL certificate is not trusted by the client's operating system, -then you need to set up a custom trust store for your client. - -Tools like `openssl` or Java `keytool` are commonly used for creating and maintaining truststores. - -We have examples for both tools in the {quarkus-cxf-project-name} source tree: - -* {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy/pom.xml#L185-L520[Create truststore with Java 'keytool' (wrapped by a Maven plugin)] -* {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy/generate-certs.sh[Create truststore with `openssl`] - -Once you have prepared the trust store, you need to configure your client to use it. - -=== Set the client trust store in `application.properties` - -This is the easiest way to set the client trust store. -The key role is played by the following properties: - -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password]` - -Here is an example: - -.application.properties -[source,properties] ----- -include::example$ws-security-policy/application.properties[tag=client-trust-store] ----- - -<1> `pkcs12` and `jks` are two commonly used keystore formats. - PKCS12 is the https://openjdk.org/jeps/229[default Java keystore format] since Java 9. - We recommend using PKCS12 rather than JKS, because it offers stronger cryptographic algorithms, - it is extensible, standardized, language-neutral and widely supported. -<2> The referenced `client-truststore.pkcs12` file has to be available either in the classpath - or in the file system. - -== Server SSL configuration - -To make your services available over the HTTPS protocol, you need to set up server keystore in the first place. -The server SSL configuration is driven by Vert.x, the HTTP layer of Quarkus. -{link-quarkus-docs-base}/http-reference#ssl[Quarkus HTTP guide] provides the information about the configuration options. - -Here is a basic example: - -.application.properties -[source,properties] ----- -include::example$ws-security-policy/application.properties[tag=server-key-store] ----- - -[[mtls]] -== Mutual TLS (mTLS) authentication - -So far, we have explained the simple or single-sided case -where only the server proves its identity through an SSL certificate -and the client has to be set up to trust that certificate. -Mutual TLS authentication goes by letting also the client prove its identity -using the same means of public key cryptography. - -Hence, for the Mutual TLS (mTLS) authentication, -in addition to setting up the server keystore and client truststore as described above, -you need to setup the keystore on the client side and the truststore on the server side. - -The tools for creating and maintaining the stores are the same -and the configuration properties to use are pretty much analogous to the ones used in the Simple TLS case. - -The {link-quarkus-cxf-source-tree-base}/integration-tests/mtls[mTLS integration test] -in the {quarkus-cxf-project-name} source tree can serve as a good starting point. - -The keystores and truststores are created with -`{link-quarkus-cxf-source-tree-base}/integration-tests/mtls/generate-certs.sh[openssl]` -(or alternatively with Java {link-quarkus-cxf-source-tree-base}/integration-tests/mtls/pom.xml#L140-L408[Java `keytool`]) - -Here is the `application.properties` file: - -.application.properties -[source,properties] ----- -include::example$mtls/application.properties[tag=mtls] ----- - -== Enforce SSL through WS-SecurityPolicy - -The requirement for the clients to connect through HTTPS can be defined in a policy. - -The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[quarkus-cxf-rt-ws-security]` extension. - -Here is an example of a policy file: - -.https-policy.xml -[source,properties] ----- -include::example$ws-security-policy/https-policy.xml[] ----- - -The policy has to be referenced from a service endpoint interface (SEI): - -.HttpsPolicyHelloService.java -[source,java] ----- -include::example$ws-security-policy/HttpsPolicyHelloService.java[] ----- - -With this setup in place, any request delivered over HTTP will be rejected by the `PolicyVerificationInInterceptor`: - -[source,shell] ----- -ERROR [org.apa.cxf.ws.pol.PolicyVerificationInInterceptor] Inbound policy verification failed: These policy alternatives can not be satisfied: - {http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702}TransportBinding: TLS is not enabled - ... ----- diff --git a/update-upstream.py b/update-upstream.py new file mode 100644 index 000000000..d177d71ad --- /dev/null +++ b/update-upstream.py @@ -0,0 +1,75 @@ +#!/usr/bin/env python3 +from pathlib import Path +import re + +from conda_build.utils import copy_into + +version = "3.15.2" +directory = Path(__file__).parent / f"docs/modules/ROOT/pages" + +nav = directory.parent / "nav.adoc" +# print(nav.read_text(encoding="utf-8")) + +output = Path(f"cxf-converted-{version}") + +replacements = {'xref:':'xref:'} + +nav_match_lvl1 = re.compile( r'^[*]+ xref:(.*?)\/(.*?)\.adoc\[(.*?)\]') +nav_match_lvl2 = re.compile( r'^[*]+ xref:(.*?)\/(.*?)\/(.*?)\.adoc\[(.*?)\]') + +def copy_dirs(): + dirs = [[len(d.parents) - len(directory.parents), d] for d in directory.rglob('*') if d.is_dir()] + # print(dirs) + for item in dirs: + item[1].copy_into(output, dirs_exist_ok=True, preserve_metadata=False) + return dirs + +def create_include_files(navfile): + with open(navfile) as f: + for line in f: + print(line) + if f"xref:" in line: + m1=nav_match_lvl1.match(line) + m2=nav_match_lvl2.match(line) + if m1: + print(">", m1.groups()) + elif m2: + print(">", m2.groups()) + else: + pass + else: + pass + +def replace_in_line(inline): + for src, target in replacements.items(): + outline = inline.replace(src, target) + return outline + +def replace_in_file(inpath): + outpath = output / inpath.name + with open(inpath, 'r') as infile, open(outpath, 'w') as outfile: + for line in infile: + replace_in_line(line) + outfile.write(line) + +def copy_examples(): + for dir in [d for d in directory.rglob('*') if d.is_dir()]: + for fpath in dir.glob("*.adoc"): + rel = (len(dir.parents) - len(directory.parents)) * "../" + # print(Path(rel).joinpath(dir.parent).name) + + +def copy_examples(): + for f in [d for d in (directory.parent / "examples").glob('*') if d.is_file()]: + print(f.name, "!") + +def copy_images(): + for f in [d for d in (directory.parent / "images").glob('*') if d.is_file()]: + print(f.name, "!") + + + +if __name__ == "__main__": + #copy_dirs() + print("main") + create_include_files(nav) \ No newline at end of file From d9fcea184860c62651aa03a399b335099e4fec4a Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 11:37:43 +0100 Subject: [PATCH 02/31] Make filename and asciidoc identifers consistent Comments in nav --- .../ROOT/pages/release-notes/rn-2-2-0.adoc | 32 +++++ .../ROOT/pages/release-notes/rn-2-2-1.adoc | 16 +++ .../ROOT/pages/release-notes/rn-2-2-2.adoc | 10 ++ .../ROOT/pages/release-notes/rn-2-3-0.adoc | 10 ++ .../ROOT/pages/release-notes/rn-2-3-1.adoc | 52 ++++++++ .../ROOT/pages/release-notes/rn-2-4-0.adoc | 20 +++ .../ROOT/pages/release-notes/rn-2-5-0.adoc | 40 ++++++ .../ROOT/pages/release-notes/rn-2-6-0.adoc | 69 ++++++++++ .../ROOT/pages/release-notes/rn-2-6-1.adoc | 9 ++ .../ROOT/pages/release-notes/rn-2-7-0.adoc | 72 ++++++++++ .../ROOT/pages/release-notes/rn-2-7-1.adoc | 9 ++ .../ROOT/pages/release-notes/rn-3-10-0.adoc | 47 +++++++ .../ROOT/pages/release-notes/rn-3-11-0.adoc | 54 ++++++++ .../ROOT/pages/release-notes/rn-3-11-1.adoc | 15 +++ .../ROOT/pages/release-notes/rn-3-12-0.adoc | 14 ++ .../ROOT/pages/release-notes/rn-3-13-0.adoc | 103 ++++++++++++++ .../ROOT/pages/release-notes/rn-3-13-1.adoc | 26 ++++ .../ROOT/pages/release-notes/rn-3-14-0.adoc | 42 ++++++ .../ROOT/pages/release-notes/rn-3-15-0.adoc | 63 +++++++++ .../ROOT/pages/release-notes/rn-3-8-0.adoc | 46 +++++++ .../ROOT/pages/release-notes/rn-3-8-1.adoc | 93 +++++++++++++ .../ROOT/pages/release-notes/rn-3-8-2.adoc | 30 +++++ .../ROOT/pages/release-notes/rn-3-8-3.adoc | 10 ++ .../ROOT/pages/release-notes/rn-3-8-4.adoc | 51 +++++++ .../ROOT/pages/release-notes/rn-3-8-5.adoc | 17 +++ .../ROOT/pages/release-notes/rn-3-8-6.adoc | 41 ++++++ .../ROOT/pages/release-notes/rn-3-9-0.adoc | 29 ++++ .../authentication-authorization.adoc | 70 ++++++++++ .../ROOT/pages/user-guide/ssl-tls-https.adoc | 126 ++++++++++++++++++ 29 files changed, 1216 insertions(+) create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-2-2.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-3-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-6-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-2-7-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-11-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-12-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc create mode 100644 docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc create mode 100644 docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc create mode 100644 docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc new file mode 100644 index 000000000..f87c9c466 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc @@ -0,0 +1,32 @@ +[[rn-2-2-0]] += {quarkus-cxf-project-name} 2.2.0 LTS release notes + +== Important dependency upgrades: + +* Quarkus 3.1.0.Final -> 3.2.0.Final - https://quarkus.io/blog/quarkus-3-2-0-final-released/[Quarkus 3.2.0.Final release notes] +* CXF 4.0.1 -> 4.0.2 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.1+++...+++cxf-4.0.2[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== XJC plugin options are now tested and documented + +See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC plugins] reference page. + +=== Metrics Feature tested and documented + +The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] extension has got +a proper https://github.com/quarkiverse/quarkus-cxf/tree/2.7.0/integration-tests/metrics[test] +and a basic xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide]. + +[NOTE] +==== +This extension is still considered experimental. +==== + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/907[`wsdl2java` does not work when the module is built from another directory using `mvn -f "module/pom.xml"`] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.1.0+++...+++2.2.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc new file mode 100644 index 000000000..ae70ebbf5 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc @@ -0,0 +1,16 @@ +[[rn-2-2-1]] += {quarkus-cxf-project-name} 2.2.1 LTS release notes + +== New and noteworthy in {quarkus-cxf-project-name} + +=== HTTP Async Transport extension stable + +The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/939[`org.apache.wss4j.dom.transform.STRTransform` broken in WSS4j 3.0.0] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.2.0+++...+++2.2.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-2.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-2.adoc new file mode 100644 index 000000000..b0b77d561 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-2.adoc @@ -0,0 +1,10 @@ +[[rn-2-2-2]] += {quarkus-cxf-project-name} 2.2.2 LTS release notes + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/860[io.quarkus.builder.ChainBuildException: Cycle detected] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.2.1+++...+++2.2.2 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-3-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-3-0.adoc new file mode 100644 index 000000000..b083f4019 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-3-0.adoc @@ -0,0 +1,10 @@ +[[rn-2-3-0]] += {quarkus-cxf-project-name} 2.3.0 release notes + +== Important dependency upgrades: + +* Quarkus 3.2.0 -> 3.3.0 - https://quarkus.io/blog/quarkus-3-3-0-released/[Quarkus 3.3.0 release notes] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.2.2+++...+++2.3.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc new file mode 100644 index 000000000..4864473d8 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc @@ -0,0 +1,52 @@ +[[rn-2-3-1]] += {quarkus-cxf-project-name} 2.3.1 release notes + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Client timeouts, proxy settings, etc. configurable through `application.properties` + +In plain CXF, these are set via `HTTPClientPolicy`. +{quarkus-cxf-project-name} now offers configuration options to set them: + +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-timeout[quarkus.cxf.client."client-name".connection-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-receive-timeout[quarkus.cxf.client."client-name".receive-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-request-timeout[quarkus.cxf.client."client-name".connection-request-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-max-retransmits[quarkus.cxf.client."client-name".max-retransmits]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-allow-chunking[quarkus.cxf.client."client-name".allow-chunking]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunking-threshold[quarkus.cxf.client."client-name".chunking-threshold]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunk-length[quarkus.cxf.client."client-name".chunk-length]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept[quarkus.cxf.client."client-name".accept]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-language[quarkus.cxf.client."client-name".accept-language]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-encoding[quarkus.cxf.client."client-name".accept-encoding]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-content-type[quarkus.cxf.client."client-name".content-type]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-host[quarkus.cxf.client."client-name".host]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection[quarkus.cxf.client."client-name".connection]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-cache-control[quarkus.cxf.client."client-name".cache-control]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-decoupled-endpoint[quarkus.cxf.client."client-name".decoupled-endpoint]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server[quarkus.cxf.client."client-name".proxy-server]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-port[quarkus.cxf.client."client-name".proxy-server-port]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-non-proxy-hosts[quarkus.cxf.client."client-name".non-proxy-hosts]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-type[quarkus.cxf.client."client-name".proxy-server-type]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-username[quarkus.cxf.client."client-name".proxy-username]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-password[quarkus.cxf.client."client-name".proxy-password]` + +=== `HTTPConduitFactory` configurable through `application.properties` + +There is a new option +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[quarkus.cxf.client."client-name".http-conduit-factory]` +intended primarily as a workaround for https://issues.apache.org/jira/browse/CXF-8885[CXF-8885] +and https://github.com/quarkiverse/quarkus-cxf/issues/992[#992]. +Those are about `java.net.http.HttpClient`-based CXF clients leaking threads. +The default value `QuarkusCXFDefault` prevents this issue +while the option still allows using `java.net.http.HttpClient`-based clients by using the `HttpClientHTTPConduitFactory` value. + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/953[QuarkusCxfProcessor is too noisy: "Generated class ..."] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.3.0+++...+++2.3.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc new file mode 100644 index 000000000..6a38e64eb --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc @@ -0,0 +1,20 @@ +[[rn-2-4-0]] += {quarkus-cxf-project-name} 2.4.0 release notes + +== Important dependency upgrades: + +* Quarkus 3.3.0 -> 3.4.1 - https://quarkus.io/blog/quarkus-3-4-1-released/[Quarkus 3.4.1 release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== More `wsdl2java` options configurable through `application.properties` + +See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] page. + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/491[Injected CXFClientInfo does not reflect the wsdl and client-endpoint-url set in application.properties] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.3.1+++...+++2.4.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc new file mode 100644 index 000000000..8c79096e2 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc @@ -0,0 +1,40 @@ +[[rn-2-5-0]] += {quarkus-cxf-project-name} 2.5.0 release notes + +== Important dependency upgrades: + +* CXF 4.0.2 -> 4.0.3 - https://cxf.apache.org/download.html[release notes], https://github.com/apache/cxf/compare/cxf-4.0.2+++...+++cxf-4.0.3[changelog] +* Quarkus 3.4.0 -> 3.5.0 - https://quarkus.io/blog/quarkus-3-5-0-released/[Quarkus 3.5.0 release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== `TLSClientParameters` configurable through `application.properties` + +The trust store and host name verifier of a client are now configurable through some new configuration properties: + +* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store] +* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password] +* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type] +* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-hostname-verifier[quarkus.cxf.client."client-name".hostname-verifier] + +=== `LoggingFeature` configurable through `application.properties` + +See the xref:user-guide/payload-logging.adoc[Logging] page. + +=== WS-Security configurable through `application.properties` + +See the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[Configuration] section of the WS-Security reference page. + +[NOTE] +==== +Many of the new options are exprimental because they are https://github.com/quarkiverse/quarkus-cxf/issues/1052[not yet covered by tests]. +==== + +== Fixed bugs + +* https://github.com/quarkiverse/quarkus-cxf/issues/1031[soap-binding property ignored in version 2.4.0] +* https://github.com/quarkiverse/quarkus-cxf/issues/628[HTTPS enforced via HttpsToken WS-SecurityPolicy does not work] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.4.0+++...+++2.5.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc new file mode 100644 index 000000000..06dea4da0 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc @@ -0,0 +1,69 @@ +[[rn-2-6-0]] += {quarkus-cxf-project-name} 2.6.0 release notes + +== Important dependency upgrades: + +* Santuario XML Security 3.0.2 -> 3.0.3 - https://github.com/apache/santuario-xml-security-java/compare/xmlsec-3.0.2+++...+++xmlsec-3.0.3[changelog] +* WSS4J 3.0.1 -> 3.0.2 - link:https://github.com/apache/ws-wss4j/compare/wss4j-3.0.1+++...+++wss4j-3.0.2[changelog] +* Quarkus 3.5.0 -> 3.6.0 - https://quarkus.io/blog/quarkus-3-6-0-released/[Quarkus 3.6.0 release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Logging extension is deprecated + +The Logging functionality and all associated +xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-logging-enabled-for[configuration options] were moved to `io.quarkiverse.cxf:quarkus-cxf` extension. +The `io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` extension is now deprecated and you can remove it from your projects. +It will be removed altogether in the future. + +=== `quarkus.cxf.http-conduit-factory` fixed + +See https://github.com/quarkiverse/quarkus-cxf/issues/1047[#1047] + +=== Configurable destination folder of `wsdl2java` + +The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable +via the `xref:reference/extensions/quarkus-cxf#quarkus-cxf_quarkus.cxf.codegen.wsdl2java.output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property. + +=== Possible thread leaks with CXF clients using `java.net.http.HttpClient` + +[NOTE] +==== +This issue was originally reported as https://issues.apache.org/jira/browse/CXF-8885[CXF-8885]. +==== + +CXF client proxies implement `java.io.Closeable`. +Therefore, it is important to call `((Closeable) proxy).close()` once the client is not needed anymore +to free all associated system resources, such as threads. + +{quarkus-cxf-project-name} now takes care for closing the clients injected via `@io.quarkiverse.cxf.annotation.CXFClient` automatically +as soon as they are disposed by the CDI container. + +For client proxies created manually, it is up to you to call `((Closeable) proxy).close()`. + +For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] section of the user guide. + +=== Large responses not written slowly anymore + +Before {quarkus-cxf-project-name} 2.6.0, large responses were written slowly due to allocating too small buffers. +This https://github.com/quarkiverse/quarkus-cxf/issues/1066[issue] is now fixed. + + +=== More WS-Security configuration options covered by tests + +We are continually improving the test coverage of the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[WS-Security configuration options]. +There is now less options marked with the warning + +[quote] +____ +This option is experimental, because it is not covered by tests yet. +____ + +=== Documentation improvements + +* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[X-Forwarded support] page + + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.5.0+++...+++2.6.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-6-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-6-1.adoc new file mode 100644 index 000000000..4756a9d47 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-6-1.adoc @@ -0,0 +1,9 @@ +[[rn-2-6-1]] += {quarkus-cxf-project-name} 2.6.1 release notes + +This maintenance release brings no fixes visible in end user applications. +It is rather fixing some project internal build and testing issues. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.6.0+++...+++2.6.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc new file mode 100644 index 000000000..f64e9f52e --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc @@ -0,0 +1,72 @@ +[[rn-2-7-0]] += {quarkus-cxf-project-name} 2.7.0 release notes + +== Important dependency upgrades: + +* Quarkus 3.6.0 -> 3.7.0 - https://quarkus.io/blog/quarkus-3-7-released/[Quarkus 3.7 release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Java 17 required + +Following the Java baseline https://github.com/quarkusio/quarkus/pull/37335[upgrade in Quarkus], {quarkus-cxf-project-name} now also requires Java 17 or newer to build +and run your applications. + +=== WS-ReliableMessaging (WS-RM) supported + +The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. +Both was added in this release and thus the extension status could be promoted from `experimental` to `stable`. + +Check the following resources: + +* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-usage[Usage] section of the reference page +* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-configuration[Configuration options]. + +=== Metrics Feature supported + +Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature]'s support status is now `stable`, +after we have improved +the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide] +and added some xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-configuration[Configuration options]. + +=== New OpenTelemetry tracing extension + +There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] extension. +It currently supports only tracing. +OpenTelemetry Metrics and Logging and not implemented yet. + +=== DevUI + +When you start Quarkus in dev mode using `mvn quarkus:dev` then you can find the DevUI at http://localhost:8080/q/dev-ui[http://localhost:8080/q/dev-ui]. +There are now separate cards listing CXF http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/clients[clients] and http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/service-endpoints[services]. + +Here is a screenshot of the http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/service-endpoints[Service endpoints] card: + +image::release-notes-2.7.0-devui-services.png[DevUI] + + +=== Schema validation configurable via `application.properties` + +See `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-schema-validation-enabled-for[quarkus.cxf.client."client-name".schema-validation.enabled-for]` + +=== Basic authentication for the WSDL + +{quarkus-cxf-project-name} now sends the +xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[username] +and xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[password] +when getting the WSDL document, +as long as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` is `true`. + + + +=== Documentation improvements + +* New `xref:user-guide/ssl-tls-https.adoc[SSL guide]` +* New `xref:user-guide/authentication-authorization.adoc[Authentication and authorization guide]` +* Improved the xref:user-guide/payload-logging.adoc[Logging guide] +* Improved the documentation of `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` + and `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.6.1+++...+++2.7.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-7-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-7-1.adoc new file mode 100644 index 000000000..a6e24758f --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-2-7-1.adoc @@ -0,0 +1,9 @@ +[[rn-2-7-1]] += {quarkus-cxf-project-name} 2.7.1 release notes + +This maintenance release brings no fixes visible in end user applications. +It is rather fixing some project internal build and testing issues. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.7.0+++...+++2.7.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc new file mode 100644 index 000000000..10a825645 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc @@ -0,0 +1,47 @@ +[[rn-3-10-0]] += {quarkus-cxf-project-name} 3.10.0 release notes + +== Important dependency upgrades + +* Quarkus 3.9.x -> 3.10.0 - https://quarkus.io/blog/quarkus-3-10-0-released/[3.10 release notes] +* Woodstox 6.6.1 -> 6.6.2 link:https://github.com/FasterXML/woodstox/compare/woodstox-core-6.6.1+++...+++woodstox-core-6.6.2[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Windows CI + +We started testing every pull request on Windows. +Unfortunately, we have to skip all integration tests that require a container, +because GitHub Actions Windows workers do not allow running Linux containers yet. + +=== In-App SmallRye Config SPI implementations work again + +The bug https://github.com/quarkiverse/quarkus-cxf/issues/1332[#1332] alias https://github.com/quarkusio/quarkus/issues/[quarkus#39689] +got fixed in {quarkus-cxf-project-name} 3.10.0. + +=== Sevice methods with the same name in the same Java package + +If there are two SEIs in one Java package, both having a `@WebMethod` with the same name but different signature, +then the default name for the ASM-generated request, response and possibly other classes is the same for both methods of both classes. + +Before {quarkus-cxf-project-name} 3.10.0 and 3.8.4, no exception was thrown when this happened during the class generation. +At runtime, only one set of those classes was present and calls to one of the clients failed inevitably. + +Since {quarkus-cxf-project-name} 3.10.0 and 3.8.4, the problem is detected at build time and the build fails. + +This was reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/1326[#1326]. +We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether a proper solution is possible in CXF. + +=== Documentation Improvements + +* All configuration properties are now tagged with the version of {quarkus-cxf-project-name} since which they exist. ++ +image::release-notes-2.10.0-since.png[The new since tag] ++ +* We added the xref:release-notes/index.adoc[Version table] to the Release notes page showing which version of + {quarkus-cxf-project-name} uses which CXF version and which Quarkus Platform `.` you should use + to get the given {quarkus-cxf-project-name} version. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.9.0+++...+++3.10.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc new file mode 100644 index 000000000..098589c98 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc @@ -0,0 +1,54 @@ +[[rn-3-11-0]] += {quarkus-cxf-project-name} 3.11.0 release notes + +== Important dependency upgrades + +* Quarkus 3.10.x -> 3.11.0 - https://quarkus.io/blog/quarkus-3-11-0-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== `@CXFEndpoint("/my-service")` - a new annotation for specifying the service endpoint path + +Since this {quarkus-cxf-project-name} 3.11.0, there is a new way to expose an endpoint under a specific path: +the `@io.quarkiverse.cxf.annotation.CXFEndpoint` annotation. +The path is set through its non-optional attribute `value` and it is relative to `quarkus.cxf.path` much like when this is done via `application.properties`. + +Here is basic example: + +[source,java] +---- +@CXFEndpoint("/path-annotation") +@WebService(serviceName = "HelloService", targetNamespace = "https://acme.org/my-service") +public class HelloServiceImpl implements HelloService { + @Override + public String hello(String person) { + ... + } +} +---- + +You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths]. + +=== Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container + +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +were only instantiated using reflection. +Due to this, injecting beans and configuration values into them did not work. + +Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, those interceptors are looked up in the CDI container first +and reflexive instantiation is used only as a fallback. +Injecting other beans and configuration values into interceptor beans created by the CDI container will work flawlessly. + +=== `@WebService(wsdlLocation="my-service.wsdl")` now honored + +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, when a web service implementation had an annotation like `@WebService(wsdlLocation="my-service.wsdl")`, +then only an auto-generated WSDL without policies and other important parts was served on `http://localhost:8080/services/foo?wsdl` +instead the local WSDL file. + +Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, the `wsdlLocation` attribute of the `@WebService` annotation is honored properly. + +This was originally reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/557[#557]. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.10.0+++...+++3.11.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-11-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-11-1.adoc new file mode 100644 index 000000000..93d5b397c --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-11-1.adoc @@ -0,0 +1,15 @@ +[[rn-3-11-1]] += {quarkus-cxf-project-name} 3.11.1 release notes + +== New and noteworthy in {quarkus-cxf-project-name} + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1399[#1399] Beans not injected into a service impl with `@CXFEndpoint("/my-path")` + +In {quarkus-cxf-project-name} 3.11.0, we added a new feature allowing to specify service endpoint paths through a new annotation `@CXFEndpoint("/myPath")`. +The new code did not work well for service implementation classes having both `@WebService` and `@CXFEndpoint` annotations. +In those cases, if the service had some `@Inject` fields, those fields were left blank and the service call has thrown a `NullPointerException`. +This issue was fixed in In {quarkus-cxf-project-name} 3.11.1. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.11.0+++...+++3.11.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-12-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-12-0.adoc new file mode 100644 index 000000000..76c9cb713 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-12-0.adoc @@ -0,0 +1,14 @@ +[[rn-3-12-0]] += {quarkus-cxf-project-name} 3.12.0 release notes + +== Important dependency upgrades + +* Quarkus 3.11.x -> 3.12.0 - https://quarkus.io/blog/quarkus-3-12-0-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +There are no changes with a direct user impact in this release. We just did some housekeeping. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.11.1+++...+++3.12.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc new file mode 100644 index 000000000..e99846e86 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc @@ -0,0 +1,103 @@ +[[rn-3-13-0]] += {quarkus-cxf-project-name} 3.13.0 release notes + +== Important dependency upgrades + +* Quarkus 3.12.x -> 3.13.0 - https://quarkus.io/blog/quarkus-3-13-0-released/[release notes] +* Woodstox 6.6.2 -> 7.0.0 - link:https://github.com/FasterXML/woodstox/blob/master/release-notes/VERSION[release notes], link:https://github.com/FasterXML/woodstox/compare/woodstox-core-6.6.2+++...+++woodstox-core-7.0.0[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Vert.x HttpClient based HTTP Conduit + +As Vert.x is the preferred HTTP stack on Quarkus, we decided to implement a new HTTP Conduit based on Vert.x +https://vertx.io/docs/apidocs/io/vertx/core/http/HttpClient.html[HttpClient]. +Although the client per se is non-blocking and asynchronous, our new `VertxHttpClientHTTPConduit` +currently supports only the synchronous usage. +We plan to add the https://github.com/quarkiverse/quarkus-cxf/issues/1447[support for asynchronous mode] in near future. + +To give it a try, set the `http-conduit-factory` configuration option +xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[globally] +or +xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[per client]: + +.application.properties +[source,properties] +---- +# Set the conduit factory for all clients +quarkus.cxf.http-conduit-factory = VertxHttpClientHTTPConduitFactory + +# Set the conduit factory only for the hello client +quarkus.cxf.client.hello.http-conduit-factory = VertxHttpClientHTTPConduitFactory +---- + +You are welcome to try it and give feedback either on https://github.com/quarkiverse/quarkus-cxf/issues[GitHub Issues] +or https://github.com/quarkiverse/quarkus-cxf/discussions[Discussions]. + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1425[#1425] Injection of `WebServiceContext` into service implementations with `@CXFEndpoint("/my-path")` + +The issue https://github.com/quarkiverse/quarkus-cxf/issues/1425[#1425] made us figure out +that we had no tests at all for injecting `jakarta.xml.ws.WebServiceContext` using the `@jakarta.annotation.Resource` and `@jakarta.annotation.Resources` annotations. +We not only added the the tests and fixed the malfunctioning case with `@CXFEndpoint("/my-path")`, +but we also changed how injecting `@Resource WebServiceContext` was implemented. +Instead of relying on the reflective CXF code that was run at application start, +the scanning is now done at build time by Arc, the CDI container of Quarkus. + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` + +Before {quarkus-cxf-project-name} 3.13.0, the values specified in +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` +were wrongly passed as a single comma-separated value of the `-p` option, +leading to `BadUsageException: -p has invalid character!`. + +Since {quarkus-cxf-project-name} 3.13.0, if `quarkus.cxf.codegen.wsdl2java.package-names` specifies multiple mappings, such as + +.application.properties +[source,properties] +---- +quarkus.cxf.codegen.wsdl2java.package-names = + http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add, + http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply +---- + +then they are properly passed to `wsdl2java` as multiple `-p` options: + +.application.properties +[source,console] +---- +wsdl2java \ + -p http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add \ + -p http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply \ + ... +---- + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1427[#1427] Better exception message when a service interface is not available in Jandex + +{quarkus-cxf-project-name} relies heavily on Quarkus class index, a.k.a. https://smallrye.io/blog/jandex-3-0-0/[Jandex], +when inspecting various aspects of the application at build time. + +Before {quarkus-cxf-project-name} 3.13.0, if some important dependency of the application, +for example the one containing the service interfaces, was not indexed, +a `NullPointerException` without any meaningful message was thrown upon looking up a class from that dependency in the index. + +Since {quarkus-cxf-project-name} 3.13.0, the exception became informative, suggesting the user +to add index to the dependency using either `quarkus.index-dependency.*` family of options +or by adding `io.smallrye:jandex-maven-plugin` to the module containing sources of the missing class. +Check {link-quarkus-docs-base}/cdi-reference#how-to-generate-a-jandex-index[How to Generate a Jandex Index] section of +Quarkus Contexts and dependency injection guide for more details. + +=== Documentation improvements + +* https://github.com/quarkiverse/quarkus-cxf/issues/1424[#1424] Replaced references to the non-existent `quarkus.cxf.logging.enabled` option for the correct `quarkus.cxf.logging.enabled-for` option. +* User guide navigation was restructured: some chapters moved under new nodes +** xref:user-guide/contract-first-code-first.adoc[Contract first and code first approaches] +** xref:user-guide/interceptors-features-handlers.adoc[CXF Interceptors and Features, JAX-WS Handlers] +** xref:user-guide/advanced-service-topics.adoc[Advanced service topics] +** xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] +* New chapters: +** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] +** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.12.0+++...+++3.13.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc new file mode 100644 index 000000000..d3c77210f --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc @@ -0,0 +1,26 @@ +[[rn-3-13-1]] += {quarkus-cxf-project-name} 3.13.1 release notes + +== Important dependency upgrades + +* CXF 4.0.4 -> 4.0.5 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.4+++...+++cxf-4.0.5[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1455[#1455] Vert.x HTTP client is incorrectly used as the default + +We introduced xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 +and it was not supposed to replace the original `HttpURLConnection` based default conduit. +However, we screwed the default handling which resulted in using `VertxHttpClientHTTPConduit` as a default in some cases. +This was fixed in {quarkus-cxf-project-name} 3.13.1. +`HttpURLConnection` based conduit is now used as a default in all situations as it was the case before 3.13.0. +We are sorry for the inconvenience. + +=== Documentation improvements + +* We added a paragraph explaining xref:user-guide/create-project.adoc#quarkus-platform[Quarkus Platform] +* We added the xref:release-planning.adoc[Release planning] page explaining how and when we release {quarkus-cxf-project-name} + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.13.0+++...+++3.13.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc new file mode 100644 index 000000000..63762a328 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc @@ -0,0 +1,42 @@ +[[rn-3-14-0]] += {quarkus-cxf-project-name} 3.14.0 release notes + +== Important dependency upgrades + +* Quarkus 3.13.x -> 3.14.0 - https://quarkus.io/blog/quarkus-3-14-1-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1460[#1460] IllegalArgumentException: port p must be in range 0 <= p <= 65535 when using client-endpoint-url without explicit port + +When using the xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], +the handling of default ports for `http` and `https` client endpoint URLs was broken resulting in an `IllegalArgumentException`. +This was fixed in {quarkus-cxf-project-name} 3.14.0. + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1476[#1476] Missing dependency for OpenTelemetryCustomizer when OTEL is globally disabled + +If OpenTelemetry was disabled via `quarkus.otel.enabled = false`, +then any Quarkus CXF application using `quarkus-cxf-integration-tracing-opentelemetry` would fail at application start +throwing an exception like the following: + +---- +Failed to start quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors + [error]: Build step io.quarkus.arc.deployment.ArcProcessor#validate threw an exception: jakarta.enterprise.inject.spi.DeploymentException: jakarta.enterprise.inject.UnsatisfiedResolutionException: Unsatisfied dependency for type io.opentelemetry.api.OpenTelemetry and qualifiers [@Default] + - injection target: io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer#openTelemetry + - declared on CLASS bean [types=[io.quarkiverse.cxf.CxfClientProducer$ClientFactoryCustomizer, io.quarkiverse.cxf.transport.CxfHandler$EndpointFactoryCustomizer, java.lang.Object, io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer], qualifiers=[@Default, @Any], target=io.quarkiverse.cxf.opentelemetry.OpenTelemetryCustomizer] +---- + +Since version 3.14.0, the `quarkus-cxf-integration-tracing-opentelemetry` extension checks the value of `quarkus.otel.enabled` at build time +and if the value is `false`, it disables OpenTelemetry for CXF too. + +=== Documentation improvements + +Some substantial refactoring took place in the way how we generate the documentation for the +xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[configuration] +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[options]. +Although there are not many https://github.com/quarkiverse/quarkus-cxf/commit/b8913f7fcc58ced6cec9b7c1dc505cfcdd9088f4[observable changes], +please do not hesitate to https://github.com/quarkiverse/quarkus-cxf/issues/new[file an issue] if you spot some irregularity. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.13.1+++...+++3.14.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc new file mode 100644 index 000000000..013717325 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc @@ -0,0 +1,63 @@ +[[rn-3-15-0]] += {quarkus-cxf-project-name} 3.15.0 LTS release notes + +This is the first release in the new 3.15 https://quarkus.io/blog/lts-releases/[LTS stream]. +As usual, where we plan to produce patch releases with bug and security fixes for 12 months. + +== Important dependency upgrades + +* Quarkus 3.14.x -> 3.15.0 - https://quarkus.io/blog/quarkus-3-15-1-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1492[#1492] Support using CXF ``TagsCustomizer``s and deprecate dynamic usage of ``MeterFilter``s + +Before {quarkus-cxf-project-name} 3.15.0, it was possible to have a `MeterFilter` adding a `Tag` to a meter +relying on a value retrieved from a `@RequestScoped` bean in the following way: + +[source,java] +---- +import io.micrometer.core.instrument.Meter; +import io.micrometer.core.instrument.Tag; +import io.micrometer.core.instrument.config.MeterFilter; +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +@Singleton +public class DynamicMeterFilter implements MeterFilter { + + /** A @RequestScoped bean holding a value of an HTTP header */ + @Inject + RequestScopedHeader requestScopedHeader; + + @Override + public Meter.Id map(Meter.Id id) { + if (id.getName().startsWith("http.client") || id.getName().startsWith("cxf.client")) { + return id.withTag(Tag.of("my-header", requestScopedHeader.getHeaderValue())); + } else { + return id; + } + } +} +---- + +The `map()` method would be called on every request and thus the set of tags could be different for every service invocation. + +Since {quarkus-cxf-project-name} 3.15.0, this kind of dynamic `MeterFilter` usage is not possible anymore. +It is due to the upgrade to Micrometer 1.13 brought by Quarkus 3.15.0 that caches return values of `MeterFilter` +methods. Those are therefore called only once. + +==== How to add Tags to Meters with {quarkus-cxf-project-name} 3.15.0+ + +If the old way does not work anymore, how can you do the same with {quarkus-cxf-project-name} 3.15.0 or newer? + +The answer consists in providing a bean implementing `org.apache.cxf.metrics.micrometer.provider.TagsCustomizer` +and making CXF aware of it via the new `xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf_quarkus-cxf-metrics-tags-customizers[quarkus.cxf.metrics.tags-customizers]` configuration property. + +There is an example in our https://github.com/quarkiverse/quarkus-cxf/tree/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5[Apache HTTP Client v5 integration test]. +The crucial parts are the https://github.com/quarkiverse/quarkus-cxf/blob/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5/src/main/java/io/quarkiverse/cxf/hc5/it/HeaderToMetricsTagsCustomizer.java[`TagsCustomizer` implementation] +and the `quarkus.cxf.metrics.tags-customizers = #headerToMetricsTagsCustomizer` line in `https://github.com/quarkiverse/quarkus-cxf/blob/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5/src/main/resources/application.properties#L10[application.properties]`. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.14.0+++...+++3.15.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc new file mode 100644 index 000000000..0f89e2442 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc @@ -0,0 +1,46 @@ +[[rn-3-8-0]] += {quarkus-cxf-project-name} 3.8.0 (LTS) release notes + +== Changes in Quarkus + +* See https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.8[Quarkus 3.8 migration guide]. + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Keeping `major.minor` version in sync with Quarkus + +The most significant change in this release is the increment of major version of {quarkus-cxf-project-name} from 2 to 3 +so that our `major.minor` matches the `major.minor` version of Quarkus. + +We did this mostly for practical reasons, so that it is easier for everybody to understand which version of {quarkus-cxf-project-name} +is compatible with which version of Quarkus. + +=== Logging extension removed from the documentation and {link-quarkus-code-generator} + +`io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` is deprecated since {quarkus-cxf-project-name} 2.7.0, +when all its functionality including configuration properties moved to `io.quarkiverse.cxf:quarkus-cxf`. +In 3.8.0, we stopped mentioning it in the documentation and we removed it from {link-quarkus-code-generator}. +To keep backwards compatibility, a dummy `io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` artifact still exists +doing nothing else, but outputting a warning. +You should remove the extension from your projects. + +=== Santuario XMLSec extension moved to {quarkus-cxf-project-name} + +Santuario XMLSec extension was originally hosted under a https://github.com/quarkiverse/quarkus-xmlsec[separate project] +and published as `io.quarkiverse.xmlsec:quarkus-xmlsec`. +As {quarkus-cxf-project-name} is the primary user of it, we decided to move it here to simplify the maintenance. +The new Maven coordinates starting with {quarkus-cxf-project-name} 3.8.0 are `io.quarkiverse.cxf:quarkus-cxf-santuario-xmlsec`. + +=== Improved documentation + +The following parts of the documentation were improved: + +* The Reference page now contains xref:reference/index.adoc#_supported_cxf_annotations[List of supported CXF annotations]. +* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page] +** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy] +** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient] +* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page] with a more detailed example + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/2.7.1+++...+++3.8.0 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc new file mode 100644 index 000000000..7bbaf7f9f --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc @@ -0,0 +1,93 @@ +[[rn-3-8-1]] += {quarkus-cxf-project-name} 3.8.1 (LTS) release notes + +== Important dependency upgrades: + +* Quarkus 3.8.0 -> 3.8.2 - https://quarkus.io/blog/quarkus-3-8-released/[3.8.1 release notes], https://quarkus.io/blog/quarkus-3-8-2-released/[3.8.2 release notes] +* CXF 4.0.3 -> 4.0.4 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.3+++...+++cxf-4.0.4[changelog] +* WSS4J 3.0.2 -> 3.0.3 - link:https://github.com/apache/ws-wss4j/compare/wss4j-3.0.2+++...+++wss4j-3.0.3[changelog] +* Santuario XMLSec 3.0.3 -> 3.0.4 link:https://github.com/apache/santuario-xml-security-java/compare/xmlsec-3.0.3+++...+++xmlsec-3.0.4[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Mutual TLS (mTLS) + +Mutual TLS (mTLS) is now xref:user-guide/ssl-tls-https.adoc#mtls[documented], +https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/mtls[tested] +and and can be configured for clients via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key*]` family of options. + +=== Keystores and truststores now looked up in the file system + +The keystores and truststores are now https://github.com/quarkiverse/quarkus-cxf/issues/1280[really looked up in the file system] +unless they are available in the classpath as documented in +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` +and +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key-store]`. + +=== Running on systems with FIPS assertions enabled + +Changes in CXF 4.0.4 and {quarkus-cxf-project-name} 3.8.1 make it possible to run applications using WS-Security on systems with https://en.wikipedia.org/wiki/FIPS_140[FIPS] assertions enabled. + +Those changes are twofold: + +1. Bouncy Castle security provider is not present in the class path anymore. ++ +If your project depends directly or transitively on `org.bouncycastle:bcprov-jdk18on` and you want to keep using it, +then {quarkus-cxf-project-name} will suggest you at build time to exclude `io.quarkiverse.cxf:quarkus-cxf-bc-stub` from `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security`. +`io.quarkiverse.cxf:quarkus-cxf-bc-stub` contains some empty methods to allow native compilation with GraalVM +when Bouncy Castle is not present in class path. + +2. Before CXF 4.0.4 and {quarkus-cxf-project-name} 3.8.1 there was no way to select encryption algorithms compatible with FIPS. +Now there is a way to do so via security policy and Quarkus configuration. ++ +In the policy file, the `AlgorithmSuite` has to be set to `CustomAlgorithmSuite`: ++ +[[custom-algorithm-suite-example]] +[source,xml] +---- + + + + + + ... + + + + + + ... + + + ... + + + +---- ++ +FIPS complaint xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-custom-digest-algorithm[algorithms] can then be set in `application.properties`. +Here, we list the default values that are FIPS complaint already: ++ +[source,properties] +---- +quarkus.cxf.client."client-name".security.custom.digest.algorithm = http://www.w3.org/2001/04/xmlenc#sha256 +quarkus.cxf.client."client-name".security.custom.encryption.algorithm = http://www.w3.org/2009/xmlenc11#aes256-gcm +quarkus.cxf.client."client-name".security.custom.symmetric.key.encryption.algorithm = http://www.w3.org/2001/04/xmlenc#kw-aes256 +quarkus.cxf.client."client-name".security.custom.asymmetric.key.encryption.algorithm = http://www.w3.org/2001/04/xmlenc#rsa-1_5 +quarkus.cxf.client."client-name".security.custom.encryption.key.derivation = http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1 +quarkus.cxf.client."client-name".security.custom.signature.key.derivation = http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1 +quarkus.cxf.client."client-name".security.custom.encryption.derived.key.length = 256 +quarkus.cxf.client."client-name".security.custom.signature.derived.key.length = 192 +quarkus.cxf.client."client-name".security.custom.minimum.symmetric.key.length = 256 +quarkus.cxf.client."client-name".security.custom.maximum.symmetric.key.length = 256 +quarkus.cxf.client."client-name".security.custom.minimum.asymmetric.key.length = 1024 +quarkus.cxf.client."client-name".security.custom.maximum.asymmetric.key.length = 4096 +---- + + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.0+++...+++3.8.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc new file mode 100644 index 000000000..86e6955ee --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc @@ -0,0 +1,30 @@ +[[rn-3-8-2]] += {quarkus-cxf-project-name} 3.8.2 (LTS) release notes + +== Important dependency upgrades: + +* Quarkus 3.8.2 -> 3.8.3 - https://quarkus.io/blog/quarkus-3-8-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Change in `org.graalvm.sdk:*` dependencies + +{quarkus-cxf-project-name} extensions now depend on `org.graalvm.sdk:nativeimage` instead of `org.graalvm.sdk:graal-sdk`. +Using `org.graalvm.sdk:graal-sdk` was an oversight on our side. +`org.graalvm.sdk:nativeimage` is just enough for implementing the GraalVM substitutions we need. +If you rely on other transitive dependencies of `org.graalvm.sdk:graal-sdk`, such as `org.graalvm.sdk:polyglot` or `org.graalvm.sdk:collections`, +you will have to add them yourself. + +=== `cxf-rt-databinding-aegis` and `cxf-rt-javascript` not required by `quarkus-cxf-deployment` anymore. + +`io.quarkiverse.cxf:quarkus-cxf-deployment` takes care for build time tasks related to `io.quarkiverse.cxf:quarkus-cxf`. +Before this release, it depended transitively on `org.apache.cxf:cxf-rt-databinding-aegis` and `org.apache.cxf:cxf-rt-javascript` via `org.apache.cxf:cxf-tools-java2ws`. +It was an oversight on our side. +We never intended to support using Aegis or Javascript at runtime or build time. +We have made that by listing them under xref:reference/index.adoc#unsupported[Unsupported CXF modules]. +The current change makes it impossible to generate WSDL from Aegis model classes at build time. +The `java2js` functionality was never accessible via `io.quarkiverse.cxf:quarkus-cxf-deployment`. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.1+++...+++3.8.2 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc new file mode 100644 index 000000000..e62bf708e --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc @@ -0,0 +1,10 @@ +[[rn-3-8-3]] += {quarkus-cxf-project-name} 3.8.3 (LTS) release notes + +== New and noteworthy in {quarkus-cxf-project-name} + +This release contains just two bug fixes. Check the changelog below for details. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.2+++...+++3.8.3 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc new file mode 100644 index 000000000..082782aa4 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc @@ -0,0 +1,51 @@ +[[rn-3-8-4]] += {quarkus-cxf-project-name} 3.8.4 (LTS) release notes + +== Important dependency upgrades: + +* Quarkus 3.8.3 -> 3.8.4 - https://quarkus.io/blog/quarkus-3-8-4-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Sevice methods with the same name in the same Java package + +If there are two SEIs in one Java package, both having a `@WebMethod` with the same name but different signature, +then the default name for the ASM-generated request, response and possibly other classes is the same for both methods of both classes. + +Before {quarkus-cxf-project-name} 3.10.0 and 3.8.4, no exception was thrown when this happened during the class generation. +At runtime, only one set of those classes was present and calls to one of the clients failed inevitably. + +Since {quarkus-cxf-project-name} 3.10.0 and 3.8.4, the problem is detected at build time and the build fails. + +This was reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/1326[#1326]. +We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether a proper solution is possible in CXF. + +=== Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container + +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +were only instantiated using reflection. +Due to this, injecting beans and configuration values into them did not work. + +Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, those interceptors are looked up in the CDI container first +and reflexive instantiation is used only as a fallback. +Injecting other beans and configuration values into interceptor beans created by the CDI container will work flawlessly. + +=== `@WebService(wsdlLocation="my-service.wsdl")` now honored + +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, when a web service implementation had an annotation like `@WebService(wsdlLocation="my-service.wsdl")`, +then only an auto-generated WSDL without policies and other important parts was served on `http://localhost:8080/services/foo?wsdl` +instead the local WSDL file. + +Since {quarkus-cxf-project-name} 3.11.0 and 3.8.4, the `wsdlLocation` attribute of the `@WebService` annotation is honored properly. + +This was originally reported as issue https://github.com/quarkiverse/quarkus-cxf/issues/557[#557]. + +=== Other minor changes + +* Improved FIPS and OpenTelemetry related test coverage +* Typos and minor rewordings in the documentation +* Dependency management improvements + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.3+++...+++3.8.4 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc new file mode 100644 index 000000000..b2d2214ca --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc @@ -0,0 +1,17 @@ +[[rn-3-8-5]] += {quarkus-cxf-project-name} 3.8.5 (LTS) release notes + +== Important dependency upgrades: + +* Quarkus 3.8.4 -> 3.8.5 - https://quarkus.io/blog/quarkus-3-8-5-released/[release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Support for `@CXFEndpoint("/myPath")` reverted + +In {quarkus-cxf-project-name} 3.8.4 we mistakenly backported a new feature to the 3.8 maintenance branch. +This change was reverted in 3.8.5. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.4+++...+++3.8.5 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc new file mode 100644 index 000000000..1f928dec6 --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc @@ -0,0 +1,41 @@ +[[rn-3-8-6]] += {quarkus-cxf-project-name} 3.8.6 (LTS) release notes + +== Important dependency upgrades: + +* Quarkus 3.8.5 -> 3.8.6 - https://quarkus.io/blog/quarkus-3-8-6-released/[release notes] +* CXF 4.0.4 -> 4.0.5 - https://cxf.apache.org/download.html[release notes], link:https://github.com/apache/cxf/compare/cxf-4.0.4+++...+++cxf-4.0.5[changelog] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` + +Before {quarkus-cxf-project-name} 3.13.0 and 3.8.6, the values specified in +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` +were wrongly passed as a single comma-separated value of the `-p` option, +leading to `BadUsageException: -p has invalid character!`. + +Since {quarkus-cxf-project-name} 3.13.0 and 3.8.6, if `quarkus.cxf.codegen.wsdl2java.package-names` specifies multiple mappings, such as + +.application.properties +[source,properties] +---- +quarkus.cxf.codegen.wsdl2java.package-names = + http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add, + http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply +---- + +then they are properly passed to `wsdl2java` as multiple `-p` options: + +.application.properties +[source,console] +---- +wsdl2java \ + -p http://www.example.org/add=io.quarkiverse.cxf.wsdl2java.it.add \ + -p http://www.example.org/multiply=io.quarkiverse.cxf.wsdl2java.it.multiply \ + ... +---- + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.5+++...+++3.8.6 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc new file mode 100644 index 000000000..20eafea5d --- /dev/null +++ b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc @@ -0,0 +1,29 @@ +[[rn-3-9-0]] += {quarkus-cxf-project-name} 3.9.0 release notes + +== Important dependency upgrades + +* Quarkus 3.8.2 -> 3.9.0 - https://quarkus.io/blog/quarkus-3-9-1-released/[3.9 release notes] + +== New and noteworthy in {quarkus-cxf-project-name} + +=== Change in `org.graalvm.sdk:*` dependencies + +{quarkus-cxf-project-name} extensions now depend on `org.graalvm.sdk:nativeimage` instead of `org.graalvm.sdk:graal-sdk`. +Using `org.graalvm.sdk:graal-sdk` was an oversight on our side. +`org.graalvm.sdk:nativeimage` is just enough for implementing the GraalVM substitutions we need. +If you rely on other transitive dependencies of `org.graalvm.sdk:graal-sdk`, such as `org.graalvm.sdk:polyglot` or `org.graalvm.sdk:collections`, +you will have to add them yourself. + +=== Improved documentation + +The following parts of the documentation were improved: + +* We published a bunch of xref:release-notes/index.adoc[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. +* Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling. +* We added xref:release-notes/index.adoc#version-table[Version table] to the release notes page. + It shows which Quarkus CXF version is available in which Quarkus Platform version and which CXF version it depends on. + +== Full changelog + +https://github.com/quarkiverse/quarkus-cxf/compare/3.8.1+++...+++3.9.0 diff --git a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc new file mode 100644 index 000000000..315d14e61 --- /dev/null +++ b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc @@ -0,0 +1,70 @@ +[[authentication-authorization]] += Authentication and authorization + +[NOTE] +==== +The sample code snippets shown in this section come from the +https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/client-server[Client and server integration test] +in the source tree of {quarkus-cxf-project-name}. You may want to use it as a runnable example. +==== + +== Client HTTP basic authentication + +Use the following client configuration options provided by +`xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]` extension +to pass the username and password for HTTP basic authentication: + +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[quarkus.cxf.client."client-name".username]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[quarkus.cxf.client."client-name".password]` + +Here is an example: + +.application.properties +[source,properties] +---- +include::example$client-server/application.properties[tag=client-basic-auth] +---- + +=== Accessing WSDL protected by basic authentication + +By default, the clients created by {quarkus-cxf-project-name} do not send the `Authorization` header, +unless you set the `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` to `true`: + +.application.properties +[source,properties] +---- +include::example$client-server/application.properties[tag=client-basic-auth-wsdl] +---- + +== Mutual TLS (mTLS) authentication + +See the xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS (mTLS) authentication] section in SSL, TLS and HTTPS guide. + +== Securing service endpoints + +The server-side authentication and authorization is driven by {link-quarkus-docs-base}/security-overview[Quarkus Security], +especially when it comes to + +* {link-quarkus-docs-base}/security-authentication-mechanisms[Authentication mechanisms] +* {link-quarkus-docs-base}/security-identity-providers[Identity providers] +* {link-quarkus-docs-base}/security-authorize-web-endpoints-reference[Role-based access control (RBAC)] + +There is a basic example in our https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/client-server[Client and server integration test]. +Its key parts are: + +* `io.quarkus:quarkus-elytron-security-properties-file` dependency as an Identity provider +* Basic authentication enabled and users with their roles configured in `application.properties`: ++ +.application.properties +[source,properties] +---- +include::example$client-server/application.properties[tag=users-and-roles] +---- ++ +* Role-based access control enfoced via `@RolesAllowed` annotation: + +.BasicAuthHelloServiceImpl.java +[source,properties] +---- +include::example$client-server/BasicAuthHelloServiceImpl.java[] +---- diff --git a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc new file mode 100644 index 000000000..e8a75aee7 --- /dev/null +++ b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc @@ -0,0 +1,126 @@ +[[ssl-tls-https]] += SSL, TLS and HTTPS + +This section documents various use cases related to SSL, TLS and HTTPS. + +[NOTE] +==== +The sample code snippets used in this section come from the + {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy[WS-SecurityPolicy integration test] + in the source tree of {quarkus-cxf-project-name} +==== + + +== Client SSL configuration + +If your client is going to communicate with a server whose SSL certificate is not trusted by the client's operating system, +then you need to set up a custom trust store for your client. + +Tools like `openssl` or Java `keytool` are commonly used for creating and maintaining truststores. + +We have examples for both tools in the {quarkus-cxf-project-name} source tree: + +* {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy/pom.xml#L185-L520[Create truststore with Java 'keytool' (wrapped by a Maven plugin)] +* {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy/generate-certs.sh[Create truststore with `openssl`] + +Once you have prepared the trust store, you need to configure your client to use it. + +=== Set the client trust store in `application.properties` + +This is the easiest way to set the client trust store. +The key role is played by the following properties: + +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type]` +* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password]` + +Here is an example: + +.application.properties +[source,properties] +---- +include::example$ws-security-policy/application.properties[tag=client-trust-store] +---- + +<1> `pkcs12` and `jks` are two commonly used keystore formats. + PKCS12 is the https://openjdk.org/jeps/229[default Java keystore format] since Java 9. + We recommend using PKCS12 rather than JKS, because it offers stronger cryptographic algorithms, + it is extensible, standardized, language-neutral and widely supported. +<2> The referenced `client-truststore.pkcs12` file has to be available either in the classpath + or in the file system. + +== Server SSL configuration + +To make your services available over the HTTPS protocol, you need to set up server keystore in the first place. +The server SSL configuration is driven by Vert.x, the HTTP layer of Quarkus. +{link-quarkus-docs-base}/http-reference#ssl[Quarkus HTTP guide] provides the information about the configuration options. + +Here is a basic example: + +.application.properties +[source,properties] +---- +include::example$ws-security-policy/application.properties[tag=server-key-store] +---- + +[[mtls]] +== Mutual TLS (mTLS) authentication + +So far, we have explained the simple or single-sided case +where only the server proves its identity through an SSL certificate +and the client has to be set up to trust that certificate. +Mutual TLS authentication goes by letting also the client prove its identity +using the same means of public key cryptography. + +Hence, for the Mutual TLS (mTLS) authentication, +in addition to setting up the server keystore and client truststore as described above, +you need to setup the keystore on the client side and the truststore on the server side. + +The tools for creating and maintaining the stores are the same +and the configuration properties to use are pretty much analogous to the ones used in the Simple TLS case. + +The {link-quarkus-cxf-source-tree-base}/integration-tests/mtls[mTLS integration test] +in the {quarkus-cxf-project-name} source tree can serve as a good starting point. + +The keystores and truststores are created with +`{link-quarkus-cxf-source-tree-base}/integration-tests/mtls/generate-certs.sh[openssl]` +(or alternatively with Java {link-quarkus-cxf-source-tree-base}/integration-tests/mtls/pom.xml#L140-L408[Java `keytool`]) + +Here is the `application.properties` file: + +.application.properties +[source,properties] +---- +include::example$mtls/application.properties[tag=mtls] +---- + +== Enforce SSL through WS-SecurityPolicy + +The requirement for the clients to connect through HTTPS can be defined in a policy. + +The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[quarkus-cxf-rt-ws-security]` extension. + +Here is an example of a policy file: + +.https-policy.xml +[source,properties] +---- +include::example$ws-security-policy/https-policy.xml[] +---- + +The policy has to be referenced from a service endpoint interface (SEI): + +.HttpsPolicyHelloService.java +[source,java] +---- +include::example$ws-security-policy/HttpsPolicyHelloService.java[] +---- + +With this setup in place, any request delivered over HTTP will be rejected by the `PolicyVerificationInInterceptor`: + +[source,shell] +---- +ERROR [org.apa.cxf.ws.pol.PolicyVerificationInInterceptor] Inbound policy verification failed: These policy alternatives can not be satisfied: + {http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702}TransportBinding: TLS is not enabled + ... +---- From 478a59074569e10ef3f2ee8c08f11080c29a9254 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 11:47:47 +0100 Subject: [PATCH 03/31] Cleanup --- update-upstream.py | 75 ---------------------------------------------- 1 file changed, 75 deletions(-) delete mode 100644 update-upstream.py diff --git a/update-upstream.py b/update-upstream.py deleted file mode 100644 index d177d71ad..000000000 --- a/update-upstream.py +++ /dev/null @@ -1,75 +0,0 @@ -#!/usr/bin/env python3 -from pathlib import Path -import re - -from conda_build.utils import copy_into - -version = "3.15.2" -directory = Path(__file__).parent / f"docs/modules/ROOT/pages" - -nav = directory.parent / "nav.adoc" -# print(nav.read_text(encoding="utf-8")) - -output = Path(f"cxf-converted-{version}") - -replacements = {'xref:':'xref:'} - -nav_match_lvl1 = re.compile( r'^[*]+ xref:(.*?)\/(.*?)\.adoc\[(.*?)\]') -nav_match_lvl2 = re.compile( r'^[*]+ xref:(.*?)\/(.*?)\/(.*?)\.adoc\[(.*?)\]') - -def copy_dirs(): - dirs = [[len(d.parents) - len(directory.parents), d] for d in directory.rglob('*') if d.is_dir()] - # print(dirs) - for item in dirs: - item[1].copy_into(output, dirs_exist_ok=True, preserve_metadata=False) - return dirs - -def create_include_files(navfile): - with open(navfile) as f: - for line in f: - print(line) - if f"xref:" in line: - m1=nav_match_lvl1.match(line) - m2=nav_match_lvl2.match(line) - if m1: - print(">", m1.groups()) - elif m2: - print(">", m2.groups()) - else: - pass - else: - pass - -def replace_in_line(inline): - for src, target in replacements.items(): - outline = inline.replace(src, target) - return outline - -def replace_in_file(inpath): - outpath = output / inpath.name - with open(inpath, 'r') as infile, open(outpath, 'w') as outfile: - for line in infile: - replace_in_line(line) - outfile.write(line) - -def copy_examples(): - for dir in [d for d in directory.rglob('*') if d.is_dir()]: - for fpath in dir.glob("*.adoc"): - rel = (len(dir.parents) - len(directory.parents)) * "../" - # print(Path(rel).joinpath(dir.parent).name) - - -def copy_examples(): - for f in [d for d in (directory.parent / "examples").glob('*') if d.is_file()]: - print(f.name, "!") - -def copy_images(): - for f in [d for d in (directory.parent / "images").glob('*') if d.is_file()]: - print(f.name, "!") - - - -if __name__ == "__main__": - #copy_dirs() - print("main") - create_include_files(nav) \ No newline at end of file From e1ac54ead846fbb2e1acf52fbe530ad5c659aa7f Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 11:58:17 +0100 Subject: [PATCH 04/31] Nav and index changes --- docs/modules/ROOT/nav.adoc | 56 +++++++++---------- .../ROOT/pages/release-notes/index.adoc | 54 +++++++++--------- .../ROOT/pages/release-notes/rn-3-13-1.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-14-0.adoc | 2 +- 4 files changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 0c8c5d36b..8ca5efce1 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -30,40 +30,40 @@ ** xref:user-guide/examples.adoc[Examples] * xref:security-guide/index.adoc[Security guide] ** xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] -** xref:user-guide/auth.adoc[Authentication and authorization] +** xref:user-guide/authentication-authorization.adoc[Authentication and authorization] ** xref:security-guide/ws-securitypolicy-auth.adoc[WS-SecurityPolicy Authentication] // release-notes * xref:release-notes/index.adoc[Release notes] ifeval::[{doc-is-main} == true] -** xref:release-notes/3.15.0.adoc[3.15.0 LTS] -** xref:release-notes/3.14.0.adoc[3.14.0] -** xref:release-notes/3.13.1.adoc[3.13.1] -** xref:release-notes/3.13.0.adoc[3.13.0] -** xref:release-notes/3.12.0.adoc[3.12.0] -** xref:release-notes/3.11.1.adoc[3.11.1] -** xref:release-notes/3.11.0.adoc[3.11.0] -** xref:release-notes/3.10.0.adoc[3.10.0] -** xref:release-notes/3.9.0.adoc[3.9.0] -** xref:release-notes/3.8.6.adoc[3.8.6 LTS] -** xref:release-notes/3.8.5.adoc[3.8.5 LTS] -** xref:release-notes/3.8.4.adoc[3.8.4 LTS] -** xref:release-notes/3.8.3.adoc[3.8.3 LTS] -** xref:release-notes/3.8.2.adoc[3.8.2 LTS] -** xref:release-notes/3.8.1.adoc[3.8.1 LTS] -** xref:release-notes/3.8.0.adoc[3.8.0 LTS] -** xref:release-notes/2.7.1.adoc[2.7.1] -** xref:release-notes/2.7.0.adoc[2.7.0] -** xref:release-notes/2.6.1.adoc[2.6.1] -** xref:release-notes/2.6.0.adoc[2.6.0] -** xref:release-notes/2.5.0.adoc[2.5.0] -** xref:release-notes/2.4.0.adoc[2.4.0] -** xref:release-notes/2.3.1.adoc[2.3.1] -** xref:release-notes/2.3.0.adoc[2.3.0] -** xref:release-notes/2.2.2.adoc[2.2.2 LTS] -** xref:release-notes/2.2.1.adoc[2.2.1 LTS] -** xref:release-notes/2.2.0.adoc[2.2.0 LTS] +** xref:release-notes/rn-3-15-0.adoc[3.15.0 LTS] +** xref:release-notes/rn-3-14-0.adoc[3.14.0] +** xref:release-notes/rn-3-13-1.adoc[3.13.1] +** xref:release-notes/rn-3-13-0.adoc[3.13.0] +** xref:release-notes/rn-3-12-0.adoc[3.12.0] +** xref:release-notes/rn-3-11-1.adoc[3.11.1] +** xref:release-notes/rn-3-11-0.adoc[3.11.0] +** xref:release-notes/rn-3-10-0.adoc[3.10.0] +** xref:release-notes/rn-3-9-0.adoc[3.9.0] +** xref:release-notes/rn-3-8-6.adoc[3.8.6 LTS] +** xref:release-notes/rn-3-8-5.adoc[3.8.5 LTS] +** xref:release-notes/rn-3-8-4.adoc[3.8.4 LTS] +** xref:release-notes/rn-3-8-3.adoc[3.8.3 LTS] +** xref:release-notes/rn-3-8-2.adoc[3.8.2 LTS] +** xref:release-notes/rn-3-8-1.adoc[3.8.1 LTS] +** xref:release-notes/rn-3-8-0.adoc[3.8.0 LTS] +** xref:release-notes/rn-2-7-1.adoc[2.7.1] +** xref:release-notes/rn-2-7-0.adoc[2.7.0] +** xref:release-notes/rn-2-6-1.adoc[2.6.1] +** xref:release-notes/rn-2-6-0.adoc[2.6.0] +** xref:release-notes/rn-2-5-0.adoc[2.5.0] +** xref:release-notes/rn-2-4-0.adoc[2.4.0] +** xref:release-notes/rn-2-3-1.adoc[2.3.1] +** xref:release-notes/rn-2-3-0.adoc[2.3.0] +** xref:release-notes/rn-2-2-2.adoc[2.2.2 LTS] +** xref:release-notes/rn-2-2-1.adoc[2.2.1 LTS] +** xref:release-notes/rn-2-2-0.adoc[2.2.0 LTS] endif::[] // release-planning diff --git a/docs/modules/ROOT/pages/release-notes/index.adoc b/docs/modules/ROOT/pages/release-notes/index.adoc index f5f7a0cab..2d1b45e67 100644 --- a/docs/modules/ROOT/pages/release-notes/index.adoc +++ b/docs/modules/ROOT/pages/release-notes/index.adoc @@ -20,51 +20,51 @@ Those are typically released on Wednesday following the {quarkus-cxf-project-nam |=== | Quarkus CXF | Release date | Quarkus Platform | CXF -| xref:release-notes/3.15.0.adoc[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 +| xref:release-notes/rn-3-15-0.adoc[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 -| xref:release-notes/3.14.0.adoc[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 +| xref:release-notes/rn-3-14-0.adoc[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 -| xref:release-notes/3.13.1.adoc[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 -| xref:release-notes/3.13.0.adoc[3.13.0] | 2024-07-25 | | 4.0.4 +| xref:release-notes/rn-3-13-1.adoc[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 +| xref:release-notes/rn-3-13-0.adoc[3.13.0] | 2024-07-25 | | 4.0.4 -| xref:release-notes/3.12.0.adoc[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 +| xref:release-notes/rn-3-12-0.adoc[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 -| xref:release-notes/3.11.1.adoc[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 -| xref:release-notes/3.11.0.adoc[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 +| xref:release-notes/rn-3-11-1.adoc[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 +| xref:release-notes/rn-3-11-0.adoc[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 -| xref:release-notes/3.10.0.adoc[3.10.0] | | 3.10 | 4.0.4 +| xref:release-notes/rn-3-10-0.adoc[3.10.0] | | 3.10 | 4.0.4 -| xref:release-notes/3.9.0.adoc[3.9.0] | | 3.9 | 4.0.4 +| xref:release-notes/rn-3-9-0.adoc[3.9.0] | | 3.9 | 4.0.4 -| xref:release-notes/3.8.6.adoc[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 -| xref:release-notes/3.8.5.adoc[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 -| xref:release-notes/3.8.4.adoc[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 -| xref:release-notes/3.8.3.adoc[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 -| xref:release-notes/3.8.2.adoc[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 -| xref:release-notes/3.8.1.adoc[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 -| xref:release-notes/3.8.0.adoc[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 +| xref:release-notes/rn-3-8-6.adoc[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 +| xref:release-notes/rn-3-8-5.adoc[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-4.adoc[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-3.adoc[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-2.adoc[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-1.adoc[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-0.adoc[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 -| xref:release-notes/2.7.1.adoc[2.7.1] | | 3.7 | 4.0.3 -| xref:release-notes/2.7.0.adoc[2.7.0] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-1.adoc[2.7.1] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-0.adoc[2.7.0] | | 3.7 | 4.0.3 -| xref:release-notes/2.6.1.adoc[2.6.1] | | 3.6 | 4.0.3 -| xref:release-notes/2.6.0.adoc[2.6.0] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-1.adoc[2.6.1] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-0.adoc[2.6.0] | | 3.6 | 4.0.3 -| xref:release-notes/2.5.0.adoc[2.5.0] | | 3.5 | 4.0.3 +| xref:release-notes/rn-2-5-0.adoc[2.5.0] | | 3.5 | 4.0.3 -| xref:release-notes/2.4.0.adoc[2.4.0] | | 3.4 | 4.0.2 +| xref:release-notes/rn-2-4-0.adoc[2.4.0] | | 3.4 | 4.0.2 -| xref:release-notes/2.3.1.adoc[2.3.1] | | 3.3 | 4.0.2 -| xref:release-notes/2.3.0.adoc[2.3.0] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-1.adoc[2.3.1] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-0.adoc[2.3.0] | | 3.3 | 4.0.2 | 2.2.7 LTS | | 3.2 | 4.0.3 | 2.2.6 LTS | | 3.2 | 4.0.3 | 2.2.5 LTS | | 3.2 | 4.0.3 | 2.2.4 LTS | | 3.2 | 4.0.2 | 2.2.3 LTS | | 3.2 | 4.0.2 -| xref:release-notes/2.2.2.adoc[2.2.2 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/2.2.1.adoc[2.2.1 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/2.2.0.adoc[2.2.0 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-2.adoc[2.2.2 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-1.adoc[2.2.1 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-0.adoc[2.2.0 LTS] | | 3.2 | 4.0.2 | 2.1.0 | | 3.1 | 4.0.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc index d3c77210f..40ffc7a37 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1455[#1455] Vert.x HTTP client is incorrectly used as the default -We introduced xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 +We introduced xref:release-notes/rn-3-13-0.adoc#_vert_x_httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 and it was not supposed to replace the original `HttpURLConnection` based default conduit. However, we screwed the default handling which resulted in using `VertxHttpClientHTTPConduit` as a default in some cases. This was fixed in {quarkus-cxf-project-name} 3.13.1. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc index 63762a328..76be80058 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1460[#1460] IllegalArgumentException: port p must be in range 0 <= p <= 65535 when using client-endpoint-url without explicit port -When using the xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], +When using the xref:release-notes/rn-3-13-0.adoc#_vert_x_httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], the handling of default ports for `http` and `https` client endpoint URLs was broken resulting in an `IllegalArgumentException`. This was fixed in {quarkus-cxf-project-name} 3.14.0. From 72bcb7c0082893dcac2329b42b78b149faa5495b Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 12:00:01 +0100 Subject: [PATCH 05/31] Minor fix --- docs/modules/ROOT/pages/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 7950f1dcb..ca02a5d3b 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,4 +1,4 @@ -[[{quarkus-cxf-project-name}-index]] +[[quarkus-cxf-index]] = {quarkus-cxf-project-name} This project aims at porting http://cxf.apache.org/[Apache CXF] to https://quarkus.io/[Quarkus] runtime From 6ec37ec4fa506a079cba2f353f025c6f97203029 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 12:52:06 +0100 Subject: [PATCH 06/31] Nav fix --- docs/modules/ROOT/nav.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 8ca5efce1..b9db0e916 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -74,7 +74,7 @@ endif::[] // reference * xref:reference/index.adoc[Reference] -// extensions: START +// extensions ** xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF] ** xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] ** xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] @@ -83,4 +83,3 @@ endif::[] ** xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS)] ** xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[HTTP Async Transport] ** xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC Plugins] -// extensions: END From dc9661ca8ebee83a9d1f723933699b7e6fdc1025 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 13:52:46 +0100 Subject: [PATCH 07/31] https:// --- docs/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 9279a1ad9..3bd4cb756 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -22,7 +22,7 @@ asciidoc: # External URLs link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/3.15 - link-quarkus-code-generator: code.quarkus.io + link-quarkus-code-generator: https://code.quarkus.io link-camel-quarkus-docs-index: https://camel.apache.org/camel-quarkus/latest/index.html link-camel-quarkus-docs-cxf-soap: https://camel.apache.org/camel-quarkus/latest/reference/extensions/cxf-soap.html link-quarkus-docs-base: https://quarkus.io/version/3.15/guides From 01153601823ae8fa76dab29e986c2882843b4b55 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 14:50:03 +0100 Subject: [PATCH 08/31] https:// --- docs/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/antora.yml b/docs/antora.yml index 3bd4cb756..9279a1ad9 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -22,7 +22,7 @@ asciidoc: # External URLs link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/3.15 - link-quarkus-code-generator: https://code.quarkus.io + link-quarkus-code-generator: code.quarkus.io link-camel-quarkus-docs-index: https://camel.apache.org/camel-quarkus/latest/index.html link-camel-quarkus-docs-cxf-soap: https://camel.apache.org/camel-quarkus/latest/reference/extensions/cxf-soap.html link-quarkus-docs-base: https://quarkus.io/version/3.15/guides From 54babec139b5a48ed79ced8f1630fc8b8ee4be92 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 14:51:10 +0100 Subject: [PATCH 09/31] {version} --- docs/antora.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/antora.yml b/docs/antora.yml index 9279a1ad9..3a38f90d1 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -21,11 +21,11 @@ asciidoc: quarkus-cxf-project-name: Quarkus CXF # External URLs - link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/3.15 + link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/{version} link-quarkus-code-generator: code.quarkus.io link-camel-quarkus-docs-index: https://camel.apache.org/camel-quarkus/latest/index.html link-camel-quarkus-docs-cxf-soap: https://camel.apache.org/camel-quarkus/latest/reference/extensions/cxf-soap.html - link-quarkus-docs-base: https://quarkus.io/version/3.15/guides + link-quarkus-docs-base: https://quarkus.io/version/{version}/guides # Misc javaxOrJakartaPackagePrefix: jakarta # this can be switched to javax in older branches From a607219544a520c19df980cc756c3f73c0f3c3f8 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 14:51:23 +0100 Subject: [PATCH 10/31] {version} --- docs/antora.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/antora.yml b/docs/antora.yml index 3a38f90d1..9279a1ad9 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -21,11 +21,11 @@ asciidoc: quarkus-cxf-project-name: Quarkus CXF # External URLs - link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/{version} + link-quarkus-cxf-source-tree-base: https://github.com/quarkiverse/quarkus-cxf/blob/3.15 link-quarkus-code-generator: code.quarkus.io link-camel-quarkus-docs-index: https://camel.apache.org/camel-quarkus/latest/index.html link-camel-quarkus-docs-cxf-soap: https://camel.apache.org/camel-quarkus/latest/reference/extensions/cxf-soap.html - link-quarkus-docs-base: https://quarkus.io/version/{version}/guides + link-quarkus-docs-base: https://quarkus.io/version/3.15/guides # Misc javaxOrJakartaPackagePrefix: jakarta # this can be switched to javax in older branches From 55d905c2bee2c85ff14057463dbfb575e8f08777 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 17:13:03 +0100 Subject: [PATCH 11/31] Another ID --- .../ROOT/pages/security-guide/ws-securitypolicy-auth.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc index a145e5d83..8c9a5f82d 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc @@ -1,4 +1,4 @@ -[[ws-securitypolicy-auth]] +[[ws-securitypolicy-authentication-authorization]] = Authentication enforced by WS-SecurityPolicy You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc#_client_http_basic_authentication[clients] From 6ba3f87ebaefbaf7a6aa55f5d15dc38de5a0b183 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 17:14:00 +0100 Subject: [PATCH 12/31] Another ID --- ...h.adoc => ws-securitypolicy-authentication-authorization.adoc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/modules/ROOT/pages/security-guide/{ws-securitypolicy-auth.adoc => ws-securitypolicy-authentication-authorization.adoc} (100%) diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc similarity index 100% rename from docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc rename to docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc From 5d42441027ea294a1540da504a9ca5cdd5848689 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 20:42:55 +0100 Subject: [PATCH 13/31] Implicit ID to explicit --- docs/modules/ROOT/pages/reference/index.adoc | 2 +- .../ws-securitypolicy-authentication-authorization.adoc | 4 ++-- .../ROOT/pages/user-guide/authentication-authorization.adoc | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index 92e9d1fc3..9969a2a5e 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -95,7 +95,7 @@ Out of https://cxf.apache.org/docs/transports.html[CXF Transports] only the foll * `quarkus-cxf` implements its own custom transport based on Quarkus and Vert.x for serving SOAP endpoints * HTTP client via `xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]`, including -** xref:user-guide/authentication-authorization.adoc#_client_http_basic_authentication[Basic Authentication] +** xref:user-guide/authentication-authorization.adoc#client-http-basic-authentication[Basic Authentication] * https://cxf.apache.org/docs/asynchronous-client-http-transport.html[Asynchronous Client HTTP Transport] via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc index 8c9a5f82d..74fe588da 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc @@ -1,8 +1,8 @@ [[ws-securitypolicy-authentication-authorization]] = Authentication enforced by WS-SecurityPolicy -You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc#_client_http_basic_authentication[clients] -and xref:user-guide/authentication-authorization.adoc#_securing_service_endpoints[services]. +You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc#client-http-basic-authentication[clients] +and xref:user-guide/authentication-authorization.adoc#securing-service-endpoints[services]. To enforce authentication through WS-SecurityPolicy, follow these steps: diff --git a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc index 315d14e61..efa383d81 100644 --- a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc @@ -8,6 +8,7 @@ https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/client-se in the source tree of {quarkus-cxf-project-name}. You may want to use it as a runnable example. ==== +[[client-http-basic-authentication]] == Client HTTP basic authentication Use the following client configuration options provided by @@ -40,6 +41,7 @@ include::example$client-server/application.properties[tag=client-basic-auth-wsdl See the xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS (mTLS) authentication] section in SSL, TLS and HTTPS guide. +[[securing-service-endpoints]] == Securing service endpoints The server-side authentication and authorization is driven by {link-quarkus-docs-base}/security-overview[Quarkus Security], From a3aea78c4d0dcc5374373d70efe64adfac8e3bfe Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 20:52:07 +0100 Subject: [PATCH 14/31] Implicit ID to explicit --- docs/modules/ROOT/pages/reference/index.adoc | 1 + docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc | 1 + docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc | 2 +- docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc | 2 +- docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc | 2 +- docs/modules/ROOT/pages/user-guide/create-project.adoc | 2 +- docs/modules/ROOT/pages/user-guide/first-soap-client.adoc | 2 +- .../modules/ROOT/pages/user-guide/first-soap-web-service.adoc | 4 ++-- 8 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index 9969a2a5e..2fb65f3a5 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -201,6 +201,7 @@ Karaf |=== +[[supported-cxf-annotations]] == Supported CXF annotations Here is the status of https://cxf.apache.org/docs/annotations.html[CXF annotations] on Quarkus. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc index e99846e86..0374ce0ec 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc @@ -8,6 +8,7 @@ == New and noteworthy in {quarkus-cxf-project-name} +[[vert-x-httpclient-based-http-conduit]] === Vert.x HttpClient based HTTP Conduit As Vert.x is the preferred HTTP stack on Quarkus, we decided to implement a new HTTP Conduit based on Vert.x diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc index 40ffc7a37..f6ecb8e29 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1455[#1455] Vert.x HTTP client is incorrectly used as the default -We introduced xref:release-notes/rn-3-13-0.adoc#_vert_x_httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 +We introduced xref:release-notes/rn-3-13-0.adoc#vert-x-httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 and it was not supposed to replace the original `HttpURLConnection` based default conduit. However, we screwed the default handling which resulted in using `VertxHttpClientHTTPConduit` as a default in some cases. This was fixed in {quarkus-cxf-project-name} 3.13.1. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc index 76be80058..6a6d8fe14 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1460[#1460] IllegalArgumentException: port p must be in range 0 <= p <= 65535 when using client-endpoint-url without explicit port -When using the xref:release-notes/rn-3-13-0.adoc#_vert_x_httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], +When using the xref:release-notes/rn-3-13-0.adoc#vert-x-httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], the handling of default ports for `http` and `https` client endpoint URLs was broken resulting in an `IllegalArgumentException`. This was fixed in {quarkus-cxf-project-name} 3.14.0. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc index 0f89e2442..042120db5 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc @@ -35,7 +35,7 @@ The new Maven coordinates starting with {quarkus-cxf-project-name} 3.8.0 are `io The following parts of the documentation were improved: -* The Reference page now contains xref:reference/index.adoc#_supported_cxf_annotations[List of supported CXF annotations]. +* The Reference page now contains xref:reference/index.adoc#supported-cxf-annotations[List of supported CXF annotations]. * xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page] ** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy] ** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient] diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index caed377ad..d7a8eaecb 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -1,4 +1,4 @@ -[[create-oroject]] +[[create-project]] = Create a new project This guide explains how to set up a new project for a Quarkus application hosting a CXF client or server or both. diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc index 8aa2cc5b5..d158ff9f6 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc @@ -141,7 +141,7 @@ include::example$calculator-client/application.properties[tag=first-soap-client. [TIP] ==== -All client configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#_configuration[Configuration properties] reference. +All client configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[Configuration properties] reference. ==== With all the above files in place, we should be able to start the application in Quarkus {link-quarkus-docs-base}/maven-tooling#dev-mode[`dev` mode] diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc index 59b095250..15cba4036 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc @@ -6,7 +6,7 @@ In this guide we explain how to create a Quarkus application exposing a simple S [NOTE] .Create project first ==== -Follow the xref:user-guide/create-project.adoc[Project creation] guide before proceeding here. +Follow the xref:user-guide/create-project.adoc#create-project[Project creation] guide before proceeding here. ==== == Hello world! Web service @@ -47,7 +47,7 @@ include::example$soap-service/application.properties[tag=first-web-service.adoc] [TIP] ==== -All configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#_configuration[Configuration properties] reference. +All configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[Configuration properties] reference. ==== [TIP] From b71ecc0deb990504c1db16bdba83f036e121732b Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 21:45:46 +0100 Subject: [PATCH 15/31] Consistent crossreferences --- docs/modules/ROOT/pages/index.adoc | 12 ++--- ...cxf-integration-tracing-opentelemetry.adoc | 2 +- .../quarkus-cxf-rt-features-metrics.adoc | 2 +- .../quarkus-cxf-rt-transports-http-hc5.adoc | 4 +- .../extensions/quarkus-cxf-rt-ws-rm.adoc | 2 +- .../quarkus-cxf-rt-ws-security.adoc | 4 +- .../extensions/quarkus-cxf-services-sts.adoc | 2 +- .../extensions/quarkus-cxf-xjc-plugins.adoc | 6 +-- .../reference/extensions/quarkus-cxf.adoc | 38 ++++++------- docs/modules/ROOT/pages/reference/index.adoc | 24 ++++----- .../ROOT/pages/release-notes/index.adoc | 54 +++++++++---------- .../ROOT/pages/release-notes/rn-2-2-0.adoc | 4 +- .../ROOT/pages/release-notes/rn-2-2-1.adoc | 2 +- .../ROOT/pages/release-notes/rn-2-4-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-2-5-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-2-6-0.adoc | 6 +-- .../ROOT/pages/release-notes/rn-2-7-0.adoc | 12 ++--- .../ROOT/pages/release-notes/rn-3-10-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-11-0.adoc | 4 +- .../ROOT/pages/release-notes/rn-3-13-0.adoc | 12 ++--- .../ROOT/pages/release-notes/rn-3-8-0.adoc | 4 +- .../ROOT/pages/release-notes/rn-3-8-4.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-9-0.adoc | 2 +- docs/modules/ROOT/pages/release-planning.adoc | 2 +- .../ROOT/pages/security-guide/index.adoc | 6 +-- .../cdi-scope-of-cxfclient.adoc | 2 +- .../dynamic-client-configuration.adoc | 4 +- .../user-guide/advanced-service-topics.adoc | 8 +-- .../endpoints-and-paths.adoc | 2 +- .../advanced-soap-client-topics.adoc | 14 ++--- .../authentication-authorization.adoc | 2 +- .../ROOT/pages/user-guide/configuration.adoc | 4 +- .../user-guide/contract-first-code-first.adoc | 6 +-- .../generate-java-from-wsdl.adoc | 2 +- .../ROOT/pages/user-guide/create-project.adoc | 4 +- .../pages/user-guide/first-soap-client.adoc | 8 +-- .../user-guide/first-soap-web-service.adoc | 4 +- docs/modules/ROOT/pages/user-guide/index.adoc | 6 +-- .../interceptors-features-handlers.adoc | 4 +- .../package-for-jvm-and-native.adoc | 2 +- .../user-guide/soap-payloads-with-jaxb.adoc | 6 +-- .../ROOT/pages/user-guide/ssl-tls-https.adoc | 2 +- 42 files changed, 146 insertions(+), 146 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index ca02a5d3b..3b1789c4b 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -9,15 +9,15 @@ While http://cxf.apache.org/[Apache CXF] implements wide range of standards and {quarkus-cxf-project-name} is currently focusing *only* on supporting the ones related to *Simple Object Access Protocol* (https://en.wikipedia.org/wiki/SOAP[SOAP]) and *Java API for XML Web Services* (https://en.wikipedia.org/wiki/JAX-WS[JAX-WS]). -Refer to xref:reference/index.adoc[Reference] to learn which parts of CXF are supported. +Refer to xref:reference/index.adoc#reference-index[Reference] to learn which parts of CXF are supported. The documentation is divided into the following main parts: -* xref:user-guide/index.adoc[User guide] - explains the typical usage of {quarkus-cxf-project-name} -* xref:security-guide/index.adoc[Security guide] - documents various security related aspects of {quarkus-cxf-project-name}, such as SSL/TLS, Authentication and Authorization -* xref:release-notes/index.adoc[Release notes] - Release notes documents for the past releases -* xref:release-planning.adoc[Release planning] - when new releases of {quarkus-cxf-project-name} are to be expected -* xref:reference/index.adoc[Reference] - the full list of supported specifications, use cases and configuration options +* xref:user-guide/index.adoc#user-guide-index[User guide] - explains the typical usage of {quarkus-cxf-project-name} +* xref:security-guide/index.adoc#security-guide-index[Security guide] - documents various security related aspects of {quarkus-cxf-project-name}, such as SSL/TLS, Authentication and Authorization +* xref:release-notes/index.adoc#release-notes-index[Release notes] - Release notes documents for the past releases +* xref:release-planning.adoc#release-planning[Release planning] - when new releases of {quarkus-cxf-project-name} are to be expected +* xref:reference/index.adoc#reference-index[Reference] - the full list of supported specifications, use cases and configuration options [[issues-and-support]] == Issues and Support diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc index f941988ae..0c26294c6 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc @@ -36,7 +36,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc index a038a5016..6defc9795 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc @@ -36,7 +36,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc index e1f9c339b..40dd7d053 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc @@ -32,7 +32,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== @@ -67,7 +67,7 @@ in the source tree of {quarkus-cxf-project-name} include::example$hc5/async-binding.xml[] ---- -This file should then be passed to xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] +This file should then be passed to xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] through its xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[additional-params] property: .application.properties diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc index 2f902392d..85df496d5 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc @@ -35,7 +35,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc index 6e460b267..d9ffbe314 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc @@ -37,7 +37,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== @@ -1292,7 +1292,7 @@ To work around the fact that `org.apache.cxf.ws.security.trust.STSClient` does n cannot thus be used as a CDI bean type, you can use the wrapper class `io.quarkiverse.cxf.ws.security.sts.client.STSClientBean` instead. -Tip: Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS)] extension page +Tip: Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS)] extension page for more information about WS-Trust. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_STS_CLIENT+++` + diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc index 895609ebf..5b68494be 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc @@ -32,7 +32,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc index f1d1c10d7..daa2b66cb 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc @@ -13,7 +13,7 @@ ifeval::[{doc-show-badges} == true] Stable • Since 1.5.11 endif::[] -XJC plugins for xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] code generation. +XJC plugins for xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] code generation. You'll need to add this extension if you want to use any of the following in xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[quarkus.cxf.codegen.wsdl2java.additional-params]: @@ -26,7 +26,7 @@ xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2 [TIP] ==== -Check the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] section of User guide for more details about `wsdl2java`. +Check the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] section of User guide for more details about `wsdl2java`. ==== @@ -46,7 +46,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc index 8de0c0c6e..ccae03a6a 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc @@ -31,7 +31,7 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc[User guide] and especially its +Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its xref:user-guide/create-project.adoc#dependency-management[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== @@ -50,24 +50,24 @@ endif::[] [id="quarkus-cxf-usage"] == Usage -There are several chapters in the xref:user-guide/index.adoc[User guide] covering the usage of this extension: - -* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] -* xref:user-guide/configuration.adoc[Configuration] -* xref:user-guide/package-for-jvm-and-native.adoc[Package for JVM and native] -* xref:user-guide/payload-logging.adoc[Logging] -* xref:user-guide/ssl-tls-https.adoc[SSL] -* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] -* xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] -* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[Running behind a reverse proxy] -* xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] -* xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc[Generate WSDL from Java] -* xref:user-guide/contract-first-code-first.adoc[Contract first and code first] -* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[CXF Interceptors and Features] -* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc[JAX-WS Handlers] -* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc[JAX-WS Providers] -* xref:user-guide/examples.adoc[Examples] +There are several chapters in the xref:user-guide/index.adoc#user-guide-index[User guide] covering the usage of this extension: + +* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] +* xref:user-guide/configuration.adoc#configuration[Configuration] +* xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[Package for JVM and native] +* xref:user-guide/payload-logging.adoc#payload-logging[Logging] +* xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL] +* xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization] +* xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced SOAP client topics] +* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[Running behind a reverse proxy] +* xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] +* xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc#generate-wsdl-from-java[Generate WSDL from Java] +* xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Contract first and code first] +* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[CXF Interceptors and Features] +* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc#jax-ws-handlers[JAX-WS Handlers] +* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc#jax-ws-providers[JAX-WS Providers] +* xref:user-guide/examples.adoc#examples[Examples] [id="quarkus-cxf-configuration"] diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index 2fb65f3a5..497a64d75 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -12,49 +12,49 @@ Please follow the links under the extension names to learn about how to use them | Quarkus CXF extension | Support level | Since | Supported standards // standards: START -| xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF] + +| xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[Quarkus CXF] + `quarkus-cxf` |Stable |0.1.0 |https://cxf.apache.org/docs/jax-ws.html[JAX-WS], https://cxf.apache.org/docs/jaxb.html[JAXB], https://cxf.apache.org/docs/ws-addressing.html[WS-Addressing], https://cxf.apache.org/docs/ws-policy.html[WS-Policy], https://cxf.apache.org/docs/mtom.html[MTOM] -| xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Quarkus CXF Metrics Feature] + +| xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Quarkus CXF Metrics Feature] + `quarkus-cxf-rt-features-metrics` |Stable |0.14.0 | -| xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[Quarkus CXF OpenTelemetry] + +| xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc#quarkus-cxf-integration-tracing-opentelemetry[Quarkus CXF OpenTelemetry] + `quarkus-cxf-integration-tracing-opentelemetry` |Stable |2.7.0 | -| xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[Quarkus CXF WS-Security] + +| xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[Quarkus CXF WS-Security] + `quarkus-cxf-rt-ws-security` |Stable |0.14.0 |https://cxf.apache.org/docs/ws-security.html[WS-Security], https://cxf.apache.org/docs/ws-securitypolicy.html[WS-SecurityPolicy] -| xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[Quarkus CXF WS-ReliableMessaging] + +| xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm[Quarkus CXF WS-ReliableMessaging] + `quarkus-cxf-rt-ws-rm` |Stable |1.5.3 |https://cxf.apache.org/docs/ws-reliablemessaging.html[WS-ReliableMessaging] -| xref:reference/extensions/quarkus-cxf-services-sts.adoc[Quarkus CXF Security Token Service (STS)] + +| xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Quarkus CXF Security Token Service (STS)] + `quarkus-cxf-services-sts` |Stable |1.5.3 |https://cxf.apache.org/docs/ws-trust.html[WS-Trust] -| xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[Quarkus CXF HTTP Async Transport] + +| xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[Quarkus CXF HTTP Async Transport] + `quarkus-cxf-rt-transports-http-hc5` |Stable |1.1.0 | -| xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[Quarkus CXF XJC Plugins] + +| xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[Quarkus CXF XJC Plugins] + `quarkus-cxf-xjc-plugins` |Stable |1.5.11 @@ -94,17 +94,17 @@ Out of https://cxf.apache.org/docs/databindings.html[CXF Data Bindings] only the Out of https://cxf.apache.org/docs/transports.html[CXF Transports] only the following ones are supported: * `quarkus-cxf` implements its own custom transport based on Quarkus and Vert.x for serving SOAP endpoints -* HTTP client via `xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]`, including +* HTTP client via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[quarkus-cxf]`, including ** xref:user-guide/authentication-authorization.adoc#client-http-basic-authentication[Basic Authentication] * https://cxf.apache.org/docs/asynchronous-client-http-transport.html[Asynchronous Client HTTP Transport] - via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` + via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[quarkus-cxf-rt-transports-http-hc5]` [[tools]] === Tools -* `wsdl2Java` - see the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate the Model classes from WSDL +* `wsdl2Java` - see the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate the Model classes from WSDL ] section of User guide -* `java2ws` - see the xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc[Generate WSDL from Java] section of User guide +* `java2ws` - see the xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc#generate-wsdl-from-java[Generate WSDL from Java] section of User guide === Supported SOAP Bindings diff --git a/docs/modules/ROOT/pages/release-notes/index.adoc b/docs/modules/ROOT/pages/release-notes/index.adoc index 2d1b45e67..5beca8ea9 100644 --- a/docs/modules/ROOT/pages/release-notes/index.adoc +++ b/docs/modules/ROOT/pages/release-notes/index.adoc @@ -20,51 +20,51 @@ Those are typically released on Wednesday following the {quarkus-cxf-project-nam |=== | Quarkus CXF | Release date | Quarkus Platform | CXF -| xref:release-notes/rn-3-15-0.adoc[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 +| xref:release-notes/rn-3-15-0.adoc#rn-3-15-0[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 -| xref:release-notes/rn-3-14-0.adoc[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 +| xref:release-notes/rn-3-14-0.adoc#rn-3-14-0[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 -| xref:release-notes/rn-3-13-1.adoc[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 -| xref:release-notes/rn-3-13-0.adoc[3.13.0] | 2024-07-25 | | 4.0.4 +| xref:release-notes/rn-3-13-1.adoc#rn-3-13-1[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 +| xref:release-notes/rn-3-13-0.adoc#rn-3-13-0[3.13.0] | 2024-07-25 | | 4.0.4 -| xref:release-notes/rn-3-12-0.adoc[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 +| xref:release-notes/rn-3-12-0.adoc#rn-3-12-0[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 -| xref:release-notes/rn-3-11-1.adoc[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 -| xref:release-notes/rn-3-11-0.adoc[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 +| xref:release-notes/rn-3-11-1.adoc#rn-3-11-1[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 +| xref:release-notes/rn-3-11-0.adoc#rn-3-11-0[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 -| xref:release-notes/rn-3-10-0.adoc[3.10.0] | | 3.10 | 4.0.4 +| xref:release-notes/rn-3-10-0.adoc#rn-3-10-0[3.10.0] | | 3.10 | 4.0.4 -| xref:release-notes/rn-3-9-0.adoc[3.9.0] | | 3.9 | 4.0.4 +| xref:release-notes/rn-3-9-0.adoc#rn-3-9-0[3.9.0] | | 3.9 | 4.0.4 -| xref:release-notes/rn-3-8-6.adoc[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 -| xref:release-notes/rn-3-8-5.adoc[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-4.adoc[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-3.adoc[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-2.adoc[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-1.adoc[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-0.adoc[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 +| xref:release-notes/rn-3-8-6.adoc#rn-3-8-6[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 +| xref:release-notes/rn-3-8-5.adoc#rn-3-8-5[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-4.adoc#rn-3-8-4[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-3.adoc#rn-3-8-3[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-2.adoc#rn-3-8-2[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-1.adoc#rn-3-8-1[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-0.adoc#rn-3-8-0[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 -| xref:release-notes/rn-2-7-1.adoc[2.7.1] | | 3.7 | 4.0.3 -| xref:release-notes/rn-2-7-0.adoc[2.7.0] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-1.adoc#rn-2-7-1[2.7.1] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-0.adoc#rn-2-7-0[2.7.0] | | 3.7 | 4.0.3 -| xref:release-notes/rn-2-6-1.adoc[2.6.1] | | 3.6 | 4.0.3 -| xref:release-notes/rn-2-6-0.adoc[2.6.0] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-1.adoc#rn-2-6-1[2.6.1] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-0.adoc#rn-2-6-0[2.6.0] | | 3.6 | 4.0.3 -| xref:release-notes/rn-2-5-0.adoc[2.5.0] | | 3.5 | 4.0.3 +| xref:release-notes/rn-2-5-0.adoc#rn-2-5-0[2.5.0] | | 3.5 | 4.0.3 -| xref:release-notes/rn-2-4-0.adoc[2.4.0] | | 3.4 | 4.0.2 +| xref:release-notes/rn-2-4-0.adoc#rn-2-4-0[2.4.0] | | 3.4 | 4.0.2 -| xref:release-notes/rn-2-3-1.adoc[2.3.1] | | 3.3 | 4.0.2 -| xref:release-notes/rn-2-3-0.adoc[2.3.0] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-1.adoc#rn-2-3-1[2.3.1] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-0.adoc#rn-2-3-0[2.3.0] | | 3.3 | 4.0.2 | 2.2.7 LTS | | 3.2 | 4.0.3 | 2.2.6 LTS | | 3.2 | 4.0.3 | 2.2.5 LTS | | 3.2 | 4.0.3 | 2.2.4 LTS | | 3.2 | 4.0.2 | 2.2.3 LTS | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-2.adoc[2.2.2 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-1.adoc[2.2.1 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-0.adoc[2.2.0 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-2.adoc#rn-2-2-2[2.2.2 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-1.adoc#rn-2-2-1[2.2.1 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-0.adoc#rn-2-2-0[2.2.0 LTS] | | 3.2 | 4.0.2 | 2.1.0 | | 3.1 | 4.0.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc index f87c9c466..b17f7347d 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc @@ -10,11 +10,11 @@ === XJC plugin options are now tested and documented -See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC plugins] reference page. +See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[XJC plugins] reference page. === Metrics Feature tested and documented -The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] extension has got +The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Metrics Feature] extension has got a proper https://github.com/quarkiverse/quarkus-cxf/tree/2.7.0/integration-tests/metrics[test] and a basic xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide]. diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc index ae70ebbf5..1a7ecd8f5 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc @@ -5,7 +5,7 @@ === HTTP Async Transport extension stable -The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. +The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. == Fixed bugs diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc index 6a38e64eb..1bbaa7692 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc @@ -9,7 +9,7 @@ === More `wsdl2java` options configurable through `application.properties` -See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] page. +See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] page. == Fixed bugs diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc index 8c79096e2..2f86e9075 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc @@ -19,7 +19,7 @@ The trust store and host name verifier of a client are now configurable through === `LoggingFeature` configurable through `application.properties` -See the xref:user-guide/payload-logging.adoc[Logging] page. +See the xref:user-guide/payload-logging.adoc#payload-logging[Logging] page. === WS-Security configurable through `application.properties` diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc index 06dea4da0..d1cf03c4e 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc @@ -22,7 +22,7 @@ See https://github.com/quarkiverse/quarkus-cxf/issues/1047[#1047] === Configurable destination folder of `wsdl2java` -The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable +The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable via the `xref:reference/extensions/quarkus-cxf#quarkus-cxf_quarkus.cxf.codegen.wsdl2java.output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property. === Possible thread leaks with CXF clients using `java.net.http.HttpClient` @@ -41,7 +41,7 @@ as soon as they are disposed by the CDI container. For client proxies created manually, it is up to you to call `((Closeable) proxy).close()`. -For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] section of the user guide. +For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc#prevent-resource-leaks[Prevent resource leaks] section of the user guide. === Large responses not written slowly anymore @@ -61,7 +61,7 @@ ____ === Documentation improvements -* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[X-Forwarded support] page +* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[X-Forwarded support] page == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc index f64e9f52e..3d6a19316 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc @@ -14,7 +14,7 @@ and run your applications. === WS-ReliableMessaging (WS-RM) supported -The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. +The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. Both was added in this release and thus the extension status could be promoted from `experimental` to `stable`. Check the following resources: @@ -24,14 +24,14 @@ Check the following resources: === Metrics Feature supported -Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature]'s support status is now `stable`, +Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Metrics Feature]'s support status is now `stable`, after we have improved the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide] and added some xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-configuration[Configuration options]. === New OpenTelemetry tracing extension -There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] extension. +There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc#quarkus-cxf-integration-tracing-opentelemetry[OpenTelemetry] extension. It currently supports only tracing. OpenTelemetry Metrics and Logging and not implemented yet. @@ -61,9 +61,9 @@ as long as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-c === Documentation improvements -* New `xref:user-guide/ssl-tls-https.adoc[SSL guide]` -* New `xref:user-guide/authentication-authorization.adoc[Authentication and authorization guide]` -* Improved the xref:user-guide/payload-logging.adoc[Logging guide] +* New `xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL guide]` +* New `xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization guide]` +* Improved the xref:user-guide/payload-logging.adoc#payload-logging[Logging guide] * Improved the documentation of `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` and `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc index 10a825645..46d2294e5 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc @@ -38,7 +38,7 @@ We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether + image::release-notes-2.10.0-since.png[The new since tag] + -* We added the xref:release-notes/index.adoc[Version table] to the Release notes page showing which version of +* We added the xref:release-notes/index.adoc#release-notes-index[Version table] to the Release notes page showing which version of {quarkus-cxf-project-name} uses which CXF version and which Quarkus Platform `.` you should use to get the given {quarkus-cxf-project-name} version. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc index 098589c98..b4d4feb41 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc @@ -27,11 +27,11 @@ public class HelloServiceImpl implements HelloService { } ---- -You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths]. +You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Service endpoints and paths]. === Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package were only instantiated using reflection. Due to this, injecting beans and configuration values into them did not work. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc index 0374ce0ec..8da97dd5e 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc @@ -91,13 +91,13 @@ Quarkus Contexts and dependency injection guide for more details. * https://github.com/quarkiverse/quarkus-cxf/issues/1424[#1424] Replaced references to the non-existent `quarkus.cxf.logging.enabled` option for the correct `quarkus.cxf.logging.enabled-for` option. * User guide navigation was restructured: some chapters moved under new nodes -** xref:user-guide/contract-first-code-first.adoc[Contract first and code first approaches] -** xref:user-guide/interceptors-features-handlers.adoc[CXF Interceptors and Features, JAX-WS Handlers] -** xref:user-guide/advanced-service-topics.adoc[Advanced service topics] -** xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] +** xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Contract first and code first approaches] +** xref:user-guide/interceptors-features-handlers.adoc#interceptors-features-handlers[CXF Interceptors and Features, JAX-WS Handlers] +** xref:user-guide/advanced-service-topics.adoc#advanced-service-topics[Advanced service topics] +** xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced SOAP client topics] * New chapters: -** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] -** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] +** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] +** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[Dynamic client configuration] == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc index 042120db5..d4303be5f 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc @@ -36,10 +36,10 @@ The new Maven coordinates starting with {quarkus-cxf-project-name} 3.8.0 are `io The following parts of the documentation were improved: * The Reference page now contains xref:reference/index.adoc#supported-cxf-annotations[List of supported CXF annotations]. -* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page] +* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[WS-Security extension page] ** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy] ** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient] -* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page] with a more detailed example +* xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS) extension page] with a more detailed example == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc index 082782aa4..b02cab8c6 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc @@ -22,7 +22,7 @@ We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether === Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package were only instantiated using reflection. Due to this, injecting beans and configuration values into them did not work. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc index 20eafea5d..f101215f7 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc @@ -19,7 +19,7 @@ you will have to add them yourself. The following parts of the documentation were improved: -* We published a bunch of xref:release-notes/index.adoc[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. +* We published a bunch of xref:release-notes/index.adoc#release-notes-index[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. * Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling. * We added xref:release-notes/index.adoc#version-table[Version table] to the release notes page. It shows which Quarkus CXF version is available in which Quarkus Platform version and which CXF version it depends on. diff --git a/docs/modules/ROOT/pages/release-planning.adoc b/docs/modules/ROOT/pages/release-planning.adoc index 32f162919..409eab3c1 100644 --- a/docs/modules/ROOT/pages/release-planning.adoc +++ b/docs/modules/ROOT/pages/release-planning.adoc @@ -26,4 +26,4 @@ We choose the same `major.minor` for LTS as Quarkus. == See also -* xref:release-notes/index.adoc[Release notes] +* xref:release-notes/index.adoc#release-notes-index[Release notes] diff --git a/docs/modules/ROOT/pages/security-guide/index.adoc b/docs/modules/ROOT/pages/security-guide/index.adoc index 6463adac5..809700216 100644 --- a/docs/modules/ROOT/pages/security-guide/index.adoc +++ b/docs/modules/ROOT/pages/security-guide/index.adoc @@ -3,6 +3,6 @@ The Security guide documents various security related aspects of {quarkus-cxf-project-name}: -* xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] -* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] -* xref:security-guide/ws-securitypolicy-authentication-authorization.adoc[Authentication enforced by WS-SecurityPolicy] +* xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL, TLS and HTTPS] +* xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization] +* xref:security-guide/ws-securitypolicy-authentication-authorization.adoc#ws-securitypolicy-authentication-authorization[Authentication enforced by WS-SecurityPolicy] diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc index 5674f625f..00aa610f1 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc @@ -8,5 +8,5 @@ Therefore, if the client is injected into an `@ApplicationScoped` bean, then the If the client is injected into an `@RequestScoped` bean, then the the client instance also becomes `@RequestScoped`. This behavior comes in handy if you need to -xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[configure clients dynamically] +xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[configure clients dynamically] after the application was started. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc index 70f2ac74e..6c28c5d45 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc @@ -2,7 +2,7 @@ = Dynamic client configuration Sometimes you need to reconfigure the client after the application has -xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc[been started], +xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc#programmatic-client-configuration-at-startup[been started], or even before every request. This might be the case, if, for example, each request needs to be sent to a different remote URL. @@ -12,7 +12,7 @@ However using that API on a client instance that may be accessed from other thre == Preventing concurrent access to a CXF client If your client is used as a part of serving an external request, -you can inject the client into a xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[`@RequestScoped` bean]. +you can inject the client into a xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[`@RequestScoped` bean]. Then every request will be served by a fresh client instance and you can configure it safely. For example, this solution is applicable when your client is called from a REST-handler method (see below) diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc index 070252250..b61ee92bc 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc @@ -3,7 +3,7 @@ Check the following chapters for more details about implementing SOAP service endpoints: -* xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Endpoints and paths] -* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc[JAX-WS Providers] -* xref:user-guide/advanced-service-topics/rest-and-soap-endpoints.adoc[REST and SOAP Endpoints] -* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[Running behind a reverse proxy] +* xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Endpoints and paths] +* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc#jax-ws-providers[JAX-WS Providers] +* xref:user-guide/advanced-service-topics/rest-and-soap-endpoints.adoc#rest-and-soap-endpoints[REST and SOAP Endpoints] +* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[Running behind a reverse proxy] diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc index d1d6c0df6..58fc2a9eb 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc @@ -6,7 +6,7 @@ Let's explain how a service endpoint can be exposed under a certain URL path. [[application-properties]] == Set the endpoint path via `application.properties` -In the xref:user-guide/first-soap-web-service.adoc[First SOAP Web service] chapter, we explained how to expose a service using `application.properties`: +In the xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[First SOAP Web service] chapter, we explained how to expose a service using `application.properties`: .application.properties [source,properties] diff --git a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc index 0133d4a9c..362680bb0 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc @@ -3,10 +3,10 @@ Check the following chapters for more details about implementing SOAP clients: -* xref:user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc[`client-endpoint-url` defaults] -* xref:user-guide/advanced-client-topics/configure-multiple-clients.adoc[Configure multiple clients] -* xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] -* xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc[Configure clients programmatically at application startup] -* xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] -* xref:user-guide/advanced-client-topics/pure-client-applications.adoc[Pure client applications] -* xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] +* xref:user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc#client-endpoint-url-defaults[`client-endpoint-url` defaults] +* xref:user-guide/advanced-client-topics/configure-multiple-clients.adoc#configure-multiple-clients[Configure multiple clients] +* xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[CDI scope of clients injected via `@CXFClient`] +* xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc#programmatic-client-configuration-at-startup[Configure clients programmatically at application startup] +* xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[Dynamic client configuration] +* xref:user-guide/advanced-client-topics/pure-client-applications.adoc#pure-client-applications[Pure client applications] +* xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc#prevent-resource-leaks[Prevent resource leaks] diff --git a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc index efa383d81..05f589b44 100644 --- a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc @@ -12,7 +12,7 @@ in the source tree of {quarkus-cxf-project-name}. You may want to use it as a ru == Client HTTP basic authentication Use the following client configuration options provided by -`xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]` extension +`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[quarkus-cxf]` extension to pass the username and password for HTTP basic authentication: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[quarkus.cxf.client."client-name".username]` diff --git a/docs/modules/ROOT/pages/user-guide/configuration.adoc b/docs/modules/ROOT/pages/user-guide/configuration.adoc index 86bb91d0b..e844b02ae 100644 --- a/docs/modules/ROOT/pages/user-guide/configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/configuration.adoc @@ -2,7 +2,7 @@ = Configuration {quarkus-cxf-project-name} exposes a large number of configuration options. -Each extension documents its options at the bottom of its xref:reference/index.adoc[reference page]. +Each extension documents its options at the bottom of its xref:reference/index.adoc#reference-index[reference page]. The configuration options can be set in `application.properties` file or via environment variables - see {link-quarkus-docs-base}/config-reference[Quarkus configuration reference] for details. @@ -11,7 +11,7 @@ The configuration options can be set in `application.properties` file or via env == Bean references Several configuration options of {quarkus-cxf-project-name} allow referring to beans present in Quarkus CDI container. -xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[Features and interceptors] are typical examples of those. +xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[Features and interceptors] are typical examples of those. There are two ways how to set a bean reference in the configuration: by type or by bean name. diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc index 1ba4830e8..adb7c1acd 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc @@ -12,14 +12,14 @@ CXF provides the `wsdl2java` utility for that. {quarkus-cxf-project-name} wraps `wsdl2java` in the `quarkus-cxf` extension so you do not need to use it directly. -Follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate the Model classes from WSDL] section of the user guide +Follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate the Model classes from WSDL] section of the user guide for more details about how to use it. You may also want to check the CXF https://cxf.apache.org/docs/developing-a-consumer.html[Developing a Consumer] as a general introduction. == Contract first service -When implementing a service the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[generation of Java code from WSDL] +When implementing a service the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[generation of Java code from WSDL] may also come in handy. `wsdl2java` can generate the model classes (with JAXB annotations) and service interfaces (with JAX-WS annotations) for you. @@ -34,7 +34,7 @@ Another valid option at your disposal is to write your service in Java, using JA Then you have two options how to obtain the WSDL contract: 1. Start your service and point your clients at `+http://your-host/your-service?wsdl+` -2. xref:user-guide/contract-first-code-first.adoc[Generate the WSDL document from Java] classes at build time +2. xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Generate the WSDL document from Java] classes at build time [TIP] diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc index cf15a1643..75c72f906 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc @@ -66,7 +66,7 @@ quarkus.cxf.codegen.wsdl2java.bar-params.xjc = ts [TIP] ==== -Add `xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[io.quarkiverse.cxf:quarkus-cxf-xjc-plugins]` dependency to your project to be able to use +Add `xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[io.quarkiverse.cxf:quarkus-cxf-xjc-plugins]` dependency to your project to be able to use `-xjc-Xbg`, `-xjc-Xdv`, `-xjc-Xjavadoc`, `-xjc-Xproperty-listener`, `-xjc-Xts` and `-xjc-Xwsdlextension` wsdl2java parameters. ==== diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index d7a8eaecb..57ebaeb9d 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -87,6 +87,6 @@ That's the most reliable way to get compatible versions of Quarkus, CXF, {quarku We recommend to proceed with any of the following chapters: -* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] +* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc index d158ff9f6..5ee40c42a 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc @@ -6,7 +6,7 @@ In this guide we explain how to create a simple Quarkus application acting as a [NOTE] .Create project first ==== -Follow the xref:user-guide/create-project.adoc[Project creation] guide before proceeding here. +Follow the xref:user-guide/create-project.adoc#create-project[Project creation] guide before proceeding here. ==== == Remote Web service for testing @@ -109,7 +109,7 @@ The last option tends to be the easiest and most flexible for client application [TIP] ==== -If you want to use this approach, first follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] section and then continue with the next steps. +If you want to use this approach, first follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] section and then continue with the next steps. ==== == Using SEI as a client @@ -167,5 +167,5 @@ where `11` is the correct result of adding `5` and `6`. You may want to proceed with -* xref:user-guide/package-for-jvm-and-native.adoc[Package for JVM and native]. -* xref:user-guide/advanced-soap-client-topics.adoc[Advanced client topics] +* xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[Package for JVM and native]. +* xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced client topics] diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc index 15cba4036..172bba6c2 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc @@ -52,7 +52,7 @@ All configuration properties are documented in the xref:reference/extensions/qua [TIP] ==== -Check the xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths] chapter +Check the xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Service endpoints and paths] chapter to learn about alternative ways to expose a service endpoint under a specific path. ==== @@ -209,4 +209,4 @@ After that you can send a new SOAP request and see some SOAP payloads in the app == Further steps -You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc[packaging your application for running on a JVM or natively]. +You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[packaging your application for running on a JVM or natively]. diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc index 82daf4cf5..f5231b7ef 100644 --- a/docs/modules/ROOT/pages/user-guide/index.adoc +++ b/docs/modules/ROOT/pages/user-guide/index.adoc @@ -5,6 +5,6 @@ This User guide explains typical use cases of {quarkus-cxf-project-name}. You may want to start with some of the following topics: -* xref:user-guide/create-project.adoc[Create a new project] -* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] +* xref:user-guide/create-project.adoc#create-project[Create a new project] +* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc index 4254ec7b0..2dc924b05 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc @@ -3,5 +3,5 @@ Check the following chapters to learn a bout various ways to customize the processing of SOAP requests and responses: -* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[CXF Interceptors and Features] -* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc[JAX-WS Handlers] +* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[CXF Interceptors and Features] +* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc#jax-ws-handlers[JAX-WS Handlers] diff --git a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc index 5c6777874..99669f42d 100644 --- a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc +++ b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc @@ -72,7 +72,7 @@ contains the `native` profile needed for building the native image: ---- -Further, as mentioned in the xref:user-guide/create-project.adoc[] section, you need the GraalVM `native-image` tool. +Further, as mentioned in the xref:user-guide/create-project.adoc#create-project[] section, you need the GraalVM `native-image` tool. You should either have it installed locally and have `GRAALVM_HOME` environment variable set properly, diff --git a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc index 00aa761c5..66e2c470d 100644 --- a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc +++ b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc @@ -1,8 +1,8 @@ [[soap-payloads-with-jaxb]] = Complex SOAP payloads with JAXB -Our introductory guides for Quarkus xref:user-guide/first-soap-client.adoc[SOAP client] -and xref:user-guide/first-soap-web-service.adoc[SOAP service] dealt with services +Our introductory guides for Quarkus xref:user-guide/first-soap-client.adoc#first-soap-client[SOAP client] +and xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[SOAP service] dealt with services having only primitive parameters and return values such as integers and strings. Let's have a look at passing and receiving more complex objects. @@ -147,4 +147,4 @@ We can see `Orange` having been added in the returned list as expected. == Further steps -You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc[packaging your application for running on a JVM or natively]. +You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[packaging your application for running on a JVM or natively]. diff --git a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc index e8a75aee7..11fef8c0d 100644 --- a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc +++ b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc @@ -98,7 +98,7 @@ include::example$mtls/application.properties[tag=mtls] The requirement for the clients to connect through HTTPS can be defined in a policy. -The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[quarkus-cxf-rt-ws-security]` extension. +The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[quarkus-cxf-rt-ws-security]` extension. Here is an example of a policy file: From 42fbb923b5006821a064f7e5bb15691616104c87 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 22:16:55 +0100 Subject: [PATCH 16/31] Typos --- docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc | 2 +- .../advanced-client-topics/cdi-scope-of-cxfclient.adoc | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc index 8da97dd5e..d31fcaac5 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc @@ -39,7 +39,7 @@ or https://github.com/quarkiverse/quarkus-cxf/discussions[Discussions]. The issue https://github.com/quarkiverse/quarkus-cxf/issues/1425[#1425] made us figure out that we had no tests at all for injecting `jakarta.xml.ws.WebServiceContext` using the `@jakarta.annotation.Resource` and `@jakarta.annotation.Resources` annotations. -We not only added the the tests and fixed the malfunctioning case with `@CXFEndpoint("/my-path")`, +We not only added the tests and fixed the malfunctioning case with `@CXFEndpoint("/my-path")`, but we also changed how injecting `@Resource WebServiceContext` was implemented. Instead of relying on the reflective CXF code that was run at application start, the scanning is now done at build time by Arc, the CDI container of Quarkus. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc index 00aa610f1..877da994d 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc @@ -4,8 +4,8 @@ {quarkus-cxf-project-name} produces all clients injected via `@io.quarkiverse.cxf.annotation.CXFClient` in the default `@Dependent` scope. Due to that, the real scope of the injected instance depends on the CDI scope of the bean into which the client is injected. -Therefore, if the client is injected into an `@ApplicationScoped` bean, then the the client instance also becomes `@ApplicationScoped`. -If the client is injected into an `@RequestScoped` bean, then the the client instance also becomes `@RequestScoped`. +Therefore, if the client is injected into an `@ApplicationScoped` bean, then the client instance also becomes `@ApplicationScoped`. +If the client is injected into an `@RequestScoped` bean, then the client instance also becomes `@RequestScoped`. This behavior comes in handy if you need to xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[configure clients dynamically] From 491d5a5bf6915c2efd31773148cc777fbde75162 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 23:01:53 +0100 Subject: [PATCH 17/31] NOTE and IMPORTANT admonitions --- docs/modules/ROOT/pages/index.adoc | 2 ++ ...s-cxf-integration-tracing-opentelemetry.adoc | 10 ++++++---- .../quarkus-cxf-rt-features-metrics.adoc | 10 ++++++---- .../extensions/quarkus-cxf-rt-ws-security.adoc | 5 ++++- .../running-behind-a-reverse-proxy.adoc | 6 +++++- .../generate-java-from-wsdl.adoc | 3 +++ .../generate-wsdl-from-java.adoc | 17 ++++++++++------- .../user-guide/soap-payloads-with-jaxb.adoc | 9 ++++++--- 8 files changed, 42 insertions(+), 20 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 3b1789c4b..33feae7f2 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -5,11 +5,13 @@ This project aims at porting http://cxf.apache.org/[Apache CXF] to https://quark including full support for producing https://quarkus.io/container-first/[GraalVM native images]. [IMPORTANT] +==== While http://cxf.apache.org/[Apache CXF] implements wide range of standards and specifications, {quarkus-cxf-project-name} is currently focusing *only* on supporting the ones related to *Simple Object Access Protocol* (https://en.wikipedia.org/wiki/SOAP[SOAP]) and *Java API for XML Web Services* (https://en.wikipedia.org/wiki/JAX-WS[JAX-WS]). Refer to xref:reference/index.adoc#reference-index[Reference] to learn which parts of CXF are supported. +==== The documentation is divided into the following main parts: diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc index 0c26294c6..432cf1f36 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc @@ -15,10 +15,12 @@ endif::[] Generate https://opentelemetry.io/[OpenTelemetry] https://opentelemetry.io/docs/concepts/signals/traces/[traces]. -IMPORTANT: OpenTelemetry Metrics and Logging are not supported yet on neither Quarkus nor CXF side, - hence {quarkus-cxf-project-name} cannot support them either. Tracing is thus - the only OpenTelemetry feature supported by this extension. - +[IMPORTANT] +==== +OpenTelemetry Metrics and Logging are not supported yet on neither Quarkus nor CXF side, +hence {quarkus-cxf-project-name} cannot support them either. Tracing is thus +the only OpenTelemetry feature supported by this extension. +==== [id="quarkus-cxf-integration-tracing-opentelemetry-maven-coordinates"] == Maven coordinates diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc index 6defc9795..ac2e45066 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc @@ -15,10 +15,12 @@ endif::[] Collect metrics using https://micrometer.io/[Micrometer]. -IMPORTANT: Unlike https://cxf.apache.org/docs/metrics.html[CXF Metrics feature], - this {quarkus-cxf-project-name} extension does not support https://cxf.apache.org/docs/dropwizard-metrics.html[Dropwizard Metrics]. - Only Micrometer is supported. - +[IMPORTANT] +==== +Unlike https://cxf.apache.org/docs/metrics.html[CXF Metrics feature], +this {quarkus-cxf-project-name} extension does not support https://cxf.apache.org/docs/dropwizard-metrics.html[Dropwizard Metrics]. +Only Micrometer is supported. +==== [id="quarkus-cxf-rt-features-metrics-maven-coordinates"] == Maven coordinates diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc index d9ffbe314..1a0fa1bb7 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc @@ -1292,8 +1292,11 @@ To work around the fact that `org.apache.cxf.ws.security.trust.STSClient` does n cannot thus be used as a CDI bean type, you can use the wrapper class `io.quarkiverse.cxf.ws.security.sts.client.STSClientBean` instead. -Tip: Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS)] extension page +[TIP] +==== +Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS)] extension page for more information about WS-Trust. +==== *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_STS_CLIENT+++` + *Since Quarkus CXF*: 3.8.0 diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc index 8fbb7b059..20ffd20cc 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc @@ -12,7 +12,11 @@ Refer to {link-quarkus-docs-base}/http-reference#reverse-proxy[Quarkus HTTP refe {quarkus-cxf-project-name} support for various `X-Forwarded` headers works in line with Quarkus configuration. -IMPORTANT: Activating this feature leaves the server exposed to several security issues (i.e. information spoofing). Consider activating it only when running behind a reverse proxy. +[IMPORTANT] +==== +Activating this feature leaves the server exposed to several security issues (i.e. information spoofing). +Consider activating it only when running behind a reverse proxy. +==== These are the relevant Quarkus properties and their effect on {quarkus-cxf-project-name}: diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc index 75c72f906..36d8a29db 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc @@ -42,8 +42,11 @@ This will generate Java classes in `target/generated-sources/wsdl2java` or They will be automatically picked by the compiler plugin there. Hence we are free to refer to them from our application or test code. +[NOTE] +==== Note that `quarkus-cxf` code generation uses the https://cxf.apache.org/docs/wsdl-to-java.html[wsdl2Java] utility from CXF under the hood. `wsdl2Java` is called separately for each WSDL file selected by `includes` and `excludes`. +==== Passing custom parameters to `wsdl2java` is possible through xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[`quarkus.cxf.codegen.wsdl2java.additional-params`] diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc index ddad464e7..66803e94b 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc @@ -29,20 +29,23 @@ include::example$soap-service/application.properties[tag=generate-wsdl-from-java Here we have instructed `java2ws` to generate WSDLs for two service classes, namely `HelloServiceImpl` and `FaultyHelloServiceImpl`. -[NOTE] .Annotations +[NOTE] ==== -Note that the service classes must be annotated with `{javaxOrJakartaPackagePrefix}.xml.ws.WebService` to be selected for `java2ws` processing. +The service classes must be annotated with `{javaxOrJakartaPackagePrefix}.xml.ws.WebService` to be selected for `java2ws` processing. ==== The two generated WSDL documents will be stored as `target/Java2wsTest/FaultyHelloServiceImpl-from-java2ws.wsdl` and `target/Java2wsTest/HelloServiceImpl-from-java2ws.wsdl` respectively. -NOTE: Unlike `wsdl2java` which is executed within Quarkus source generation phase, - `java2ws` is a part Quarkus augmentation that happens after compilation. - The input of `java2ws` are, after all, Java class files. - Hence you do not need to add `generate-code` to `quarkus-maven-plugin` - for `java2ws`. +[NOTE] +==== +Unlike `wsdl2java` which is executed within Quarkus source generation phase, +`java2ws` is a part Quarkus augmentation that happens after compilation. +The input of `java2ws` are, after all, Java class files. +Hence you do not need to add `generate-code` to `quarkus-maven-plugin` +for `java2ws`. +==== == See also diff --git a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc index 66e2c470d..ff5718c32 100644 --- a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc +++ b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc @@ -8,9 +8,12 @@ Let's have a look at passing and receiving more complex objects. As an example, let's create an application for managing fruits. -NOTE: The sample code snippets used in this section come from the - https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/server[server integration test] - in the source tree of {quarkus-cxf-project-name} +[NOTE] +==== +The sample code snippets used in this section come from the +https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/server[server integration test] +in the source tree of {quarkus-cxf-project-name} +==== Because our representation of fruit is supposed to be a complex, let's model it as a Java bean with a couple of attributes: From 6d904444ad63be078a0e001f5ccded90c854f8de Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 23:10:27 +0100 Subject: [PATCH 18/31] Xref fix --- .../pages/reference/extensions/quarkus-cxf-services-sts.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc index 5b68494be..ecee81b90 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc @@ -139,7 +139,7 @@ include::example$ws-trust/application.properties[tag=ws-trust-usage.adoc-client- ==== The properties for configuring the STS client are provided by the `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security` extension and documented on its -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client[reference page]. +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[reference page]. ==== Alternatively, the client can be set as a bean reference: From 1da092c75f4e8bc8f88f231e4e07e2159583abdc Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 23:18:36 +0100 Subject: [PATCH 19/31] Error in tag replacement --- .../ws-securitypolicy-authentication-authorization.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc index 74fe588da..43245f6b0 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc @@ -50,7 +50,7 @@ There are two ways how you can associate this policy file with a service endpoin .UsernameTokenPolicyHelloService.java [source,java] ---- -include::example$ws-security-policy/UsernameTokenPolicyHelloService.java[tag=ws-securitypolicy-authentication-authorization.adoc] +include::example$ws-security-policy/UsernameTokenPolicyHelloService.java[tag=ws-securitypolicy-auth.adoc] ... } ---- @@ -63,9 +63,9 @@ When you have the policy in place, configure the credentials on the service endp .application.properties [source,properties] ---- -include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-authentication-authorization.adoc-service] +include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-auth.adoc-service] -include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-authentication-authorization.adoc-client] +include::example$ws-security-policy/application.properties[tag=ws-securitypolicy-auth.adoc-client] ---- In the above listing, `usernameTokenPasswordCallback` is a name of a `@jakarta.inject.Named` bean implementing `javax.security.auth.callback.CallbackHandler`. From 9d96f2a690b3d1c1fde466acd5ceb1ed88ff469a Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sat, 23 Nov 2024 23:28:59 +0100 Subject: [PATCH 20/31] images --- .../{code.quarkus.io.png => code-quarkus-io.png} | Bin ...0.0-since.png => release-notes-2-10-0-since.png} | Bin ...s.png => release-notes-2-7-0-devui-services.png} | Bin docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc | 2 +- .../ROOT/pages/user-guide/create-project.adoc | 2 +- 5 files changed, 2 insertions(+), 2 deletions(-) rename docs/modules/ROOT/images/{code.quarkus.io.png => code-quarkus-io.png} (100%) rename docs/modules/ROOT/images/{release-notes-2.10.0-since.png => release-notes-2-10-0-since.png} (100%) rename docs/modules/ROOT/images/{release-notes-2.7.0-devui-services.png => release-notes-2-7-0-devui-services.png} (100%) diff --git a/docs/modules/ROOT/images/code.quarkus.io.png b/docs/modules/ROOT/images/code-quarkus-io.png similarity index 100% rename from docs/modules/ROOT/images/code.quarkus.io.png rename to docs/modules/ROOT/images/code-quarkus-io.png diff --git a/docs/modules/ROOT/images/release-notes-2.10.0-since.png b/docs/modules/ROOT/images/release-notes-2-10-0-since.png similarity index 100% rename from docs/modules/ROOT/images/release-notes-2.10.0-since.png rename to docs/modules/ROOT/images/release-notes-2-10-0-since.png diff --git a/docs/modules/ROOT/images/release-notes-2.7.0-devui-services.png b/docs/modules/ROOT/images/release-notes-2-7-0-devui-services.png similarity index 100% rename from docs/modules/ROOT/images/release-notes-2.7.0-devui-services.png rename to docs/modules/ROOT/images/release-notes-2-7-0-devui-services.png diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc index 3d6a19316..46566f7ac 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc @@ -42,7 +42,7 @@ There are now separate cards listing CXF http://localhost:8080/q/dev-ui/io.quark Here is a screenshot of the http://localhost:8080/q/dev-ui/io.quarkiverse.cxf.quarkus-cxf/service-endpoints[Service endpoints] card: -image::release-notes-2.7.0-devui-services.png[DevUI] +image::release-notes-2-7-0-devui-services.png[DevUI] === Schema validation configurable via `application.properties` diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index 57ebaeb9d..a595ff214 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -21,7 +21,7 @@ In addition to that, you may need New project skeletons can be generated using https://{link-quarkus-code-generator}/?e=io.quarkiverse.cxf%3Aquarkus-cxf&extension-search=origin:platform%20quarkus%20cxf[{link-quarkus-code-generator}]. -image::code.quarkus.io.png[https://code.quarkus.io] +image::code-quarkus-io.png[https://code.quarkus.io] * Here you can select the extensions that you want to work with. * For a simple Hello world Web service or client the `quarkus-cxf` extension is enough. From 85dec0e180f9beb61781794804cf17266347a3b6 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sun, 24 Nov 2024 00:00:44 +0100 Subject: [PATCH 21/31] Duplicate examples. --- .../quarkus-cxf-rt-ws-security.adoc | 46 +++++++++---------- .../ROOT/pages/release-notes/rn-3-8-1.adoc | 2 +- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc index 1a0fa1bb7..140165160 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc @@ -993,7 +993,7 @@ tests] yet. This value is only taken into account if the current security policy has set `CustomAlgorithmSuite` as an `AlgorithmSuite`, for instance -[[custom-algorithm-suite-example]] +[[ws-security-custom-algorithm-suite-example]] [source,xml] ---- Date: Sun, 24 Nov 2024 00:14:29 +0100 Subject: [PATCH 22/31] Duplicate id:s, language. --- docs/modules/ROOT/pages/reference/index.adoc | 4 ++-- docs/modules/ROOT/pages/user-guide/camel-integration.adoc | 2 +- docs/modules/ROOT/pages/user-guide/create-project.adoc | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index 497a64d75..f37d51033 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -4,8 +4,8 @@ [[extensions]] == {quarkus-cxf-project-name} -Here is the list of extensions produced by this project. -Please follow the links under the extension names to learn about how to use them, about their configuration and about any known limitations. +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"] |=== diff --git a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc index fc007a9d5..99ea00c93 100644 --- a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc +++ b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc @@ -5,4 +5,4 @@ Under the hood, the implementation is based on {quarkus-cxf-project-name}. Therefore, all functionality available in {quarkus-cxf-project-name} is also available in Camel Quarkus. -Please refer to {link-camel-quarkus-docs-cxf-soap}[Camel Quarkus CXF SOAP] extension documentation for further details. +Refer to {link-camel-quarkus-docs-cxf-soap}[Camel Quarkus CXF SOAP] extension documentation for further details. diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index a595ff214..d64239454 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -16,8 +16,8 @@ In addition to that, you may need * If you are on Linux, a container runtime like `docker` is sufficient for the native mode too. Use `-Pnative -Dquarkus.native.container-build=true` instead of `-Pnative` if you choose this option. -[[create-project]] -== Create project +[[create-a-project]] +== Creating a project New project skeletons can be generated using https://{link-quarkus-code-generator}/?e=io.quarkiverse.cxf%3Aquarkus-cxf&extension-search=origin:platform%20quarkus%20cxf[{link-quarkus-code-generator}]. From e76940b7bb31a7d3d22d29d058e71dfc1d6ec623 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sun, 24 Nov 2024 10:48:58 +0100 Subject: [PATCH 23/31] Nav --- docs/modules/ROOT/nav.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index b9db0e916..fe156b4fe 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -31,7 +31,7 @@ * xref:security-guide/index.adoc[Security guide] ** xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] ** xref:user-guide/authentication-authorization.adoc[Authentication and authorization] -** xref:security-guide/ws-securitypolicy-auth.adoc[WS-SecurityPolicy Authentication] +** xref:security-guide/ws-securitypolicy-authentication-authorization.adoc[WS-SecurityPolicy Authentication] // release-notes * xref:release-notes/index.adoc[Release notes] From 38903f70d8a7be5da3d30887bf7a5a33d4740fb6 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sun, 24 Nov 2024 10:51:32 +0100 Subject: [PATCH 24/31] Nav --- docs/modules/ROOT/nav.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index fe156b4fe..668f8edad 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -28,6 +28,8 @@ *** xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] ** xref:user-guide/camel-integration.adoc[Camel Integration] ** xref:user-guide/examples.adoc[Examples] + +// security-guide * xref:security-guide/index.adoc[Security guide] ** xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] ** xref:user-guide/authentication-authorization.adoc[Authentication and authorization] From 295302551da4b45fa222686cf178db57076e31e2 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sun, 24 Nov 2024 12:42:39 +0100 Subject: [PATCH 25/31] NOTE --- docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc index 11fef8c0d..ae80769f9 100644 --- a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc +++ b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc @@ -6,8 +6,8 @@ This section documents various use cases related to SSL, TLS and HTTPS. [NOTE] ==== The sample code snippets used in this section come from the - {link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy[WS-SecurityPolicy integration test] - in the source tree of {quarkus-cxf-project-name} +{link-quarkus-cxf-source-tree-base}/integration-tests/ws-security-policy[WS-SecurityPolicy integration test] +in the source tree of {quarkus-cxf-project-name} ==== @@ -74,7 +74,7 @@ using the same means of public key cryptography. Hence, for the Mutual TLS (mTLS) authentication, in addition to setting up the server keystore and client truststore as described above, -you need to setup the keystore on the client side and the truststore on the server side. +you need to set up the keystore on the client side and the truststore on the server side. The tools for creating and maintaining the stores are the same and the configuration properties to use are pretty much analogous to the ones used in the Simple TLS case. From 43aa428925bd5735d8cb202fa4f294dabd850356 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Sun, 24 Nov 2024 22:39:51 +0100 Subject: [PATCH 26/31] capitalization --- docs/modules/ROOT/pages/security-guide/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/security-guide/index.adoc b/docs/modules/ROOT/pages/security-guide/index.adoc index 809700216..c4541150a 100644 --- a/docs/modules/ROOT/pages/security-guide/index.adoc +++ b/docs/modules/ROOT/pages/security-guide/index.adoc @@ -1,7 +1,7 @@ [[security-guide-index]] = Security guide -The Security guide documents various security related aspects of {quarkus-cxf-project-name}: +The security guide documents various security related aspects of {quarkus-cxf-project-name}: * xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL, TLS and HTTPS] * xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization] From 80edd6071c5e9da365c23485f02e5a6168348040 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Tue, 3 Dec 2024 19:03:12 +0100 Subject: [PATCH 27/31] Extensions markers in nav --- docs/modules/ROOT/nav.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 668f8edad..f92c2629b 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -76,7 +76,7 @@ endif::[] // reference * xref:reference/index.adoc[Reference] -// extensions +// extensions: START ** xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF] ** xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] ** xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] @@ -85,3 +85,4 @@ endif::[] ** xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS)] ** xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[HTTP Async Transport] ** xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC Plugins] +// extensions: END \ No newline at end of file From 7b84c30508fae6828ff52699a76088aa97f2284c Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Tue, 3 Dec 2024 19:05:00 +0100 Subject: [PATCH 28/31] Removed link #fragments --- docs/modules/ROOT/pages/index.adoc | 12 +- ...cxf-integration-tracing-opentelemetry.adoc | 4 +- .../quarkus-cxf-rt-features-metrics.adoc | 6 +- .../quarkus-cxf-rt-transports-http-hc5.adoc | 8 +- .../extensions/quarkus-cxf-rt-ws-rm.adoc | 12 +- .../quarkus-cxf-rt-ws-security.adoc | 108 +++++++++--------- .../extensions/quarkus-cxf-services-sts.adoc | 6 +- .../extensions/quarkus-cxf-xjc-plugins.adoc | 10 +- .../reference/extensions/quarkus-cxf.adoc | 40 +++---- docs/modules/ROOT/pages/reference/index.adoc | 26 ++--- .../ROOT/pages/release-notes/index.adoc | 56 ++++----- .../ROOT/pages/release-notes/rn-2-2-0.adoc | 6 +- .../ROOT/pages/release-notes/rn-2-2-1.adoc | 2 +- .../ROOT/pages/release-notes/rn-2-3-1.adoc | 50 ++++---- .../ROOT/pages/release-notes/rn-2-4-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-2-5-0.adoc | 12 +- .../ROOT/pages/release-notes/rn-2-6-0.adoc | 10 +- .../ROOT/pages/release-notes/rn-2-7-0.adoc | 32 +++--- .../ROOT/pages/release-notes/rn-3-10-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-11-0.adoc | 4 +- .../ROOT/pages/release-notes/rn-3-13-0.adoc | 18 +-- .../ROOT/pages/release-notes/rn-3-13-1.adoc | 4 +- .../ROOT/pages/release-notes/rn-3-14-0.adoc | 6 +- .../ROOT/pages/release-notes/rn-3-15-0.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-8-0.adoc | 10 +- .../ROOT/pages/release-notes/rn-3-8-1.adoc | 10 +- .../ROOT/pages/release-notes/rn-3-8-2.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-8-4.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-8-6.adoc | 2 +- .../ROOT/pages/release-notes/rn-3-9-0.adoc | 6 +- docs/modules/ROOT/pages/release-planning.adoc | 4 +- .../ROOT/pages/security-guide/index.adoc | 6 +- ...typolicy-authentication-authorization.adoc | 6 +- .../cdi-scope-of-cxfclient.adoc | 2 +- .../dynamic-client-configuration.adoc | 4 +- .../user-guide/advanced-service-topics.adoc | 8 +- .../endpoints-and-paths.adoc | 4 +- .../advanced-soap-client-topics.adoc | 14 +-- .../authentication-authorization.adoc | 10 +- .../ROOT/pages/user-guide/configuration.adoc | 4 +- .../user-guide/contract-first-code-first.adoc | 6 +- .../generate-java-from-wsdl.adoc | 6 +- .../generate-wsdl-from-java.adoc | 2 +- .../ROOT/pages/user-guide/create-project.adoc | 4 +- .../pages/user-guide/first-soap-client.adoc | 10 +- .../user-guide/first-soap-web-service.adoc | 8 +- docs/modules/ROOT/pages/user-guide/index.adoc | 6 +- .../interceptors-features-handlers.adoc | 4 +- .../cxf-interceptors-and-features.adoc | 2 +- .../package-for-jvm-and-native.adoc | 2 +- .../pages/user-guide/payload-logging.adoc | 8 +- .../user-guide/soap-payloads-with-jaxb.adoc | 6 +- .../ROOT/pages/user-guide/ssl-tls-https.adoc | 8 +- 53 files changed, 302 insertions(+), 302 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 33feae7f2..04a08fd27 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -10,16 +10,16 @@ While http://cxf.apache.org/[Apache CXF] implements wide range of standards and {quarkus-cxf-project-name} is currently focusing *only* on supporting the ones related to *Simple Object Access Protocol* (https://en.wikipedia.org/wiki/SOAP[SOAP]) and *Java API for XML Web Services* (https://en.wikipedia.org/wiki/JAX-WS[JAX-WS]). -Refer to xref:reference/index.adoc#reference-index[Reference] to learn which parts of CXF are supported. +Refer to xref:reference/index.adoc[Reference] to learn which parts of CXF are supported. ==== The documentation is divided into the following main parts: -* xref:user-guide/index.adoc#user-guide-index[User guide] - explains the typical usage of {quarkus-cxf-project-name} -* xref:security-guide/index.adoc#security-guide-index[Security guide] - documents various security related aspects of {quarkus-cxf-project-name}, such as SSL/TLS, Authentication and Authorization -* xref:release-notes/index.adoc#release-notes-index[Release notes] - Release notes documents for the past releases -* xref:release-planning.adoc#release-planning[Release planning] - when new releases of {quarkus-cxf-project-name} are to be expected -* xref:reference/index.adoc#reference-index[Reference] - the full list of supported specifications, use cases and configuration options +* xref:user-guide/index.adoc[User guide] - explains the typical usage of {quarkus-cxf-project-name} +* xref:security-guide/index.adoc[Security guide] - documents various security related aspects of {quarkus-cxf-project-name}, such as SSL/TLS, Authentication and Authorization +* xref:release-notes/index.adoc[Release notes] - Release notes documents for the past releases +* xref:release-planning.adoc[Release planning] - when new releases of {quarkus-cxf-project-name} are to be expected +* xref:reference/index.adoc[Reference] - the full list of supported specifications, use cases and configuration options [[issues-and-support]] == Issues and Support diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc index 432cf1f36..11d39cee4 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc @@ -38,8 +38,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc index ac2e45066..49351f72a 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc @@ -38,8 +38,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -151,7 +151,7 @@ be overridden per client or service endpoint using the `quarkus.cxf.client."clie .<| List of ``string`` .<| -3+a|A list of xref:user-guide/configuration.adoc#beanRefs[references] to +3+a|A list of xref:user-guide/configuration.adoc[references] to `org.apache.cxf.metrics.micrometer.provider.TagsCustomizer` beans that will be attached to the global metrics feature. diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc index 40dd7d053..65441c2f5 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc @@ -32,8 +32,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -67,8 +67,8 @@ in the source tree of {quarkus-cxf-project-name} include::example$hc5/async-binding.xml[] ---- -This file should then be passed to xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] -through its xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[additional-params] property: +This file should then be passed to xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] +through its xref:reference/extensions/quarkus-cxf.adoc[additional-params] property: .application.properties [source,properties] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc index 85df496d5..ffc6fffa1 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc @@ -35,8 +35,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -58,8 +58,8 @@ Enabling WS-RM for a client or service endpoints means that https://cxf.apache.o In addition to that you may want to set some of the options documented xref:#quarkus-cxf-rt-ws-rm-configuration[below] and/or the following WS-Addressing options: -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-decoupled-endpoint[quarkus.cxf.client."client-name".decoupled-endpoint]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-decoupled-endpoint-base[quarkus.cxf.decoupled-endpoint-base]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".decoupled-endpoint]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.decoupled-endpoint-base]` [id="extensions-quarkus-cxf-rt-ws-rm-usage-runnable-example"] === Runnable example @@ -169,7 +169,7 @@ destination. If not specified, the acknowledgements will be sent immediately. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.rm.persistence.RMStore` bean used to +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.rm.persistence.RMStore` bean used to store source and destination sequences and message references. *Environment variable*: `+++QUARKUS_CXF_RM_STORE+++` + @@ -179,7 +179,7 @@ store source and destination sequences and message references. .<| `string` .<| `#defaultRmFeature` -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.rm.feature.RMFeature` bean to set on +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.rm.feature.RMFeature` bean to set on clients and service endpoint which have `quarkus.cxf.++[++client++\|++service++]++."name".rm.enabled = true`. If the value is `++#++defaultRmFeature` then Quarkus CXF creates and configures the bean for you. diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc index 140165160..8b04e09bd 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc @@ -37,8 +37,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -220,7 +220,7 @@ whose public key is in the service's truststore (defined in `encrypt.properties` .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` bean +3+a|A xref:user-guide/configuration.adoc[reference] to a `javax.security.auth.callback.CallbackHandler` bean used to obtain passwords, for both outbound and inbound requests. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_CALLBACK_HANDLER+++` + @@ -230,7 +230,7 @@ used to obtain passwords, for both outbound and inbound requests. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` +3+a|A xref:user-guide/configuration.adoc[reference] to a `javax.security.auth.callback.CallbackHandler` implementation used to construct SAML Assertions. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_SAML_CALLBACK_HANDLER+++` + @@ -278,7 +278,7 @@ org.apache.ws.security.components.crypto.Merlin .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used for signature. If not set, `signature.properties` will be used to configure a `Crypto` instance. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_SIGNATURE_CRYPTO+++` + @@ -288,7 +288,7 @@ for signature. If not set, `signature.properties` will be used to configure a `C .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_ENCRYPTION_CRYPTO+++` + @@ -700,7 +700,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` bean to use for SPNEGO. This allows the user to plug in a different implementation to obtain a service ticket. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -713,7 +713,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `UsernameToken` nonces. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -726,7 +726,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `Timestamp` `Created` Strings. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. @@ -740,7 +740,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache SAML2 Token Identifier Strings (if the token contains a `OneTimeUse` condition). A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. @@ -767,7 +767,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean to use for caching security tokens. By default this uses a instance. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -854,7 +854,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` bean, which is used to encrypt or decrypt passwords in the Merlin Crypto implementation (or any custom Crypto implementations). @@ -874,7 +874,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for +3+a|A xref:user-guide/configuration.adoc[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for WS-Security. This is used to retrieve a service ticket instead of using the client credentials. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -887,7 +887,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.wss4j.WSS4JSecurityContextCreator` bean that is used to create a CXF SecurityContext from the set of WSS4J processing results. The default implementation is `org.apache.cxf.ws.security.wss4j.DefaultWSS4JSecurityContextCreator`. @@ -976,7 +976,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` bean used to obtain a service ticket. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -1036,7 +1036,7 @@ enabled. 3+a|The Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1059,7 +1059,7 @@ enabled. 3+a|The Symmetric Key Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1082,7 +1082,7 @@ enabled. 3+a|The Asymmetric Key Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1104,7 +1104,7 @@ enabled. 3+a|The Encryption Key Derivation to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1126,7 +1126,7 @@ enabled. 3+a|The Signature Key Derivation to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1149,7 +1149,7 @@ enabled. 3+a|The Encryption Derived Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1172,7 +1172,7 @@ enabled. 3+a|The Signature Derived Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1195,7 +1195,7 @@ enabled. 3+a|The Minimum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1217,7 +1217,7 @@ enabled. 3+a|The Maximum Symmetric Key Length to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1240,7 +1240,7 @@ enabled. 3+a|The Minimum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1263,7 +1263,7 @@ enabled. 3+a|The Maximum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -1283,7 +1283,7 @@ enabled. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a fully configured +3+a|A xref:user-guide/configuration.adoc[reference] to a fully configured `org.apache.cxf.ws.security.trust.STSClient` bean to communicate with the STS. If not set, the STS client will be created and configured based on other `++[++prefix++]++.security.sts.client.++*++` properties as long as they are available. @@ -1294,7 +1294,7 @@ cannot thus be used as a CDI bean type, you can use the wrapper class [TIP] ==== -Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS)] extension page +Check the xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS)] extension page for more information about WS-Trust. ==== @@ -1398,7 +1398,7 @@ org.apache.ws.security.components.crypto.Merlin .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. *Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENT_NAME__SECURITY_STS_CLIENT_ENCRYPTION_CRYPTO+++` + @@ -1408,7 +1408,7 @@ encryption. If not set, `encryption.properties` will be used to configure a `Cry .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for the STS. If not set, `token.properties` will be used to configure a `Crypto` instance. WCF's trust server sometimes will encrypt the token in the response IN ADDITION TO the full security on the message. @@ -1529,7 +1529,7 @@ whose public key is in the service's truststore (defined in `encrypt.properties` .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` bean +3+a|A xref:user-guide/configuration.adoc[reference] to a `javax.security.auth.callback.CallbackHandler` bean used to obtain passwords, for both outbound and inbound requests. *Environment variable*: `+++QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SECURITY_CALLBACK_HANDLER+++` + @@ -1539,7 +1539,7 @@ used to obtain passwords, for both outbound and inbound requests. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` +3+a|A xref:user-guide/configuration.adoc[reference] to a `javax.security.auth.callback.CallbackHandler` implementation used to construct SAML Assertions. *Environment variable*: `+++QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SECURITY_SAML_CALLBACK_HANDLER+++` + @@ -1587,7 +1587,7 @@ org.apache.ws.security.components.crypto.Merlin .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used for signature. If not set, `signature.properties` will be used to configure a `Crypto` instance. *Environment variable*: `+++QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SECURITY_SIGNATURE_CRYPTO+++` + @@ -1597,7 +1597,7 @@ for signature. If not set, `signature.properties` will be used to configure a `C .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. *Environment variable*: `+++QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__SECURITY_ENCRYPTION_CRYPTO+++` + @@ -2009,7 +2009,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` bean to use for SPNEGO. This allows the user to plug in a different implementation to obtain a service ticket. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -2022,7 +2022,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `UsernameToken` nonces. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -2035,7 +2035,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `Timestamp` `Created` Strings. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. @@ -2049,7 +2049,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache SAML2 Token Identifier Strings (if the token contains a `OneTimeUse` condition). A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. @@ -2076,7 +2076,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean to use for caching security tokens. By default this uses a instance. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -2163,7 +2163,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` bean, which is used to encrypt or decrypt passwords in the Merlin Crypto implementation (or any custom Crypto implementations). @@ -2183,7 +2183,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for +3+a|A xref:user-guide/configuration.adoc[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for WS-Security. This is used to retrieve a service ticket instead of using the client credentials. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -2196,7 +2196,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.wss4j.WSS4JSecurityContextCreator` bean that is used to create a CXF SecurityContext from the set of WSS4J processing results. The default implementation is `org.apache.cxf.ws.security.wss4j.DefaultWSS4JSecurityContextCreator`. @@ -2285,7 +2285,7 @@ tests] yet. .<| `string` .<| -3+a|A xref:user-guide/configuration.adoc#beanRefs[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` +3+a|A xref:user-guide/configuration.adoc[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` bean used to obtain a service ticket. This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by @@ -2345,7 +2345,7 @@ enabled. 3+a|The Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2368,7 +2368,7 @@ enabled. 3+a|The Symmetric Key Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2391,7 +2391,7 @@ enabled. 3+a|The Asymmetric Key Encryption Algorithm to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2413,7 +2413,7 @@ enabled. 3+a|The Encryption Key Derivation to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2435,7 +2435,7 @@ enabled. 3+a|The Signature Key Derivation to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2458,7 +2458,7 @@ enabled. 3+a|The Encryption Derived Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2481,7 +2481,7 @@ enabled. 3+a|The Signature Derived Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2504,7 +2504,7 @@ enabled. 3+a|The Minimum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2526,7 +2526,7 @@ enabled. 3+a|The Maximum Symmetric Key Length to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2549,7 +2549,7 @@ enabled. 3+a|The Minimum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see @@ -2572,7 +2572,7 @@ enabled. 3+a|The Maximum Symmetric Key Length (number of bits) to set on the `org.apache.wss4j.policy.model.AlgorithmSuite.AlgorithmSuiteType`. This value is only taken into account if the current security policy has set -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#ws-security-custom-algorithm-suite-example[`CustomAlgorithmSuite` as an +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[`CustomAlgorithmSuite` as an `AlgorithmSuite`] For more information about algorithms, see diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc index ecee81b90..c4acce80a 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-services-sts.adoc @@ -32,8 +32,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -139,7 +139,7 @@ include::example$ws-trust/application.properties[tag=ws-trust-usage.adoc-client- ==== The properties for configuring the STS client are provided by the `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security` extension and documented on its -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[reference page]. +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[reference page]. ==== Alternatively, the client can be set as a bean reference: diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc index daa2b66cb..8d5d7c7a9 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-xjc-plugins.adoc @@ -13,9 +13,9 @@ ifeval::[{doc-show-badges} == true] Stable • Since 1.5.11 endif::[] -XJC plugins for xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] code generation. +XJC plugins for xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] code generation. You'll need to add this extension if you want to use any of the following in -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[quarkus.cxf.codegen.wsdl2java.additional-params]: +xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.codegen.wsdl2java.additional-params]: * `https://cxf.apache.org/cxf-xjc-boolean.html[-xjc-Xbg]` - generate `getFoo()` instead of `isFoo()` accessor methods for boolean fields. * `https://cxf.apache.org/cxf-xjc-dv.html[-xjc-Xdv]` - let the generated getter methods return the default value defined in the schema unless the field is set explicitly. @@ -26,7 +26,7 @@ xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2 [TIP] ==== -Check the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[wsdl2java] section of User guide for more details about `wsdl2java`. +Check the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[wsdl2java] section of User guide for more details about `wsdl2java`. ==== @@ -46,8 +46,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc index ccae03a6a..319ef4d7c 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc @@ -31,8 +31,8 @@ or add these coordinates to your existing project: ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== -Check the xref:user-guide/index.adoc#user-guide-index[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +Check the xref:user-guide/index.adoc[User guide] and especially its +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -50,24 +50,24 @@ endif::[] [id="quarkus-cxf-usage"] == Usage -There are several chapters in the xref:user-guide/index.adoc#user-guide-index[User guide] covering the usage of this extension: - -* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] -* xref:user-guide/configuration.adoc#configuration[Configuration] -* xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[Package for JVM and native] -* xref:user-guide/payload-logging.adoc#payload-logging[Logging] -* xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL] -* xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization] -* xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced SOAP client topics] -* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[Running behind a reverse proxy] -* xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] -* xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc#generate-wsdl-from-java[Generate WSDL from Java] -* xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Contract first and code first] -* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[CXF Interceptors and Features] -* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc#jax-ws-handlers[JAX-WS Handlers] -* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc#jax-ws-providers[JAX-WS Providers] -* xref:user-guide/examples.adoc#examples[Examples] +There are several chapters in the xref:user-guide/index.adoc[User guide] covering the usage of this extension: + +* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] +* xref:user-guide/configuration.adoc[Configuration] +* xref:user-guide/package-for-jvm-and-native.adoc[Package for JVM and native] +* xref:user-guide/payload-logging.adoc[Logging] +* xref:user-guide/ssl-tls-https.adoc[SSL] +* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] +* xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] +* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[Running behind a reverse proxy] +* xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] +* xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc[Generate WSDL from Java] +* xref:user-guide/contract-first-code-first.adoc[Contract first and code first] +* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[CXF Interceptors and Features] +* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc[JAX-WS Handlers] +* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc[JAX-WS Providers] +* xref:user-guide/examples.adoc[Examples] [id="quarkus-cxf-configuration"] diff --git a/docs/modules/ROOT/pages/reference/index.adoc b/docs/modules/ROOT/pages/reference/index.adoc index f37d51033..ed44da4db 100644 --- a/docs/modules/ROOT/pages/reference/index.adoc +++ b/docs/modules/ROOT/pages/reference/index.adoc @@ -12,49 +12,49 @@ Click the extension names to learn more about how to configure and use them, and | Quarkus CXF extension | Support level | Since | Supported standards // standards: START -| xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[Quarkus CXF] + +| xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF] + `quarkus-cxf` |Stable |0.1.0 |https://cxf.apache.org/docs/jax-ws.html[JAX-WS], https://cxf.apache.org/docs/jaxb.html[JAXB], https://cxf.apache.org/docs/ws-addressing.html[WS-Addressing], https://cxf.apache.org/docs/ws-policy.html[WS-Policy], https://cxf.apache.org/docs/mtom.html[MTOM] -| xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Quarkus CXF Metrics Feature] + +| xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Quarkus CXF Metrics Feature] + `quarkus-cxf-rt-features-metrics` |Stable |0.14.0 | -| xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc#quarkus-cxf-integration-tracing-opentelemetry[Quarkus CXF OpenTelemetry] + +| xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[Quarkus CXF OpenTelemetry] + `quarkus-cxf-integration-tracing-opentelemetry` |Stable |2.7.0 | -| xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[Quarkus CXF WS-Security] + +| xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[Quarkus CXF WS-Security] + `quarkus-cxf-rt-ws-security` |Stable |0.14.0 |https://cxf.apache.org/docs/ws-security.html[WS-Security], https://cxf.apache.org/docs/ws-securitypolicy.html[WS-SecurityPolicy] -| xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm[Quarkus CXF WS-ReliableMessaging] + +| xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[Quarkus CXF WS-ReliableMessaging] + `quarkus-cxf-rt-ws-rm` |Stable |1.5.3 |https://cxf.apache.org/docs/ws-reliablemessaging.html[WS-ReliableMessaging] -| xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Quarkus CXF Security Token Service (STS)] + +| xref:reference/extensions/quarkus-cxf-services-sts.adoc[Quarkus CXF Security Token Service (STS)] + `quarkus-cxf-services-sts` |Stable |1.5.3 |https://cxf.apache.org/docs/ws-trust.html[WS-Trust] -| xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[Quarkus CXF HTTP Async Transport] + +| xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[Quarkus CXF HTTP Async Transport] + `quarkus-cxf-rt-transports-http-hc5` |Stable |1.1.0 | -| xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[Quarkus CXF XJC Plugins] + +| xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[Quarkus CXF XJC Plugins] + `quarkus-cxf-xjc-plugins` |Stable |1.5.11 @@ -94,17 +94,17 @@ Out of https://cxf.apache.org/docs/databindings.html[CXF Data Bindings] only the Out of https://cxf.apache.org/docs/transports.html[CXF Transports] only the following ones are supported: * `quarkus-cxf` implements its own custom transport based on Quarkus and Vert.x for serving SOAP endpoints -* HTTP client via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[quarkus-cxf]`, including -** xref:user-guide/authentication-authorization.adoc#client-http-basic-authentication[Basic Authentication] +* HTTP client via `xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]`, including +** xref:user-guide/authentication-authorization.adoc[Basic Authentication] * https://cxf.apache.org/docs/asynchronous-client-http-transport.html[Asynchronous Client HTTP Transport] - via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[quarkus-cxf-rt-transports-http-hc5]` + via `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` [[tools]] === Tools -* `wsdl2Java` - see the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate the Model classes from WSDL +* `wsdl2Java` - see the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate the Model classes from WSDL ] section of User guide -* `java2ws` - see the xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc#generate-wsdl-from-java[Generate WSDL from Java] section of User guide +* `java2ws` - see the xref:user-guide/contract-first-code-first/generate-wsdl-from-java.adoc[Generate WSDL from Java] section of User guide === Supported SOAP Bindings diff --git a/docs/modules/ROOT/pages/release-notes/index.adoc b/docs/modules/ROOT/pages/release-notes/index.adoc index 5beca8ea9..af54c1412 100644 --- a/docs/modules/ROOT/pages/release-notes/index.adoc +++ b/docs/modules/ROOT/pages/release-notes/index.adoc @@ -11,7 +11,7 @@ See also xref:release-planning.adoc[Release planning]. [NOTE] ==== The values in the Release date column refer to release dates of {quarkus-cxf-project-name}. -We recommend using xref:user-guide/create-project.adoc#quarkus-platform[Quarkus Platform BOMs] +We recommend using xref:user-guide/create-project.adoc[Quarkus Platform BOMs] for managing {quarkus-cxf-project-name} dependencies. Those are typically released on Wednesday following the {quarkus-cxf-project-name} release date. ==== @@ -20,51 +20,51 @@ Those are typically released on Wednesday following the {quarkus-cxf-project-nam |=== | Quarkus CXF | Release date | Quarkus Platform | CXF -| xref:release-notes/rn-3-15-0.adoc#rn-3-15-0[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 +| xref:release-notes/rn-3-15-0.adoc[3.15.0 LTS] | 2024-09-19 | 3.15.0 | 4.0.5 -| xref:release-notes/rn-3-14-0.adoc#rn-3-14-0[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 +| xref:release-notes/rn-3-14-0.adoc[3.14.0] | 2024-08-22 | 3.14.0 | 4.0.5 -| xref:release-notes/rn-3-13-1.adoc#rn-3-13-1[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 -| xref:release-notes/rn-3-13-0.adoc#rn-3-13-0[3.13.0] | 2024-07-25 | | 4.0.4 +| xref:release-notes/rn-3-13-1.adoc[3.13.1] | 2024-07-30 | 3.13.0 | 4.0.5 +| xref:release-notes/rn-3-13-0.adoc[3.13.0] | 2024-07-25 | | 4.0.4 -| xref:release-notes/rn-3-12-0.adoc#rn-3-12-0[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 +| xref:release-notes/rn-3-12-0.adoc[3.12.0] | 2024-06-19 | 3.12 | 4.0.4 -| xref:release-notes/rn-3-11-1.adoc#rn-3-11-1[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 -| xref:release-notes/rn-3-11-0.adoc#rn-3-11-0[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 +| xref:release-notes/rn-3-11-1.adoc[3.11.1] | 2024-06-03 | 3.11.1 | 4.0.4 +| xref:release-notes/rn-3-11-0.adoc[3.11.0] | 2024-05-23 | 3.11 | 4.0.4 -| xref:release-notes/rn-3-10-0.adoc#rn-3-10-0[3.10.0] | | 3.10 | 4.0.4 +| xref:release-notes/rn-3-10-0.adoc[3.10.0] | | 3.10 | 4.0.4 -| xref:release-notes/rn-3-9-0.adoc#rn-3-9-0[3.9.0] | | 3.9 | 4.0.4 +| xref:release-notes/rn-3-9-0.adoc[3.9.0] | | 3.9 | 4.0.4 -| xref:release-notes/rn-3-8-6.adoc#rn-3-8-6[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 -| xref:release-notes/rn-3-8-5.adoc#rn-3-8-5[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-4.adoc#rn-3-8-4[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-3.adoc#rn-3-8-3[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-2.adoc#rn-3-8-2[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-1.adoc#rn-3-8-1[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 -| xref:release-notes/rn-3-8-0.adoc#rn-3-8-0[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 +| xref:release-notes/rn-3-8-6.adoc[3.8.6 LTS] | 2024-08-28 | 3.8.6 | 4.0.5 +| xref:release-notes/rn-3-8-5.adoc[3.8.5 LTS] | 2024-07-06 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-4.adoc[3.8.4 LTS] | 2024-05-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-3.adoc[3.8.3 LTS] | 2024-04-10 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-2.adoc[3.8.2 LTS] | 2024-03-28 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-1.adoc[3.8.1 LTS] | 2024-03-12 | 3.8 | 4.0.4 +| xref:release-notes/rn-3-8-0.adoc[3.8.0 LTS] | 2024-02-21 | 3.8 | 4.0.3 -| xref:release-notes/rn-2-7-1.adoc#rn-2-7-1[2.7.1] | | 3.7 | 4.0.3 -| xref:release-notes/rn-2-7-0.adoc#rn-2-7-0[2.7.0] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-1.adoc[2.7.1] | | 3.7 | 4.0.3 +| xref:release-notes/rn-2-7-0.adoc[2.7.0] | | 3.7 | 4.0.3 -| xref:release-notes/rn-2-6-1.adoc#rn-2-6-1[2.6.1] | | 3.6 | 4.0.3 -| xref:release-notes/rn-2-6-0.adoc#rn-2-6-0[2.6.0] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-1.adoc[2.6.1] | | 3.6 | 4.0.3 +| xref:release-notes/rn-2-6-0.adoc[2.6.0] | | 3.6 | 4.0.3 -| xref:release-notes/rn-2-5-0.adoc#rn-2-5-0[2.5.0] | | 3.5 | 4.0.3 +| xref:release-notes/rn-2-5-0.adoc[2.5.0] | | 3.5 | 4.0.3 -| xref:release-notes/rn-2-4-0.adoc#rn-2-4-0[2.4.0] | | 3.4 | 4.0.2 +| xref:release-notes/rn-2-4-0.adoc[2.4.0] | | 3.4 | 4.0.2 -| xref:release-notes/rn-2-3-1.adoc#rn-2-3-1[2.3.1] | | 3.3 | 4.0.2 -| xref:release-notes/rn-2-3-0.adoc#rn-2-3-0[2.3.0] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-1.adoc[2.3.1] | | 3.3 | 4.0.2 +| xref:release-notes/rn-2-3-0.adoc[2.3.0] | | 3.3 | 4.0.2 | 2.2.7 LTS | | 3.2 | 4.0.3 | 2.2.6 LTS | | 3.2 | 4.0.3 | 2.2.5 LTS | | 3.2 | 4.0.3 | 2.2.4 LTS | | 3.2 | 4.0.2 | 2.2.3 LTS | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-2.adoc#rn-2-2-2[2.2.2 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-1.adoc#rn-2-2-1[2.2.1 LTS] | | 3.2 | 4.0.2 -| xref:release-notes/rn-2-2-0.adoc#rn-2-2-0[2.2.0 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-2.adoc[2.2.2 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-1.adoc[2.2.1 LTS] | | 3.2 | 4.0.2 +| xref:release-notes/rn-2-2-0.adoc[2.2.0 LTS] | | 3.2 | 4.0.2 | 2.1.0 | | 3.1 | 4.0.1 diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc index b17f7347d..9add9d633 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-0.adoc @@ -10,13 +10,13 @@ === XJC plugin options are now tested and documented -See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[XJC plugins] reference page. +See xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[XJC plugins] reference page. === Metrics Feature tested and documented -The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Metrics Feature] extension has got +The xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature] extension has got a proper https://github.com/quarkiverse/quarkus-cxf/tree/2.7.0/integration-tests/metrics[test] -and a basic xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide]. +and a basic xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Usage guide]. [NOTE] ==== diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc index 1a7ecd8f5..ae70ebbf5 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-2-1.adoc @@ -5,7 +5,7 @@ === HTTP Async Transport extension stable -The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc#quarkus-cxf-rt-transports-http-hc5[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. +The `xref:reference/extensions/quarkus-cxf-rt-transports-http-hc5.adoc[quarkus-cxf-rt-transports-http-hc5]` has got a proper test and its support status was upgraded to `stable`. == Fixed bugs diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc index 4864473d8..b5ede794c 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-3-1.adoc @@ -8,35 +8,35 @@ In plain CXF, these are set via `HTTPClientPolicy`. {quarkus-cxf-project-name} now offers configuration options to set them: -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-timeout[quarkus.cxf.client."client-name".connection-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-receive-timeout[quarkus.cxf.client."client-name".receive-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection-request-timeout[quarkus.cxf.client."client-name".connection-request-timeout]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-max-retransmits[quarkus.cxf.client."client-name".max-retransmits]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-allow-chunking[quarkus.cxf.client."client-name".allow-chunking]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunking-threshold[quarkus.cxf.client."client-name".chunking-threshold]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-chunk-length[quarkus.cxf.client."client-name".chunk-length]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept[quarkus.cxf.client."client-name".accept]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-language[quarkus.cxf.client."client-name".accept-language]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-accept-encoding[quarkus.cxf.client."client-name".accept-encoding]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-content-type[quarkus.cxf.client."client-name".content-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-host[quarkus.cxf.client."client-name".host]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-connection[quarkus.cxf.client."client-name".connection]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-cache-control[quarkus.cxf.client."client-name".cache-control]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-decoupled-endpoint[quarkus.cxf.client."client-name".decoupled-endpoint]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server[quarkus.cxf.client."client-name".proxy-server]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-port[quarkus.cxf.client."client-name".proxy-server-port]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-non-proxy-hosts[quarkus.cxf.client."client-name".non-proxy-hosts]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-server-type[quarkus.cxf.client."client-name".proxy-server-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-username[quarkus.cxf.client."client-name".proxy-username]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-proxy-password[quarkus.cxf.client."client-name".proxy-password]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".connection-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".receive-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".connection-request-timeout]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".auto-redirect]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".max-retransmits]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".allow-chunking]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".chunking-threshold]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".chunk-length]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".accept]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".accept-language]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".accept-encoding]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".content-type]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".host]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".connection]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".cache-control]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".version]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".browser-type]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".decoupled-endpoint]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".proxy-server]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".proxy-server-port]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".non-proxy-hosts]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".proxy-server-type]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".proxy-username]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".proxy-password]` === `HTTPConduitFactory` configurable through `application.properties` There is a new option -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[quarkus.cxf.client."client-name".http-conduit-factory]` +`xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".http-conduit-factory]` intended primarily as a workaround for https://issues.apache.org/jira/browse/CXF-8885[CXF-8885] and https://github.com/quarkiverse/quarkus-cxf/issues/992[#992]. Those are about `java.net.http.HttpClient`-based CXF clients leaking threads. diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc index 1bbaa7692..6a38e64eb 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-4-0.adoc @@ -9,7 +9,7 @@ === More `wsdl2java` options configurable through `application.properties` -See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] page. +See the updated xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] page. == Fixed bugs diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc index 2f86e9075..8285ad4c2 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-5-0.adoc @@ -12,18 +12,18 @@ The trust store and host name verifier of a client are now configurable through some new configuration properties: -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-hostname-verifier[quarkus.cxf.client."client-name".hostname-verifier] +* xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store] +* xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store-password] +* xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store-type] +* xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".hostname-verifier] === `LoggingFeature` configurable through `application.properties` -See the xref:user-guide/payload-logging.adoc#payload-logging[Logging] page. +See the xref:user-guide/payload-logging.adoc[Logging] page. === WS-Security configurable through `application.properties` -See the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[Configuration] section of the WS-Security reference page. +See the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[Configuration] section of the WS-Security reference page. [NOTE] ==== diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc index d1cf03c4e..daf6bb5cf 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-6-0.adoc @@ -12,7 +12,7 @@ === Logging extension is deprecated The Logging functionality and all associated -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-logging-enabled-for[configuration options] were moved to `io.quarkiverse.cxf:quarkus-cxf` extension. +xref:reference/extensions/quarkus-cxf.adoc[configuration options] were moved to `io.quarkiverse.cxf:quarkus-cxf` extension. The `io.quarkiverse.cxf:quarkus-cxf-rt-features-logging` extension is now deprecated and you can remove it from your projects. It will be removed altogether in the future. @@ -22,7 +22,7 @@ See https://github.com/quarkiverse/quarkus-cxf/issues/1047[#1047] === Configurable destination folder of `wsdl2java` -The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable +The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable via the `xref:reference/extensions/quarkus-cxf#quarkus-cxf_quarkus.cxf.codegen.wsdl2java.output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property. === Possible thread leaks with CXF clients using `java.net.http.HttpClient` @@ -41,7 +41,7 @@ as soon as they are disposed by the CDI container. For client proxies created manually, it is up to you to call `((Closeable) proxy).close()`. -For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc#prevent-resource-leaks[Prevent resource leaks] section of the user guide. +For more information, see xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] section of the user guide. === Large responses not written slowly anymore @@ -51,7 +51,7 @@ This https://github.com/quarkiverse/quarkus-cxf/issues/1066[issue] is now fixed. === More WS-Security configuration options covered by tests -We are continually improving the test coverage of the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[WS-Security configuration options]. +We are continually improving the test coverage of the xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security configuration options]. There is now less options marked with the warning [quote] @@ -61,7 +61,7 @@ ____ === Documentation improvements -* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[X-Forwarded support] page +* New xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[X-Forwarded support] page == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc index 46566f7ac..18179d558 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-2-7-0.adoc @@ -14,24 +14,24 @@ and run your applications. === WS-ReliableMessaging (WS-RM) supported -The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. +The `xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[quarkus-cxf-rt-ws-rm]` extension is rather old, but was missing a proper test and documentation. Both was added in this release and thus the extension status could be promoted from `experimental` to `stable`. Check the following resources: -* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-usage[Usage] section of the reference page -* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc#quarkus-cxf-rt-ws-rm-configuration[Configuration options]. +* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[Usage] section of the reference page +* New xref:reference/extensions/quarkus-cxf-rt-ws-rm.adoc[Configuration options]. === Metrics Feature supported -Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics[Metrics Feature]'s support status is now `stable`, +Similarly, the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature]'s support status is now `stable`, after we have improved -the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-usage[Usage guide] -and added some xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf-rt-features-metrics-configuration[Configuration options]. +the xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Usage guide] +and added some xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Configuration options]. === New OpenTelemetry tracing extension -There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc#quarkus-cxf-integration-tracing-opentelemetry[OpenTelemetry] extension. +There is a new xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry] extension. It currently supports only tracing. OpenTelemetry Metrics and Logging and not implemented yet. @@ -47,25 +47,25 @@ image::release-notes-2-7-0-devui-services.png[DevUI] === Schema validation configurable via `application.properties` -See `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-schema-validation-enabled-for[quarkus.cxf.client."client-name".schema-validation.enabled-for]` +See `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".schema-validation.enabled-for]` === Basic authentication for the WSDL {quarkus-cxf-project-name} now sends the -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[username] -and xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[password] +xref:reference/extensions/quarkus-cxf.adoc[username] +and xref:reference/extensions/quarkus-cxf.adoc[password] when getting the WSDL document, -as long as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` is `true`. +as long as `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".secure-wsdl-access]` is `true`. === Documentation improvements -* New `xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL guide]` -* New `xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization guide]` -* Improved the xref:user-guide/payload-logging.adoc#payload-logging[Logging guide] -* Improved the documentation of `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-version[quarkus.cxf.client."client-name".version]` - and `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-browser-type[quarkus.cxf.client."client-name".browser-type]` +* New `xref:user-guide/ssl-tls-https.adoc[SSL guide]` +* New `xref:user-guide/authentication-authorization.adoc[Authentication and authorization guide]` +* Improved the xref:user-guide/payload-logging.adoc[Logging guide] +* Improved the documentation of `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".version]` + and `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".browser-type]` == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc index 46d2294e5..10a825645 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-10-0.adoc @@ -38,7 +38,7 @@ We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether + image::release-notes-2.10.0-since.png[The new since tag] + -* We added the xref:release-notes/index.adoc#release-notes-index[Version table] to the Release notes page showing which version of +* We added the xref:release-notes/index.adoc[Version table] to the Release notes page showing which version of {quarkus-cxf-project-name} uses which CXF version and which Quarkus Platform `.` you should use to get the given {quarkus-cxf-project-name} version. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc index b4d4feb41..098589c98 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-11-0.adoc @@ -27,11 +27,11 @@ public class HelloServiceImpl implements HelloService { } ---- -You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Service endpoints and paths]. +You can read more about `@CXFEndpoint` in the new chapter of {quarkus-cxf-project-name} called xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths]. === Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package were only instantiated using reflection. Due to this, injecting beans and configuration values into them did not work. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc index d31fcaac5..96a598245 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-0.adoc @@ -18,9 +18,9 @@ currently supports only the synchronous usage. We plan to add the https://github.com/quarkiverse/quarkus-cxf/issues/1447[support for asynchronous mode] in near future. To give it a try, set the `http-conduit-factory` configuration option -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[globally] +xref:reference/extensions/quarkus-cxf.adoc[globally] or -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[per client]: +xref:reference/extensions/quarkus-cxf.adoc[per client]: .application.properties [source,properties] @@ -47,7 +47,7 @@ the scanning is now done at build time by Arc, the CDI container of Quarkus. === https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` Before {quarkus-cxf-project-name} 3.13.0, the values specified in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` +`xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.codegen.wsdl2java.package-names]` were wrongly passed as a single comma-separated value of the `-p` option, leading to `BadUsageException: -p has invalid character!`. @@ -91,13 +91,13 @@ Quarkus Contexts and dependency injection guide for more details. * https://github.com/quarkiverse/quarkus-cxf/issues/1424[#1424] Replaced references to the non-existent `quarkus.cxf.logging.enabled` option for the correct `quarkus.cxf.logging.enabled-for` option. * User guide navigation was restructured: some chapters moved under new nodes -** xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Contract first and code first approaches] -** xref:user-guide/interceptors-features-handlers.adoc#interceptors-features-handlers[CXF Interceptors and Features, JAX-WS Handlers] -** xref:user-guide/advanced-service-topics.adoc#advanced-service-topics[Advanced service topics] -** xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced SOAP client topics] +** xref:user-guide/contract-first-code-first.adoc[Contract first and code first approaches] +** xref:user-guide/interceptors-features-handlers.adoc[CXF Interceptors and Features, JAX-WS Handlers] +** xref:user-guide/advanced-service-topics.adoc[Advanced service topics] +** xref:user-guide/advanced-soap-client-topics.adoc[Advanced SOAP client topics] * New chapters: -** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] -** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[Dynamic client configuration] +** xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] - see also https://github.com/quarkiverse/quarkus-cxf/issues/1441[#1441] +** xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc index f6ecb8e29..1ed75ca99 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-13-1.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1455[#1455] Vert.x HTTP client is incorrectly used as the default -We introduced xref:release-notes/rn-3-13-0.adoc#vert-x-httpclient_based_http_conduit[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 +We introduced xref:release-notes/rn-3-13-0.adoc[Vert.x HttpClient based HTTP Conduit] in {quarkus-cxf-project-name} 3.13.0 and it was not supposed to replace the original `HttpURLConnection` based default conduit. However, we screwed the default handling which resulted in using `VertxHttpClientHTTPConduit` as a default in some cases. This was fixed in {quarkus-cxf-project-name} 3.13.1. @@ -18,7 +18,7 @@ We are sorry for the inconvenience. === Documentation improvements -* We added a paragraph explaining xref:user-guide/create-project.adoc#quarkus-platform[Quarkus Platform] +* We added a paragraph explaining xref:user-guide/create-project.adoc[Quarkus Platform] * We added the xref:release-planning.adoc[Release planning] page explaining how and when we release {quarkus-cxf-project-name} == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc index 6a6d8fe14..77f29ca17 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-14-0.adoc @@ -9,7 +9,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1460[#1460] IllegalArgumentException: port p must be in range 0 <= p <= 65535 when using client-endpoint-url without explicit port -When using the xref:release-notes/rn-3-13-0.adoc#vert-x-httpclient_based_http_conduit[new `VertxHttpClientHTTPConduitFactory`], +When using the xref:release-notes/rn-3-13-0.adoc[new `VertxHttpClientHTTPConduitFactory`], the handling of default ports for `http` and `https` client endpoint URLs was broken resulting in an `IllegalArgumentException`. This was fixed in {quarkus-cxf-project-name} 3.14.0. @@ -32,8 +32,8 @@ and if the value is `false`, it disables OpenTelemetry for CXF too. === Documentation improvements Some substantial refactoring took place in the way how we generate the documentation for the -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[configuration] -xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security-configuration[options]. +xref:reference/extensions/quarkus-cxf.adoc[configuration] +xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[options]. Although there are not many https://github.com/quarkiverse/quarkus-cxf/commit/b8913f7fcc58ced6cec9b7c1dc505cfcdd9088f4[observable changes], please do not hesitate to https://github.com/quarkiverse/quarkus-cxf/issues/new[file an issue] if you spot some irregularity. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc index 013717325..e160fcf74 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-15-0.adoc @@ -52,7 +52,7 @@ methods. Those are therefore called only once. If the old way does not work anymore, how can you do the same with {quarkus-cxf-project-name} 3.15.0 or newer? The answer consists in providing a bean implementing `org.apache.cxf.metrics.micrometer.provider.TagsCustomizer` -and making CXF aware of it via the new `xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc#quarkus-cxf_quarkus-cxf-metrics-tags-customizers[quarkus.cxf.metrics.tags-customizers]` configuration property. +and making CXF aware of it via the new `xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[quarkus.cxf.metrics.tags-customizers]` configuration property. There is an example in our https://github.com/quarkiverse/quarkus-cxf/tree/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5[Apache HTTP Client v5 integration test]. The crucial parts are the https://github.com/quarkiverse/quarkus-cxf/blob/eb553e2a3658581baeeef5836f64bdd9775c0efc/integration-tests/hc5/src/main/java/io/quarkiverse/cxf/hc5/it/HeaderToMetricsTagsCustomizer.java[`TagsCustomizer` implementation] diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc index d4303be5f..6383d25a6 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-0.adoc @@ -35,11 +35,11 @@ The new Maven coordinates starting with {quarkus-cxf-project-name} 3.8.0 are `io The following parts of the documentation were improved: -* The Reference page now contains xref:reference/index.adoc#supported-cxf-annotations[List of supported CXF annotations]. -* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[WS-Security extension page] -** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy] -** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient] -* xref:reference/extensions/quarkus-cxf-services-sts.adoc#quarkus-cxf-services-sts[Security Token Service (STS) extension page] with a more detailed example +* The Reference page now contains xref:reference/index.adoc[List of supported CXF annotations]. +* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page] +** New example using xref:reference/index.adoc[WS-SecurityPolicy] +** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[STSClient] +* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page] with a more detailed example == Full changelog diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc index c7ff135dc..9932d1840 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-1.adoc @@ -12,17 +12,17 @@ === Mutual TLS (mTLS) -Mutual TLS (mTLS) is now xref:user-guide/ssl-tls-https.adoc#mtls[documented], +Mutual TLS (mTLS) is now xref:user-guide/ssl-tls-https.adoc[documented], https://github.com/quarkiverse/quarkus-cxf/tree/main/integration-tests/mtls[tested] -and and can be configured for clients via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key*]` family of options. +and and can be configured for clients via `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".key*]` family of options. === Keystores and truststores now looked up in the file system The keystores and truststores are now https://github.com/quarkiverse/quarkus-cxf/issues/1280[really looked up in the file system] unless they are available in the classpath as documented in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` +`xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store]` and -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-key-store[quarkus.cxf.client."client-name".key-store]`. +`xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".key-store]`. === Running on systems with FIPS assertions enabled @@ -68,7 +68,7 @@ In the policy file, the `AlgorithmSuite` has to be set to `CustomAlgorithmSuite` ---- + -FIPS complaint xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-custom-digest-algorithm[algorithms] can then be set in `application.properties`. +FIPS complaint xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[algorithms] can then be set in `application.properties`. Here, we list the default values that are FIPS complaint already: + [source,properties] diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc index 86e6955ee..9d3848fdb 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc @@ -21,7 +21,7 @@ you will have to add them yourself. Before this release, it depended transitively on `org.apache.cxf:cxf-rt-databinding-aegis` and `org.apache.cxf:cxf-rt-javascript` via `org.apache.cxf:cxf-tools-java2ws`. It was an oversight on our side. We never intended to support using Aegis or Javascript at runtime or build time. -We have made that by listing them under xref:reference/index.adoc#unsupported[Unsupported CXF modules]. +We have made that by listing them under xref:reference/index.adoc[Unsupported CXF modules]. The current change makes it impossible to generate WSDL from Aegis model classes at build time. The `java2js` functionality was never accessible via `io.quarkiverse.cxf:quarkus-cxf-deployment`. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc index b02cab8c6..082782aa4 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc @@ -22,7 +22,7 @@ We filed https://issues.apache.org/jira/browse/CXF-9003[CXF-9003] to see whether === Interceptors set through `@InInterceptors` and similar annotations are now looked up in the CDI container -Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package +Before {quarkus-cxf-project-name} 3.11.0 and 3.8.4, xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[interceptors] specified through `@InInterceptors`, `@InFaultInterceptors`, `@OutInterceptors` and `@OutFaultInterceptors` annotations from `org.apache.cxf.interceptor` package were only instantiated using reflection. Due to this, injecting beans and configuration values into them did not work. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc index 1f928dec6..ad035fe88 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc @@ -11,7 +11,7 @@ === https://github.com/quarkiverse/quarkus-cxf/issues/1416[#1416] passing multiple namespace mappings via `quarkus.cxf.codegen.wsdl2java.package-names` Before {quarkus-cxf-project-name} 3.13.0 and 3.8.6, the values specified in -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` +`xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.codegen.wsdl2java.package-names]` were wrongly passed as a single comma-separated value of the `-p` option, leading to `BadUsageException: -p has invalid character!`. diff --git a/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc index f101215f7..1a89330f4 100644 --- a/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc @@ -19,9 +19,9 @@ you will have to add them yourself. The following parts of the documentation were improved: -* We published a bunch of xref:release-notes/index.adoc#release-notes-index[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. -* Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling. -* We added xref:release-notes/index.adoc#version-table[Version table] to the release notes page. +* We published a bunch of xref:release-notes/index.adoc[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x. +* Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling. +* We added xref:release-notes/index.adoc[Version table] to the release notes page. It shows which Quarkus CXF version is available in which Quarkus Platform version and which CXF version it depends on. == Full changelog diff --git a/docs/modules/ROOT/pages/release-planning.adoc b/docs/modules/ROOT/pages/release-planning.adoc index 409eab3c1..5ae72dd01 100644 --- a/docs/modules/ROOT/pages/release-planning.adoc +++ b/docs/modules/ROOT/pages/release-planning.adoc @@ -8,7 +8,7 @@ https://github.com/quarkusio/quarkus/wiki/Release-Planning[release schedule of Q Quarkus Core is typically released on a Wednesday (roughly) once a month. We normally release {quarkus-cxf-project-name} in the week after that -and we subsequently send an upgrade to xref:user-guide/create-project.adoc#quarkus-platform[Quarkus Platform]. +and we subsequently send an upgrade to xref:user-guide/create-project.adoc[Quarkus Platform]. Quarkus Platform is then released on the following Wednesday. An example: @@ -26,4 +26,4 @@ We choose the same `major.minor` for LTS as Quarkus. == See also -* xref:release-notes/index.adoc#release-notes-index[Release notes] +* xref:release-notes/index.adoc[Release notes] diff --git a/docs/modules/ROOT/pages/security-guide/index.adoc b/docs/modules/ROOT/pages/security-guide/index.adoc index c4541150a..05e3171ac 100644 --- a/docs/modules/ROOT/pages/security-guide/index.adoc +++ b/docs/modules/ROOT/pages/security-guide/index.adoc @@ -3,6 +3,6 @@ The security guide documents various security related aspects of {quarkus-cxf-project-name}: -* xref:user-guide/ssl-tls-https.adoc#ssl-tls-https[SSL, TLS and HTTPS] -* xref:user-guide/authentication-authorization.adoc#authentication-authorization[Authentication and authorization] -* xref:security-guide/ws-securitypolicy-authentication-authorization.adoc#ws-securitypolicy-authentication-authorization[Authentication enforced by WS-SecurityPolicy] +* xref:user-guide/ssl-tls-https.adoc[SSL, TLS and HTTPS] +* xref:user-guide/authentication-authorization.adoc[Authentication and authorization] +* xref:security-guide/ws-securitypolicy-authentication-authorization.adoc[Authentication enforced by WS-SecurityPolicy] diff --git a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc index 43245f6b0..ad616241c 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc @@ -1,8 +1,8 @@ [[ws-securitypolicy-authentication-authorization]] = Authentication enforced by WS-SecurityPolicy -You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc#client-http-basic-authentication[clients] -and xref:user-guide/authentication-authorization.adoc#securing-service-endpoints[services]. +You can enforce authentication through WS-SecurityPolicy, instead of xref:user-guide/ssl-tls-https.adoc[Mutual TLS] and Basic HTTP authentication for xref:user-guide/authentication-authorization.adoc[clients] +and xref:user-guide/authentication-authorization.adoc[services]. To enforce authentication through WS-SecurityPolicy, follow these steps: @@ -69,7 +69,7 @@ include::example$ws-security-policy/application.properties[tag=ws-securitypolicy ---- In the above listing, `usernameTokenPasswordCallback` is a name of a `@jakarta.inject.Named` bean implementing `javax.security.auth.callback.CallbackHandler`. -{quarkus-cxf-project-name} will lookup a bean with this xref:user-guide/configuration.adoc#beanRefs[name] in the CDI container. +{quarkus-cxf-project-name} will lookup a bean with this xref:user-guide/configuration.adoc[name] in the CDI container. Here is an example implementation of the bean: diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc index 877da994d..971d81e29 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc @@ -8,5 +8,5 @@ Therefore, if the client is injected into an `@ApplicationScoped` bean, then the If the client is injected into an `@RequestScoped` bean, then the client instance also becomes `@RequestScoped`. This behavior comes in handy if you need to -xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[configure clients dynamically] +xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[configure clients dynamically] after the application was started. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc index 6c28c5d45..70f2ac74e 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-client-topics/dynamic-client-configuration.adoc @@ -2,7 +2,7 @@ = Dynamic client configuration Sometimes you need to reconfigure the client after the application has -xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc#programmatic-client-configuration-at-startup[been started], +xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc[been started], or even before every request. This might be the case, if, for example, each request needs to be sent to a different remote URL. @@ -12,7 +12,7 @@ However using that API on a client instance that may be accessed from other thre == Preventing concurrent access to a CXF client If your client is used as a part of serving an external request, -you can inject the client into a xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[`@RequestScoped` bean]. +you can inject the client into a xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[`@RequestScoped` bean]. Then every request will be served by a fresh client instance and you can configure it safely. For example, this solution is applicable when your client is called from a REST-handler method (see below) diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc index b61ee92bc..070252250 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics.adoc @@ -3,7 +3,7 @@ Check the following chapters for more details about implementing SOAP service endpoints: -* xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Endpoints and paths] -* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc#jax-ws-providers[JAX-WS Providers] -* xref:user-guide/advanced-service-topics/rest-and-soap-endpoints.adoc#rest-and-soap-endpoints[REST and SOAP Endpoints] -* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc#running-behind-a-reverse-proxy[Running behind a reverse proxy] +* xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Endpoints and paths] +* xref:user-guide/advanced-service-topics/jax-ws-providers.adoc[JAX-WS Providers] +* xref:user-guide/advanced-service-topics/rest-and-soap-endpoints.adoc[REST and SOAP Endpoints] +* xref:user-guide/advanced-service-topics/running-behind-a-reverse-proxy.adoc[Running behind a reverse proxy] diff --git a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc index 58fc2a9eb..259d8e9ca 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc @@ -6,7 +6,7 @@ Let's explain how a service endpoint can be exposed under a certain URL path. [[application-properties]] == Set the endpoint path via `application.properties` -In the xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[First SOAP Web service] chapter, we explained how to expose a service using `application.properties`: +In the xref:user-guide/first-soap-web-service.adoc[First SOAP Web service] chapter, we explained how to expose a service using `application.properties`: .application.properties [source,properties] @@ -23,7 +23,7 @@ This is the traditional way that worked since the very beginning of {quarkus-cxf Since {quarkus-cxf-project-name} 3.11.0, there is a new way to expose an endpoint under a specific path: the `@io.quarkiverse.cxf.annotation.CXFEndpoint` annotation. The path is set through its non-optional attribute `value` -and it is relative to `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-path[quarkus.cxf.path]` +and it is relative to `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.path]` much like when this is done via `application.properties`. Let's have a look at an example. diff --git a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc index 362680bb0..0133d4a9c 100644 --- a/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc +++ b/docs/modules/ROOT/pages/user-guide/advanced-soap-client-topics.adoc @@ -3,10 +3,10 @@ Check the following chapters for more details about implementing SOAP clients: -* xref:user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc#client-endpoint-url-defaults[`client-endpoint-url` defaults] -* xref:user-guide/advanced-client-topics/configure-multiple-clients.adoc#configure-multiple-clients[Configure multiple clients] -* xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc#cdi-scope-of-cxfclient[CDI scope of clients injected via `@CXFClient`] -* xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc#programmatic-client-configuration-at-startup[Configure clients programmatically at application startup] -* xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc#dynamic-client-configuration[Dynamic client configuration] -* xref:user-guide/advanced-client-topics/pure-client-applications.adoc#pure-client-applications[Pure client applications] -* xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc#prevent-resource-leaks[Prevent resource leaks] +* xref:user-guide/advanced-client-topics/client-endpoint-url-defaults.adoc[`client-endpoint-url` defaults] +* xref:user-guide/advanced-client-topics/configure-multiple-clients.adoc[Configure multiple clients] +* xref:user-guide/advanced-client-topics/cdi-scope-of-cxfclient.adoc[CDI scope of clients injected via `@CXFClient`] +* xref:user-guide/advanced-client-topics/programmatic-client-configuration-at-startup.adoc[Configure clients programmatically at application startup] +* xref:user-guide/advanced-client-topics/dynamic-client-configuration.adoc[Dynamic client configuration] +* xref:user-guide/advanced-client-topics/pure-client-applications.adoc[Pure client applications] +* xref:user-guide/advanced-client-topics/prevent-resource-leaks.adoc[Prevent resource leaks] diff --git a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc index 05f589b44..873212b65 100644 --- a/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc +++ b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc @@ -12,11 +12,11 @@ in the source tree of {quarkus-cxf-project-name}. You may want to use it as a ru == Client HTTP basic authentication Use the following client configuration options provided by -`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf[quarkus-cxf]` extension +`xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]` extension to pass the username and password for HTTP basic authentication: -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-username[quarkus.cxf.client."client-name".username]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-password[quarkus.cxf.client."client-name".password]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".username]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".password]` Here is an example: @@ -29,7 +29,7 @@ include::example$client-server/application.properties[tag=client-basic-auth] === Accessing WSDL protected by basic authentication By default, the clients created by {quarkus-cxf-project-name} do not send the `Authorization` header, -unless you set the `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-secure-wsdl-access[quarkus.cxf.client."client-name".secure-wsdl-access]` to `true`: +unless you set the `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".secure-wsdl-access]` to `true`: .application.properties [source,properties] @@ -39,7 +39,7 @@ include::example$client-server/application.properties[tag=client-basic-auth-wsdl == Mutual TLS (mTLS) authentication -See the xref:user-guide/ssl-tls-https.adoc#mtls[Mutual TLS (mTLS) authentication] section in SSL, TLS and HTTPS guide. +See the xref:user-guide/ssl-tls-https.adoc[Mutual TLS (mTLS) authentication] section in SSL, TLS and HTTPS guide. [[securing-service-endpoints]] == Securing service endpoints diff --git a/docs/modules/ROOT/pages/user-guide/configuration.adoc b/docs/modules/ROOT/pages/user-guide/configuration.adoc index e844b02ae..86bb91d0b 100644 --- a/docs/modules/ROOT/pages/user-guide/configuration.adoc +++ b/docs/modules/ROOT/pages/user-guide/configuration.adoc @@ -2,7 +2,7 @@ = Configuration {quarkus-cxf-project-name} exposes a large number of configuration options. -Each extension documents its options at the bottom of its xref:reference/index.adoc#reference-index[reference page]. +Each extension documents its options at the bottom of its xref:reference/index.adoc[reference page]. The configuration options can be set in `application.properties` file or via environment variables - see {link-quarkus-docs-base}/config-reference[Quarkus configuration reference] for details. @@ -11,7 +11,7 @@ The configuration options can be set in `application.properties` file or via env == Bean references Several configuration options of {quarkus-cxf-project-name} allow referring to beans present in Quarkus CDI container. -xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[Features and interceptors] are typical examples of those. +xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[Features and interceptors] are typical examples of those. There are two ways how to set a bean reference in the configuration: by type or by bean name. diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc index adb7c1acd..1ba4830e8 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first.adoc @@ -12,14 +12,14 @@ CXF provides the `wsdl2java` utility for that. {quarkus-cxf-project-name} wraps `wsdl2java` in the `quarkus-cxf` extension so you do not need to use it directly. -Follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate the Model classes from WSDL] section of the user guide +Follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate the Model classes from WSDL] section of the user guide for more details about how to use it. You may also want to check the CXF https://cxf.apache.org/docs/developing-a-consumer.html[Developing a Consumer] as a general introduction. == Contract first service -When implementing a service the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[generation of Java code from WSDL] +When implementing a service the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[generation of Java code from WSDL] may also come in handy. `wsdl2java` can generate the model classes (with JAXB annotations) and service interfaces (with JAX-WS annotations) for you. @@ -34,7 +34,7 @@ Another valid option at your disposal is to write your service in Java, using JA Then you have two options how to obtain the WSDL contract: 1. Start your service and point your clients at `+http://your-host/your-service?wsdl+` -2. xref:user-guide/contract-first-code-first.adoc#contract-first-code-first[Generate the WSDL document from Java] classes at build time +2. xref:user-guide/contract-first-code-first.adoc[Generate the WSDL document from Java] classes at build time [TIP] diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc index 36d8a29db..fb09aa853 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-java-from-wsdl.adoc @@ -27,7 +27,7 @@ include::example$calculator-client/pom.xml[tag=first-soap-client.adoc-quarkus-ma * Put your WSDL files under `src/main/resources` or `src/test/resources` or any subdirectory thereof. * Your WSDL file names must end with `.wsdl` * Set `quarkus.cxf.codegen.wsdl2java.includes` - xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-includes[configuration property] + xref:reference/extensions/quarkus-cxf.adoc[configuration property] to a pattern matching the WSDL files you wish to process. If you want to process all WSDL files under `src/main/resources/wsdl` or `src/test/resources/wsdl`, set it as follows: + @@ -49,7 +49,7 @@ from CXF under the hood. `wsdl2Java` is called separately for each WSDL file sel ==== Passing custom parameters to `wsdl2java` is possible through -xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[`quarkus.cxf.codegen.wsdl2java.additional-params`] +xref:reference/extensions/quarkus-cxf.adoc[`quarkus.cxf.codegen.wsdl2java.additional-params`] configuration parameter. If you need different `additional-params` for each WSDL file, you may want to define a separate named parameter set for @@ -69,7 +69,7 @@ quarkus.cxf.codegen.wsdl2java.bar-params.xjc = ts [TIP] ==== -Add `xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc#quarkus-cxf-xjc-plugins[io.quarkiverse.cxf:quarkus-cxf-xjc-plugins]` dependency to your project to be able to use +Add `xref:reference/extensions/quarkus-cxf-xjc-plugins.adoc[io.quarkiverse.cxf:quarkus-cxf-xjc-plugins]` dependency to your project to be able to use `-xjc-Xbg`, `-xjc-Xdv`, `-xjc-Xjavadoc`, `-xjc-Xproperty-listener`, `-xjc-Xts` and `-xjc-Xwsdlextension` wsdl2java parameters. ==== diff --git a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc index 66803e94b..43821fb48 100644 --- a/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc +++ b/docs/modules/ROOT/pages/user-guide/contract-first-code-first/generate-wsdl-from-java.adoc @@ -49,4 +49,4 @@ for `java2ws`. == See also -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-java2ws-enabled[quarkus.cxf.java2ws.*]` configuration properties of `quarkus-cxf` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.java2ws.*]` configuration properties of `quarkus-cxf` diff --git a/docs/modules/ROOT/pages/user-guide/create-project.adoc b/docs/modules/ROOT/pages/user-guide/create-project.adoc index d64239454..4efcd465d 100644 --- a/docs/modules/ROOT/pages/user-guide/create-project.adoc +++ b/docs/modules/ROOT/pages/user-guide/create-project.adoc @@ -87,6 +87,6 @@ That's the most reliable way to get compatible versions of Quarkus, CXF, {quarku We recommend to proceed with any of the following chapters: -* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] +* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc index 5ee40c42a..35ff231e1 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-client.adoc @@ -6,7 +6,7 @@ In this guide we explain how to create a simple Quarkus application acting as a [NOTE] .Create project first ==== -Follow the xref:user-guide/create-project.adoc#create-project[Project creation] guide before proceeding here. +Follow the xref:user-guide/create-project.adoc[Project creation] guide before proceeding here. ==== == Remote Web service for testing @@ -109,7 +109,7 @@ The last option tends to be the easiest and most flexible for client application [TIP] ==== -If you want to use this approach, first follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc#generate-java-from-wsdl[Generate Java from WSDL] section and then continue with the next steps. +If you want to use this approach, first follow the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[Generate Java from WSDL] section and then continue with the next steps. ==== == Using SEI as a client @@ -141,7 +141,7 @@ include::example$calculator-client/application.properties[tag=first-soap-client. [TIP] ==== -All client configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[Configuration properties] reference. +All client configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc[Configuration properties] reference. ==== With all the above files in place, we should be able to start the application in Quarkus {link-quarkus-docs-base}/maven-tooling#dev-mode[`dev` mode] @@ -167,5 +167,5 @@ where `11` is the correct result of adding `5` and `6`. You may want to proceed with -* xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[Package for JVM and native]. -* xref:user-guide/advanced-soap-client-topics.adoc#advanced-soap-client-topics[Advanced client topics] +* xref:user-guide/package-for-jvm-and-native.adoc[Package for JVM and native]. +* xref:user-guide/advanced-soap-client-topics.adoc[Advanced client topics] diff --git a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc index 172bba6c2..e2bf9bb04 100644 --- a/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc +++ b/docs/modules/ROOT/pages/user-guide/first-soap-web-service.adoc @@ -6,7 +6,7 @@ In this guide we explain how to create a Quarkus application exposing a simple S [NOTE] .Create project first ==== -Follow the xref:user-guide/create-project.adoc#create-project[Project creation] guide before proceeding here. +Follow the xref:user-guide/create-project.adoc[Project creation] guide before proceeding here. ==== == Hello world! Web service @@ -47,12 +47,12 @@ include::example$soap-service/application.properties[tag=first-web-service.adoc] [TIP] ==== -All configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf-configuration[Configuration properties] reference. +All configuration properties are documented in the xref:reference/extensions/quarkus-cxf.adoc[Configuration properties] reference. ==== [TIP] ==== -Check the xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc#endpoints-and-paths[Service endpoints and paths] chapter +Check the xref:user-guide/advanced-service-topics/endpoints-and-paths.adoc[Service endpoints and paths] chapter to learn about alternative ways to expose a service endpoint under a specific path. ==== @@ -209,4 +209,4 @@ After that you can send a new SOAP request and see some SOAP payloads in the app == Further steps -You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[packaging your application for running on a JVM or natively]. +You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc[packaging your application for running on a JVM or natively]. diff --git a/docs/modules/ROOT/pages/user-guide/index.adoc b/docs/modules/ROOT/pages/user-guide/index.adoc index f5231b7ef..82daf4cf5 100644 --- a/docs/modules/ROOT/pages/user-guide/index.adoc +++ b/docs/modules/ROOT/pages/user-guide/index.adoc @@ -5,6 +5,6 @@ This User guide explains typical use cases of {quarkus-cxf-project-name}. You may want to start with some of the following topics: -* xref:user-guide/create-project.adoc#create-project[Create a new project] -* xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[Your first SOAP Web service] -* xref:user-guide/first-soap-client.adoc#first-soap-client[Your first SOAP Client] +* xref:user-guide/create-project.adoc[Create a new project] +* xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] +* xref:user-guide/first-soap-client.adoc[Your first SOAP Client] diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc index 2dc924b05..4254ec7b0 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers.adoc @@ -3,5 +3,5 @@ Check the following chapters to learn a bout various ways to customize the processing of SOAP requests and responses: -* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc#cxf-interceptors-and-features[CXF Interceptors and Features] -* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc#jax-ws-handlers[JAX-WS Handlers] +* xref:user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc[CXF Interceptors and Features] +* xref:user-guide/interceptors-features-handlers/jax-ws-handlers.adoc[JAX-WS Handlers] diff --git a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc index 16d3e3a66..bf4e62b20 100644 --- a/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc +++ b/docs/modules/ROOT/pages/user-guide/interceptors-features-handlers/cxf-interceptors-and-features.adoc @@ -39,7 +39,7 @@ quarkus.cxf.endpoint."/greeting-service".out-fault-interceptors=org.acme.Test1In ==== Both feature and interceptor classes are loaded via CDI first. They can be referenced by fully a qualified class name -or by a xref:user-guide/configuration.adoc#beanRefs[bean name]. +or by a xref:user-guide/configuration.adoc[bean name]. If no CDI beans are available, the constructor without parameters will be invoked to instantiate each class. ==== diff --git a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc index 99669f42d..5c6777874 100644 --- a/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc +++ b/docs/modules/ROOT/pages/user-guide/package-for-jvm-and-native.adoc @@ -72,7 +72,7 @@ contains the `native` profile needed for building the native image: ---- -Further, as mentioned in the xref:user-guide/create-project.adoc#create-project[] section, you need the GraalVM `native-image` tool. +Further, as mentioned in the xref:user-guide/create-project.adoc[] section, you need the GraalVM `native-image` tool. You should either have it installed locally and have `GRAALVM_HOME` environment variable set properly, diff --git a/docs/modules/ROOT/pages/user-guide/payload-logging.adoc b/docs/modules/ROOT/pages/user-guide/payload-logging.adoc index 6e1307216..e01677015 100644 --- a/docs/modules/ROOT/pages/user-guide/payload-logging.adoc +++ b/docs/modules/ROOT/pages/user-guide/payload-logging.adoc @@ -47,7 +47,7 @@ quarkus.cxf.logging.enabled-for = both quarkus.cxf.logging.pretty = true ---- -All logging configuration options are listed on `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-logging-enabled-for[quarkus-cxf]` reference page. +All logging configuration options are listed on `xref:reference/extensions/quarkus-cxf.adoc[quarkus-cxf]` reference page. [TIP] ==== @@ -76,8 +76,8 @@ quarkus.cxf.client.hello.logging.pretty = true All logging configuration options are documented on `quarkus-cxf` reference page: -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-logging-enabled[For clients] -* xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-enabled[For service endpoints] +* xref:reference/extensions/quarkus-cxf.adoc[For clients] +* xref:reference/extensions/quarkus-cxf.adoc[For service endpoints] == Alternative ways of adding a `LoggingFeature` to a client or service @@ -95,7 +95,7 @@ quarkus.cxf.client."myClient".features = org.apache.cxf.ext.logging.LoggingFeatu + [TIP] ==== -There is an example in xref:user-guide/first-soap-web-service.adoc#logging-feature[Your first SOAP Web service] chapter of the User guide. +There is an example in xref:user-guide/first-soap-web-service.adoc[Your first SOAP Web service] chapter of the User guide. ==== + or alternatively diff --git a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc index ff5718c32..8e67684f9 100644 --- a/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc +++ b/docs/modules/ROOT/pages/user-guide/soap-payloads-with-jaxb.adoc @@ -1,8 +1,8 @@ [[soap-payloads-with-jaxb]] = Complex SOAP payloads with JAXB -Our introductory guides for Quarkus xref:user-guide/first-soap-client.adoc#first-soap-client[SOAP client] -and xref:user-guide/first-soap-web-service.adoc#first-soap-web-service[SOAP service] dealt with services +Our introductory guides for Quarkus xref:user-guide/first-soap-client.adoc[SOAP client] +and xref:user-guide/first-soap-web-service.adoc[SOAP service] dealt with services having only primitive parameters and return values such as integers and strings. Let's have a look at passing and receiving more complex objects. @@ -150,4 +150,4 @@ We can see `Orange` having been added in the returned list as expected. == Further steps -You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc#package-for-jvm-and-native[packaging your application for running on a JVM or natively]. +You may want to proceed with xref:user-guide/package-for-jvm-and-native.adoc[packaging your application for running on a JVM or natively]. diff --git a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc index ae80769f9..e81b3b20d 100644 --- a/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc +++ b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc @@ -30,9 +30,9 @@ Once you have prepared the trust store, you need to configure your client to use This is the easiest way to set the client trust store. The key role is played by the following properties: -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store[quarkus.cxf.client."client-name".trust-store]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-type[quarkus.cxf.client."client-name".trust-store-type]` -* `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-trust-store-password[quarkus.cxf.client."client-name".trust-store-password]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store-type]` +* `xref:reference/extensions/quarkus-cxf.adoc[quarkus.cxf.client."client-name".trust-store-password]` Here is an example: @@ -98,7 +98,7 @@ include::example$mtls/application.properties[tag=mtls] The requirement for the clients to connect through HTTPS can be defined in a policy. -The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security[quarkus-cxf-rt-ws-security]` extension. +The functionality is provided by `xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[quarkus-cxf-rt-ws-security]` extension. Here is an example of a policy file: From d5304bce285acf4884f335eb3790ab9f79c172b0 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Tue, 3 Dec 2024 19:06:05 +0100 Subject: [PATCH 29/31] IMPORTANT admonition --- .../runtime/src/main/doc/intro.adoc | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/extensions/integration-tracing-opentelemetry/runtime/src/main/doc/intro.adoc b/extensions/integration-tracing-opentelemetry/runtime/src/main/doc/intro.adoc index 66db513ec..4d14b597f 100644 --- a/extensions/integration-tracing-opentelemetry/runtime/src/main/doc/intro.adoc +++ b/extensions/integration-tracing-opentelemetry/runtime/src/main/doc/intro.adoc @@ -1,5 +1,8 @@ Generate https://opentelemetry.io/[OpenTelemetry] https://opentelemetry.io/docs/concepts/signals/traces/[traces]. -IMPORTANT: OpenTelemetry Metrics and Logging are not supported yet on neither Quarkus nor CXF side, - hence {quarkus-cxf-project-name} cannot support them either. Tracing is thus - the only OpenTelemetry feature supported by this extension. +[IMPORTANT] +==== +OpenTelemetry Metrics and Logging are not supported yet on neither Quarkus nor CXF side, +hence {quarkus-cxf-project-name} cannot support them either. Tracing is thus +the only OpenTelemetry feature supported by this extension. +==== \ No newline at end of file From 53e3cb3a918f00ee1e0828dd626b32bce202e41c Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Tue, 3 Dec 2024 19:10:18 +0100 Subject: [PATCH 30/31] IMPORTANT admonition --- .../features-metrics/runtime/src/main/doc/intro.adoc | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/extensions/features-metrics/runtime/src/main/doc/intro.adoc b/extensions/features-metrics/runtime/src/main/doc/intro.adoc index 4f78cc0da..26106b030 100644 --- a/extensions/features-metrics/runtime/src/main/doc/intro.adoc +++ b/extensions/features-metrics/runtime/src/main/doc/intro.adoc @@ -1,5 +1,8 @@ Collect metrics using https://micrometer.io/[Micrometer]. -IMPORTANT: Unlike https://cxf.apache.org/docs/metrics.html[CXF Metrics feature], - this {quarkus-cxf-project-name} extension does not support https://cxf.apache.org/docs/dropwizard-metrics.html[Dropwizard Metrics]. - Only Micrometer is supported. +[IMPORTANT] +==== +Unlike https://cxf.apache.org/docs/metrics.html[CXF Metrics feature], +this {quarkus-cxf-project-name} extension does not support https://cxf.apache.org/docs/dropwizard-metrics.html[Dropwizard Metrics]. +Only Micrometer is supported. +==== From 2b1f49969fc279b1b4acb94a67dd3cd5d6325b80 Mon Sep 17 00:00:00 2001 From: Andreas Jonsson Date: Tue, 3 Dec 2024 19:12:11 +0100 Subject: [PATCH 31/31] Documentation style guide rules: Don't use "Please" "Make sure" > "Ensure" --- .../java/io/quarkiverse/cxf/deployment/Java2WsdlProcessor.java | 2 +- .../io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGen.java | 2 +- .../cxf/deployment/codegen/Wsdl2JavaCodeGenTest.java | 2 +- .../cxf/deployment/java2ws/IncludesConflictJava2WsTest.java | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/Java2WsdlProcessor.java b/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/Java2WsdlProcessor.java index 1572df02c..37ed9e0fd 100644 --- a/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/Java2WsdlProcessor.java +++ b/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/Java2WsdlProcessor.java @@ -128,7 +128,7 @@ static void java2wsdl( throw new IllegalStateException("Service class " + serviceClass + " was already selected by\n\n" + oldSelectors + "\n\nand therefore it cannot once again be selected by\n\n" + selectors - + "\n\nPlease make sure that the individual include/exclude sets are mutually exclusive."); + + "\n\nEnsure that the individual include/exclude sets are mutually exclusive."); } processedClasses.put(serviceClass.toString(), selectors); diff --git a/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGen.java b/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGen.java index df53e961b..a4811b7f7 100644 --- a/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGen.java +++ b/extensions/core/deployment/src/main/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGen.java @@ -154,7 +154,7 @@ public static boolean scan( throw new IllegalStateException("WSDL file " + wsdlFile + " was already selected by\n\n" + oldSelectors + "\n\nand therefore it cannot once again be selected by\n\n" + selectors - + "\n\nPlease make sure that the individual include/exclude sets are mutually exclusive."); + + "\n\nEnsure that the individual include/exclude sets are mutually exclusive."); } processedFiles.put(wsdlFile.toString(), selectors); wsdlFileConsumer.accept(wsdlFile); diff --git a/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGenTest.java b/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGenTest.java index 83c0dc756..17ab3bd09 100644 --- a/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGenTest.java +++ b/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/codegen/Wsdl2JavaCodeGenTest.java @@ -124,7 +124,7 @@ void scanOverlappingSelections() throws IOException { io.quarkiverse.cxf.deployment.codegen.Wsdl2JavaCodeGen.WSDL2JAVA_CONFIG_KEY_PREFIX + ".my-name", files, foundFiles::add)) - .withMessageContaining("Please make sure that the individual include/exclude sets are mutually exclusive"); + .withMessageContaining("Ensure that the individual include/exclude sets are mutually exclusive"); } diff --git a/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/java2ws/IncludesConflictJava2WsTest.java b/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/java2ws/IncludesConflictJava2WsTest.java index b6d4f5ef3..98be46668 100644 --- a/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/java2ws/IncludesConflictJava2WsTest.java +++ b/extensions/core/deployment/src/test/java/io/quarkiverse/cxf/deployment/java2ws/IncludesConflictJava2WsTest.java @@ -37,7 +37,7 @@ public class IncludesConflictJava2WsTest { .overrideConfigKey("quarkus.cxf.java2ws.group_02.wsdl-name-template", "%TARGET_DIR%/" + TEST_DIR + "/%SIMPLE_CLASS_NAME%.wsdl") .assertException(t -> Assertions.assertThat(t).isInstanceOf(IllegalStateException.class) - .hasMessageContaining("Please make sure that the individual include/exclude sets are mutually exclusive")); + .hasMessageContaining("Ensure that the individual include/exclude sets are mutually exclusive")); @Test public void generationTest() throws IOException {