Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 3.8.0 release notes #1240

Merged
merged 1 commit into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@
** xref:user-guide/examples.adoc[Examples]
** xref:user-guide/common-problems-troubleshooting.adoc[Common problems and troubleshooting]
** xref:user-guide/camel-integration.adoc[Camel Integration]
* xref:release-notes/index.adoc[Release notes]
** xref:release-notes/3.8.0.adoc[3.8.0 LTS]
* xref:contributor-guide/index.adoc[Contributor guide]
** xref:contributor-guide/releasing.adoc[Releasing]
* xref:reference/index.adoc[Reference]
// extensions: START
** xref:reference/extensions/quarkus-cxf.adoc[Quarkus CXF]
** xref:reference/extensions/quarkus-cxf-rt-features-logging.adoc[Logging Feature]
** xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Metrics Feature]
** xref:reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc[OpenTelemetry]
** xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security]
Expand All @@ -31,5 +34,3 @@
** 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
* xref:contributor-guide/index.adoc[Contributor guide]
** xref:contributor-guide/releasing.adoc[Releasing]

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ To workaround the fact that `org.apache.cxf.ws.security.trust.STSClient` does no
Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)] extension page for more information about WS-Trust.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-wsdl]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-wsdl[quarkus.cxf.client."clients".security.sts.client.wsdl]`
.<| `string`
Expand All @@ -851,7 +851,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
3+a|A URL, resource path or local filesystem path pointing to a WSDL document to use when generating the service proxy of the STS client.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_WSDL+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-service-name]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-service-name[quarkus.cxf.client."clients".security.sts.client.service-name]`
.<| `string`
Expand All @@ -864,7 +864,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
- WS-Trust 1.4: `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200802/++}++SecurityTokenService`

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SERVICE_NAME+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-endpoint-name]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-endpoint-name[quarkus.cxf.client."clients".security.sts.client.endpoint-name]`
.<| `string`
Expand All @@ -877,7 +877,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
- `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200512/++}++UT_Port`

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENDPOINT_NAME+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-username]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-username[quarkus.cxf.client."clients".security.sts.client.username]`
.<| `string`
Expand All @@ -890,7 +890,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
- As the alias name in the keystore to get the user's public key for encryption if `encryption.username` is not set

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_USERNAME+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-password]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-password[quarkus.cxf.client."clients".security.sts.client.password]`
.<| `string`
Expand All @@ -899,7 +899,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
3+a|The password associated with the `username`.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_PASSWORD+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-username]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-username[quarkus.cxf.client."clients".security.sts.client.encryption.username]`
.<| `string`
Expand All @@ -910,7 +910,7 @@ Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)]
For the WS-Security web service provider, the `useReqSigCert` value can be used to accept (encrypt to) any client whose public key is in the service's truststore (defined in `encrypt.properties`).

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_USERNAME+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-properties]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-properties[quarkus.cxf.client."clients".security.sts.client.encryption.properties]`
.<| ``Map<String,String>``
Expand All @@ -927,7 +927,7 @@ Example
```

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_PROPERTIES+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-crypto]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-encryption-crypto[quarkus.cxf.client."clients".security.sts.client.encryption.crypto]`
.<| `string`
Expand All @@ -936,7 +936,7 @@ Example
3+a|A link:../../user-guide/configuration.html#beanRefs[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__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_CRYPTO+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-crypto]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-crypto[quarkus.cxf.client."clients".security.sts.client.token.crypto]`
.<| `string`
Expand All @@ -949,7 +949,7 @@ WCF's trust server sometimes will encrypt the token in the response IN ADDITION
These are also used by the `token.properties` to send/process any RSA/DSAKeyValue tokens used if the KeyType is `PublicKey`

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_CRYPTO+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-properties]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-properties[quarkus.cxf.client."clients".security.sts.client.token.properties]`
.<| ``Map<String,String>``
Expand All @@ -966,7 +966,7 @@ Example
```

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_PROPERTIES+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-username]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-username[quarkus.cxf.client."clients".security.sts.client.token.username]`
.<| `string`
Expand All @@ -975,7 +975,7 @@ Example
3+a|The alias name in the keystore to get the user's public key to send to the STS for the PublicKey KeyType case.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USERNAME+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-usecert]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-token-usecert[quarkus.cxf.client."clients".security.sts.client.token.usecert]`
.<| `boolean`
Expand All @@ -984,7 +984,7 @@ Example
3+a|Whether to write out an X509Certificate structure in UseKey/KeyInfo, or whether to write out a KeyValue structure.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USECERT+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-soap12-binding]]`link:#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client-soap12-binding[quarkus.cxf.client."clients".security.sts.client.soap12-binding]`
.<| `boolean`
Expand All @@ -993,7 +993,7 @@ Example
3+a|If `true` the STS client will be set to send Soap 1.2 messages; otherwise it will send SOAP 1.1 messages.

*Environment variable*: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SOAP12_BINDING+++` +
*Since Quarkus CXF*: 2.8.0
*Since Quarkus CXF*: 3.8.0

.<| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-security-username]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-security-username[quarkus.cxf.endpoint."endpoints".security.username]`
.<| `string`
Expand Down
6 changes: 0 additions & 6 deletions docs/modules/ROOT/pages/reference/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ Please follow the links under the extension names to learn about how to use them
|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-logging.adoc[Quarkus CXF Logging Feature] +
`quarkus-cxf-rt-features-logging`
|Stable
|0.14.0
|

| xref:reference/extensions/quarkus-cxf-rt-features-metrics.adoc[Quarkus CXF Metrics Feature] +
`quarkus-cxf-rt-features-metrics`
|Stable
Expand Down
46 changes: 46 additions & 0 deletions docs/modules/ROOT/pages/release-notes/3.8.0.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
= {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 WS-SecurityPolicy
* New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-clients-security-sts-client[STSClient]
* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page]
* New example

== Full changelog

https://github.com/quarkiverse/quarkus-cxf/compare/3.8.0...2.7.0
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/release-notes/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Migration guides

We strive to maintain backward compatibility but we may on occasion include a breaking change in the interest of the long-term evolution of the project.

Listed here are guides on how to migrate between major versions and anything of significance to watch for when upgrading from minor versions.

13 changes: 0 additions & 13 deletions extensions/features-logging/runtime/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,6 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.l2x6.cq</groupId>
<artifactId>cq-maven-plugin</artifactId>
<executions>
<execution>
<id>update-doc-page</id>
<goals>
<goal>update-doc-page</goal>
</goals>
<phase>process-classes</phase>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ artifact: ${project.groupId}:${project.artifactId}:${project.version}
name: "Quarkus CXF Logging (deprecated)"
description: "Deprecated, use io.quarkiverse.cxf:quarkus-cxf instead"
metadata:
unlisted: true
keywords:
- "cxf"
- "jaxws"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
artifact: ${project.groupId}:${project.artifactId}:${project.version}
name: Santuario XML Security
description: "Native support for Apache Santuario xmlsec library"
description: "Native support for Apache Santuario XML Security"
metadata:
keywords:
- santuario
Expand All @@ -10,4 +10,4 @@ metadata:
# guide: ...
categories:
- "miscellaneous"
status: "preview"
status: "stable"
Loading