Use of serialization feature of Quakus (includes Sql and Nitrite)

Author: JiriOndrusek

docs/modules/ROOT/pages/reference/extensions/core.adoc

@@ -224,6 +224,28 @@ A comma separated list of Ant-path style patterns to match class names that shou
 | `string`
 | 
 
+|icon:lock[title=Fixed at build time] [[quarkus.camel.native.reflection.serialization-enabled]]`link:#quarkus.camel.native.reflection.serialization-enabled[quarkus.camel.native.reflection.serialization-enabled]`
+
+If `true`, basic classes are registered for serialization; otherwise basic classes won't be registered automatically for serialization in native mode. 
+ List of basic classes:  
+ - `java.lang.Boolean` 
+ - ``java.lang.Byte ++}++++}++ 
+ - ``java.lang.Character ++}++++}++ 
+ - ``java.lang.Float ++}++++}++ 
+ - ``java.lang.Double ++}++++}++ 
+ - ``java.lang.Integer ++}++++}++ 
+ - ``java.lang.Long ++}++++}++ 
+ - ``java.lang.Number ++}++++}++ 
+ - ``java.lang.String ++}++++}++ 
+ - ``java.math.BigInteger ++}++++}++ 
+ - ``java.util.Date ++}++++}++ 
+ - ``java.util.HashMap ++}++++}++ 
+ - ``java.util.LinkedHashMap ++}++++}++ 
+ - ``org.apache.camel.support.DefaultExchangeHolder ++}++++}++  
+ Setting this to `false` helps to reduce the size of the native image. In JVM mode, there is no real benefit of setting this flag to `true` except for making the behavior consistent with native mode.
+| `boolean`
+| `false`
+
 |icon:lock[title=Fixed at build time] [[quarkus.camel.csimple.on-build-time-analysis-failure]]`link:#quarkus.camel.csimple.on-build-time-analysis-failure[quarkus.camel.csimple.on-build-time-analysis-failure]`
 
 What to do if it is not possible to extract CSimple expressions from a route definition at build time.

docs/modules/ROOT/pages/reference/extensions/nitrite.adoc

@@ -41,11 +41,10 @@ Check the xref:user-guide/index.adoc[User guide] for more information about writ
 
 == Usage
 
-If your persistence objects implement `java.io.Serializable`, you have to add configuration of all serializable classes.
-There is a new serialization support in GraalVM 21.0. Developers can configure classes
-for serialization via the serialization configuration file
-`-H:SerializationConfigurationResources=/path/to-serialization-config.json` option. For more
-information see https://github.com/oracle/graal/pull/2730[PR with feature].
+If your persistence objects in native mode implement `java.io.Serializable` and are not automatically registered for serialization,
+you have to register them for serialization. Look into xref:extensions/core.adoc#serialization_in_native_mode[documentation]
+to see which classes are registered and how to register other ones.
+
 
 If your persistence objects implement `org.dizitart.no2.mapper.Mappable`. All classes have to
 implement also `java.io.Serializable` and have to be registered for serialization (see previous option),

docs/modules/ROOT/pages/reference/extensions/sql.adoc

@@ -40,41 +40,6 @@ Or add the coordinates to your existing project:
 
 Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
 
-== Usage
-
-If you are using SQL Aggregator in native mode, you have to register several classes for serialization using GraalVM
-feature. Serialization support since GraalVM 21.0 allows developers to configure classes for serialization via
-the serialization configuration file `-H:SerializationConfigurationResources=/path-to/serialization-config.json` option.
-For more information see https://github.com/oracle/graal/pull/2730[pull request with feature].
-
-Several classes has to be registered for serialization every time to make SQL Aggregator work in native.
-Here is a template of `serialization-config.json` with all mandatory classes:
-
-```
-[
-  {
-    "name" : "java.lang.Integer"
-  },
-  {
-    "name" : "java.lang.Number"
-  },
-  {
-    "name" : "java.lang.String"
-  },
-  {
-    "name" : "java.util.HashMap"
-  },
-  {
-    "name" : "java.util.LinkedHashMap"
-  },
-  {
-    "name" : "org.apache.camel.support.DefaultExchangeHolder"
-  }
-]
-```
-
-
-
 == Additional Camel Quarkus configuration
 
 === Configuring a DataSource
@@ -102,3 +67,12 @@ Note that URI schemes such as `file` or `http` do not need to be listed.
 quarkus.native.resources.includes = queries.sql, sql/*.sql
 ----
 
+=== SQL Aggregator ===
+
+If your exchanges in native mode contain objects, which are not automatically registered for serialization (see xref:extensions/core.adoc#serialization_in_native_mode[documentation]),
+you have to register them manually (see xref:extensions/core.adoc#serialization_in_native_mode[documentation])
+
+
+
+
+

docs/modules/ROOT/pages/user-guide/native-mode.adoc

@@ -111,3 +111,28 @@ in {@code application.properties} - e.g.
 quarkus.index-dependency.commons-lang3.group-id = org.apache.commons
 quarkus.index-dependency.commons-lang3.artifact-id = commons-lang3
 ----
+
+[[serialization]]
+== Registration for serialization
+
+If serialization support is requested via `quarkus.camel.native.reflection.serialization-enabled`, following classes are registered for serialization:
+
+* `java.lang.Boolean`
+* `java.lang.Byte`
+* `java.lang.Character`
+* `java.lang.Float`
+* `java.lang.Double`
+* `java.lang.Integer`
+* `java.lang.Long`
+* `java.lang.Number`
+* `java.lang.String`
+* `java.math.BigInteger`
+* `java.util.Date`
+* `java.util.HashMap`
+* `java.util.LinkedHashMap`
+* `org.apache.camel.support.DefaultExchangeHolder`
+
+Developers can configure classes for serialization via the serialization configuration file
+`-H:SerializationConfigurationResources=/path/to-serialization-config.json` option. For more information see
+https://github.com/oracle/graal/pull/2730[PR with feature].
+

extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/CamelSerializationProcessor.java

@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.quarkus.core.deployment;
+
+import java.math.BigInteger;
+import java.util.AbstractMap;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.stream.Stream;
+
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
+import org.apache.camel.quarkus.core.CamelConfig;
+import org.apache.camel.quarkus.core.deployment.spi.CamelSerializationBuildItem;
+import org.apache.camel.support.DefaultExchangeHolder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CamelSerializationProcessor {
+    private static final Logger LOGGER = LoggerFactory.getLogger(CamelSerializationProcessor.class);
+
+    @BuildStep
+    void produceSerializationBuildItem(CamelConfig config, BuildProducer<CamelSerializationBuildItem> serializationBuildItems) {
+        final CamelConfig.ReflectionConfig reflectionConfig = config.native_.reflection;
+        if (reflectionConfig.serializationEnabled) {
+            LOGGER.debug(
+                    "Registration of basic types for serialization is enabled via quarkus.camel.native.reflection.serialization-enabled");
+            serializationBuildItems.produce(new CamelSerializationBuildItem());
+        }
+    }
+
+    @BuildStep
+    void baseSerializationClasses(List<CamelSerializationBuildItem> serializationRequests,
+            BuildProducer<ReflectiveClassBuildItem> reflectiveClasses) {
+
+        if (!serializationRequests.isEmpty()) {
+            String[] classes = Stream.of(Boolean.class,
+                    Byte.class,
+                    Character.class,
+                    Double.class,
+                    Float.class,
+                    Integer.class,
+                    Long.class,
+                    Number.class,
+                    Date.class,
+                    String.class,
+                    AbstractMap.class,
+                    HashMap.class,
+                    LinkedHashMap.class,
+                    BigInteger.class,
+                    DefaultExchangeHolder.class)
+                    .map(c -> c.getName()).toArray(String[]::new);
+
+            //required for serialization of BigInteger
+            reflectiveClasses.produce(new ReflectiveClassBuildItem(false, false, byte[].class));
+
+            reflectiveClasses.produce(ReflectiveClassBuildItem.serializationClass(classes));
+        }
+    }
+}

extensions-core/core/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/spi/CamelSerializationBuildItem.java

@@ -0,0 +1,27 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.quarkus.core.deployment.spi;
+
+import io.quarkus.builder.item.MultiBuildItem;
+
+/**
+ * Signal that basic classes listed in
+ * {@code org.apache.camel.quarkus.core.deployment.CamelSerializationProcessor.baseSerializationClasses()}
+ * should be registered for serialization.
+ */
+public final class CamelSerializationBuildItem extends MultiBuildItem {
+}

extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java

@@ -281,6 +281,33 @@ public static class ReflectionConfig {
         @ConfigItem
         public Optional<List<String>> includePatterns;
 
+        /**
+         * If {@code true}, basic classes are registered for serialization; otherwise basic classes won't be registered
+         * automatically for serialization in native mode.
+         * <p>
+         * List of basic classes:
+         * <ul>
+         * <li>{@code java.lang.Boolean}</li>
+         * <li>{@code }java.lang.Byte }</li>}
+         * <li>{@code }java.lang.Character }</li>}
+         * <li>{@code }java.lang.Float }</li>}
+         * <li>{@code }java.lang.Double }</li>}
+         * <li>{@code }java.lang.Integer }</li>}
+         * <li>{@code }java.lang.Long }</li>}
+         * <li>{@code }java.lang.Number }</li>}
+         * <li>{@code }java.lang.String }</li>}
+         * <li>{@code }java.math.BigInteger }</li>}
+         * <li>{@code }java.util.Date }</li>}
+         * <li>{@code }java.util.HashMap }</li>}
+         * <li>{@code }java.util.LinkedHashMap }</li>}
+         * <li>{@code }org.apache.camel.support.DefaultExchangeHolder }</li>}
+         * </ul>
+         * <p>
+         * Setting this to {@code false} helps to reduce the size of the native image. In JVM mode, there is no real
+         * benefit of setting this flag to {@code true} except for making the behavior consistent with native mode.
+         */
+        @ConfigItem(defaultValue = "false")
+        public boolean serializationEnabled;
     }
 
     @ConfigGroup

extensions/nitrite/deployment/src/main/java/org/apache/camel/quarkus/component/nitrite/deployment/NitriteProcessor.java

@@ -16,13 +16,18 @@
  */
 package org.apache.camel.quarkus.component.nitrite.deployment;
 
-import java.util.Arrays;
-import java.util.List;
+import java.util.concurrent.atomic.AtomicBoolean;
 
+import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.FeatureBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
+import org.apache.camel.quarkus.core.deployment.spi.CamelSerializationBuildItem;
+import org.dizitart.no2.Document;
+import org.dizitart.no2.Index;
+import org.dizitart.no2.NitriteId;
+import org.dizitart.no2.meta.Attributes;
 
 class NitriteProcessor {
 
@@ -33,15 +38,30 @@ FeatureBuildItem feature() {
         return new FeatureBuildItem(FEATURE);
     }
 
+    @BuildStep
+    CamelSerializationBuildItem serialization() {
+        return new CamelSerializationBuildItem();
+    }
+
     @BuildStep
     RuntimeInitializedClassBuildItem runtimeInitializedClass() {
         // this class uses a SecureRandom which needs to be initialised at run time
         return new RuntimeInitializedClassBuildItem("org.dizitart.no2.Security");
     }
 
     @BuildStep
-    List<ReflectiveClassBuildItem> reflectiveClasses() {
-        return Arrays.asList(new ReflectiveClassBuildItem(false, false, org.h2.store.fs.FilePathNio.class),
-                new ReflectiveClassBuildItem(true, false, "sun.reflect.ReflectionFactory"));
+    void reflectiveClasses(BuildProducer<ReflectiveClassBuildItem> reflectiveClasses) {
+        reflectiveClasses.produce(new ReflectiveClassBuildItem(false, false, org.h2.store.fs.FilePathNio.class));
+        reflectiveClasses.produce(new ReflectiveClassBuildItem(true, false, "sun.reflect.ReflectionFactory"));
+
+        String[] dtos = new String[] { NitriteId.class.getName(),
+                Document.class.getName(),
+                Attributes.class.getName(),
+                "org.dizitart.no2.internals.IndexMetaService$IndexMeta",
+                AtomicBoolean.class.getName(),
+                Index.class.getName() };
+
+        reflectiveClasses.produce(ReflectiveClassBuildItem.serializationClass(dtos));
+
     }
 }

extensions/nitrite/runtime/src/main/doc/usage.adoc

@@ -1,8 +1,7 @@
-If your persistence objects implement `java.io.Serializable`, you have to add configuration of all serializable classes.
-There is a new serialization support in GraalVM 21.0. Developers can configure classes
-for serialization via the serialization configuration file
-`-H:SerializationConfigurationResources=/path/to-serialization-config.json` option. For more
-information see https://github.com/oracle/graal/pull/2730[PR with feature].
+If your persistence objects in native mode implement `java.io.Serializable` and are not automatically registered for serialization,
+you have to register them for serialization. Look into xref:extensions/core.adoc#serialization_in_native_mode[documentation]
+to see which classes are registered and how to register other ones.
+
 
 If your persistence objects implement `org.dizitart.no2.mapper.Mappable`. All classes have to
 implement also `java.io.Serializable` and have to be registered for serialization (see previous option),