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/nav.adoc b/docs/modules/ROOT/nav.adoc index b38894467..f92c2629b 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] @@ -27,44 +28,54 @@ *** 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.adoc[SSL, TLS and HTTPS] -** xref:user-guide/auth.adoc[Authentication and authorization] -** xref:security-guide/ws-securitypolicy-auth.adoc[WS-SecurityPolicy Authentication] +** 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[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 * 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] @@ -74,4 +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 +// extensions: END \ No newline at end of file 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..04a08fd27 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,15 +1,17 @@ -[[cxf-extension-for-quarkus]] +[[quarkus-cxf-index]] = {quarkus-cxf-project-name} This project aims at porting http://cxf.apache.org/[Apache CXF] to https://quarkus.io/[Quarkus] runtime 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] 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 f941988ae..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 @@ -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 @@ -37,7 +39,7 @@ ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== Check the xref:user-guide/index.adoc[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +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 a038a5016..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 @@ -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 @@ -37,7 +39,7 @@ ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== Check the xref:user-guide/index.adoc[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -149,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 e1f9c339b..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 @@ -33,7 +33,7 @@ ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== Check the xref:user-guide/index.adoc[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +xref:user-guide/create-project.adoc[Dependency management] section for more information about writing applications with {quarkus-cxf-project-name}. ==== endif::[] @@ -68,7 +68,7 @@ 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] -through its xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[additional-params] property: +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 2f902392d..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 @@ -36,7 +36,7 @@ ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== Check the xref:user-guide/index.adoc[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +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 6e460b267..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 @@ -38,7 +38,7 @@ ifeval::[{doc-show-user-guide-link} == true] [TIP] ==== Check the xref:user-guide/index.adoc[User guide] and especially its -xref:user-guide/create-project.adoc#dependency-management[Dependency management] section +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 @@ -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] ---- ---- + -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/3.8.2.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc similarity index 97% rename from docs/modules/ROOT/pages/release-notes/3.8.2.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc index 2177e55b2..9d3848fdb 100644 --- a/docs/modules/ROOT/pages/release-notes/3.8.2.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-2.adoc @@ -1,3 +1,4 @@ +[[rn-3-8-2]] = {quarkus-cxf-project-name} 3.8.2 (LTS) release notes == Important dependency upgrades: @@ -20,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/3.8.3.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc similarity index 95% rename from docs/modules/ROOT/pages/release-notes/3.8.3.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc index a54b9e4af..e62bf708e 100644 --- a/docs/modules/ROOT/pages/release-notes/3.8.3.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-3.adoc @@ -1,3 +1,4 @@ +[[rn-3-8-3]] = {quarkus-cxf-project-name} 3.8.3 (LTS) release notes == New and noteworthy in {quarkus-cxf-project-name} diff --git a/docs/modules/ROOT/pages/release-notes/3.8.4.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc similarity index 99% rename from docs/modules/ROOT/pages/release-notes/3.8.4.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc index c69dea59e..082782aa4 100644 --- a/docs/modules/ROOT/pages/release-notes/3.8.4.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-4.adoc @@ -1,3 +1,4 @@ +[[rn-3-8-4]] = {quarkus-cxf-project-name} 3.8.4 (LTS) release notes == Important dependency upgrades: diff --git a/docs/modules/ROOT/pages/release-notes/3.8.5.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc similarity index 97% rename from docs/modules/ROOT/pages/release-notes/3.8.5.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc index 247ff98c1..b2d2214ca 100644 --- a/docs/modules/ROOT/pages/release-notes/3.8.5.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-5.adoc @@ -1,3 +1,4 @@ +[[rn-3-8-5]] = {quarkus-cxf-project-name} 3.8.5 (LTS) release notes == Important dependency upgrades: diff --git a/docs/modules/ROOT/pages/release-notes/3.8.6.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc similarity index 91% rename from docs/modules/ROOT/pages/release-notes/3.8.6.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc index 63b14c196..ad035fe88 100644 --- a/docs/modules/ROOT/pages/release-notes/3.8.6.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-8-6.adoc @@ -1,3 +1,4 @@ +[[rn-3-8-6]] = {quarkus-cxf-project-name} 3.8.6 (LTS) release notes == Important dependency upgrades: @@ -10,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/3.9.0.adoc b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc similarity index 81% rename from docs/modules/ROOT/pages/release-notes/3.9.0.adoc rename to docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc index 835dccb40..1a89330f4 100644 --- a/docs/modules/ROOT/pages/release-notes/3.9.0.adoc +++ b/docs/modules/ROOT/pages/release-notes/rn-3-9-0.adoc @@ -1,3 +1,4 @@ +[[rn-3-9-0]] = {quarkus-cxf-project-name} 3.9.0 release notes == Important dependency upgrades @@ -19,8 +20,8 @@ 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. -* 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. +* 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 af25d4f8e..5ae72dd01 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 @@ -7,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: diff --git a/docs/modules/ROOT/pages/security-guide/index.adoc b/docs/modules/ROOT/pages/security-guide/index.adoc index c4d34fc44..05e3171ac 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}: +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-authentication-authorization.adoc similarity index 94% 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 index 356c39595..ad616241c 100644 --- a/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-auth.adoc +++ b/docs/modules/ROOT/pages/security-guide/ws-securitypolicy-authentication-authorization.adoc @@ -1,8 +1,8 @@ -[[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.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[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 9ee7aa75a..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 @@ -1,11 +1,12 @@ +[[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. 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[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/endpoints-and-paths.adoc b/docs/modules/ROOT/pages/user-guide/advanced-service-topics/endpoints-and-paths.adoc index d1d6c0df6..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 @@ -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-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..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 @@ -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 @@ -11,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/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/authentication-authorization.adoc similarity index 79% rename from docs/modules/ROOT/pages/user-guide/auth.adoc rename to docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc index f23e91dba..873212b65 100644 --- a/docs/modules/ROOT/pages/user-guide/auth.adoc +++ b/docs/modules/ROOT/pages/user-guide/authentication-authorization.adoc @@ -8,14 +8,15 @@ 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 `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: @@ -28,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] @@ -38,8 +39,9 @@ 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. +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 The server-side authentication and authorization is driven by {link-quarkus-docs-base}/security-overview[Quarkus Security], diff --git a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc index 02f31c00b..99ea00c93 100644 --- a/docs/modules/ROOT/pages/user-guide/camel-integration.adoc +++ b/docs/modules/ROOT/pages/user-guide/camel-integration.adoc @@ -1,7 +1,8 @@ +[[camel-integration]] = Camel Integration {link-camel-quarkus-docs-index}[Camel Quarkus] supports CXF since its version 2.12.0. 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/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..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 @@ -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. @@ -26,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: + @@ -41,11 +42,14 @@ 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`] +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 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..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 @@ -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 @@ -28,21 +29,24 @@ 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 -* `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 86795e36c..4efcd465d 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-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. @@ -15,12 +16,12 @@ 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}]. -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. 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..35ff231e1 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. @@ -140,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[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 2388883f2..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 @@ -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. @@ -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[Configuration properties] reference. ==== [TIP] 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..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 @@ -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. @@ -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/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..e01677015 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 @@ -46,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] ==== @@ -75,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 @@ -94,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 af3cc9478..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,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] @@ -7,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: diff --git a/docs/modules/ROOT/pages/user-guide/ssl.adoc b/docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc similarity index 86% rename from docs/modules/ROOT/pages/user-guide/ssl.adoc rename to docs/modules/ROOT/pages/user-guide/ssl-tls-https.adoc index e8a75aee7..e81b3b20d 100644 --- a/docs/modules/ROOT/pages/user-guide/ssl.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} ==== @@ -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: @@ -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. 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 { 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. +==== 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