This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 56ed0fbfc3b6 CAMEL-27225: Upgrade guide notes for 4.22.3 and 4.18.6 -
camel-redis RedisAggregationRepository (#30395)
56ed0fbfc3b6 is described below
commit 56ed0fbfc3b642f9553e4b783673a59e5fc96840
Author: Claus Ibsen <[email protected]>
AuthorDate: Thu Nov 19 12:19:33 2026 +0100
CAMEL-27225: Upgrade guide notes for 4.22.3 and 4.18.6 - camel-redis
RedisAggregationRepository (#30395)
The upgrade notes of the camel-4.22.x and camel-4.18.x backports of
CAMEL-27225 (#30393, #30394).
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../ROOT/pages/camel-4x-upgrade-guide-4_18.adoc | 34 ++++++++++++++++++++++
.../ROOT/pages/camel-4x-upgrade-guide-4_22.adoc | 34 ++++++++++++++++++++++
2 files changed, 68 insertions(+)
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
index c0a2d800a605..f718f387ec3b 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
@@ -1036,6 +1036,40 @@ that header, and says when `operationName` is set, in
place of `Cannot find meth
no longer sends it as an HTTP header, with either client API. The
`SimpleConsumer` binding no longer returns it as a
response header.
+=== camel-redis - RedisAggregationRepository stores exchanges in Java
serialization, read through a deserialization filter
+
+`RedisAggregationRepository` now stores the exchanges in its Redis hashes as
Java serialization, with the correlation
+key (or the exchange id) as a plain string field, and reads them back through
an `ObjectInputFilter`. Before, the
+fields and values were encoded with the codec of the Redisson client, by
default the Redisson `Kryo5Codec`. The codec
+of a `RedissonClient` given with the `redisson` option is no longer used for
these hashes.
+
+The new option `deserializationFilter` sets the filter pattern, in the syntax
of the `jdk.serialFilter` system
+property. When it is not set, the JVM-wide `jdk.serialFilter` applies if it is
set, otherwise the default filter
+`!java.net.**;java.**;javax.**;org.apache.camel.**;maxdepth=20;maxrefs=10000;maxbytes=10485760;!*`.
It allows the
+`java`, `javax` and `org.apache.camel` packages, except `java.net`, and
rejects the other classes. It also limits the
+size of a stored exchange: `maxdepth=20` (the depth of the object graph),
`maxrefs=10000` (the number of objects in it)
+and `maxbytes=10485760` (10 MB). Before, there was no such limit. An exchange
over a limit cannot be read back, and its
+aggregation does not complete, for example a `List` body that collects more
than 10000 strings, or a body of more than
+10 MB. If the bodies or headers are instances of your own classes, or are
larger, set `deserializationFilter`. It
+replaces the whole default pattern, so keep its other parts, for example
+`!java.net.**;com.foo.model.**;java.**;javax.**;org.apache.camel.**;maxdepth=50;maxrefs=1000000;maxbytes=104857600;!*`,
+or leave out the `maxdepth`, `maxrefs` and `maxbytes` parts to have no limits.
The objects that a body or header value
+refers to must be `java.io.Serializable`.
+
+A completed exchange that cannot be read back is skipped by the recovery, with
a WARN that gives its exchange id, so
+the recovery of the other completed exchanges goes on.
+
+The exchanges stored by Camel 4.18.5 and older are not read: they stay in
Redis, but these aggregations do not complete
+and these completed exchanges are not recovered. When the repository starts,
it checks the first 100 entries of each
+of its hashes and logs a WARN with the number of such entries among them.
Complete the aggregations in progress, and
+let the recovery of the completed exchanges finish, before upgrading.
Otherwise, remove the hashes of the repository
+(`mapName` and the persistence map, by default `mapName` with the suffix
`-completed`) from Redis.
+
+To upgrade without draining, set the new `codec` option to `new
org.redisson.codec.Kryo5Codec()`. The repository
+then reads and writes the entries in the same format as the older versions,
and the `deserializationFilter` option and
+the WARN at startup do not apply. Once the old aggregations have completed and
been recovered, remove the `codec` option
+to switch to the Java serialization read through the filter.
+
== Upgrading from 4.18.4 to 4.18.5
=== camel-azure-eventhubs
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_22.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_22.adoc
index e4b6f396b279..bd034ebba88b 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_22.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_22.adoc
@@ -992,6 +992,40 @@ The failure no longer reaches the error handler of the
route (such as an `onExce
unless `bridgeErrorHandler=true`. With `pollOnError=STOP`, the consumer now
reconnects in this case instead of
stopping.
+=== camel-redis - RedisAggregationRepository stores exchanges in Java
serialization, read through a deserialization filter
+
+`RedisAggregationRepository` now stores the exchanges in its Redis hashes as
Java serialization, with the correlation
+key (or the exchange id) as a plain string field, and reads them back through
an `ObjectInputFilter`. Before, the
+fields and values were encoded with the codec of the Redisson client, by
default the Redisson `Kryo5Codec`. The codec
+of a `RedissonClient` given with the `redisson` option is no longer used for
these hashes.
+
+The new option `deserializationFilter` sets the filter pattern, in the syntax
of the `jdk.serialFilter` system
+property. When it is not set, the JVM-wide `jdk.serialFilter` applies if it is
set, otherwise the default filter
+`!java.net.**;java.**;javax.**;org.apache.camel.**;maxdepth=20;maxrefs=10000;maxbytes=10485760;!*`.
It allows the
+`java`, `javax` and `org.apache.camel` packages, except `java.net`, and
rejects the other classes. It also limits the
+size of a stored exchange: `maxdepth=20` (the depth of the object graph),
`maxrefs=10000` (the number of objects in it)
+and `maxbytes=10485760` (10 MB). Before, there was no such limit. An exchange
over a limit cannot be read back, and its
+aggregation does not complete, for example a `List` body that collects more
than 10000 strings, or a body of more than
+10 MB. If the bodies or headers are instances of your own classes, or are
larger, set `deserializationFilter`. It
+replaces the whole default pattern, so keep its other parts, for example
+`!java.net.**;com.foo.model.**;java.**;javax.**;org.apache.camel.**;maxdepth=50;maxrefs=1000000;maxbytes=104857600;!*`,
+or leave out the `maxdepth`, `maxrefs` and `maxbytes` parts to have no limits.
The objects that a body or header value
+refers to must be `java.io.Serializable`.
+
+A completed exchange that cannot be read back is skipped by the recovery, with
a WARN that gives its exchange id, so
+the recovery of the other completed exchanges goes on.
+
+The exchanges stored by Camel 4.22.2 and older are not read: they stay in
Redis, but these aggregations do not complete
+and these completed exchanges are not recovered. When the repository starts,
it checks the first 100 entries of each
+of its hashes and logs a WARN with the number of such entries among them.
Complete the aggregations in progress, and
+let the recovery of the completed exchanges finish, before upgrading.
Otherwise, remove the hashes of the repository
+(`mapName` and the persistence map, by default `mapName` with the suffix
`-completed`) from Redis.
+
+To upgrade without draining, set the new `codec` option (flagged
`insecure:serialization`) to `new org.redisson.codec.Kryo5Codec()`. The
repository
+then reads and writes the entries in the same format as the older versions,
and the `deserializationFilter` option and
+the WARN at startup do not apply. Once the old aggregations have completed and
been recovered, remove the `codec` option
+to switch to the Java serialization read through the filter.
+
== Upgrading from 4.22.1 to 4.22.2
=== camel-lra - only an LRA hosted by the configured coordinator is joined