Velocity Support apache#837

docs/modules/ROOT/pages/reference/components/velocity.adoc

@@ -4,11 +4,11 @@
 = Velocity
 :cq-artifact-id: camel-quarkus-velocity
 :cq-artifact-id-base: velocity
-:cq-native-supported: false
-:cq-status: Preview
+:cq-native-supported: true
+:cq-status: Stable
 :cq-deprecated: false
 :cq-jvm-since: 1.1.0
-:cq-native-since: n/a
+:cq-native-since: 1.2.0
 :cq-camel-part-name: velocity
 :cq-camel-part-title: Velocity
 :cq-camel-part-description: Transform messages using a Velocity template.

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

@@ -3,15 +3,15 @@
 
 = Velocity
 :cq-artifact-id: camel-quarkus-velocity
-:cq-native-supported: false
-:cq-status: Preview
+:cq-native-supported: true
+:cq-status: Stable
 :cq-description: Transform messages using a Velocity template.
 :cq-deprecated: false
 :cq-jvm-since: 1.1.0
-:cq-native-since: n/a
+:cq-native-since: 1.2.0
 
 [.badges]
-[.badge-key]##JVM since##[.badge-supported]##1.1.0## [.badge-key]##Native##[.badge-unsupported]##unsupported##
+[.badge-key]##JVM since##[.badge-supported]##1.1.0## [.badge-key]##Native since##[.badge-supported]##1.2.0##
 
 Transform messages using a Velocity template.
 
@@ -32,3 +32,29 @@ Please refer to the above link for usage and configuration details.
 ----
 
 Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
+
+== Camel Quarkus limitations
+
+Configuration property `contentCache` doesn't have any effect on endpoint in native mode.
+The resources used in native mode have to be embed in the native executable (see following chapter),
+therefore they can not be changed during runtime.
+
+
+== Additional Camel Quarkus configuration
+
+Beyond standard usages described above, a trick is needed when using velocity templates from classpath resources in native mode. In such a situation, one needs to explicitly embed the resources in the native executable by specifying the `include-patterns` option.
+
+For instance, the route below would load the velocity template from a classpath resource named _template/simple.vm_:
+[source,java]
+----
+from("direct:start").to("velocity://template/simple.vm");
+----
+
+In order to work in native mode the `include-patterns` configuration should be set. For instance, in the `application.properties` file as below :
+[source,properties]
+----
+quarkus.camel.native.resources.include-patterns = template/*.vm
+----
+
+More information about selecting resources for inclusion in the native executable could be found at xref:user-guide/native-mode.adoc#embedding-resource-in-native-executable[Embedding resource in native executable].
+

extensions-jvm/pom.xml

@@ -142,7 +142,6 @@
         <module>thrift</module>
         <module>twilio</module>
         <module>univocity-parsers</module>
-        <module>velocity</module>
         <module>web3j</module>
         <module>weka</module>
         <module>wordpress</module>

extensions/pom.xml

@@ -182,6 +182,7 @@
         <module>timer</module>
         <module>twitter</module>
         <module>validator</module>
+        <module>velocity</module>
         <module>vertx</module>
         <module>vertx-http</module>
         <module>vertx-websocket</module>

extensions/velocity/deployment/src/main/java/org/apache/camel/quarkus/component/velocity/deployment/VelocityProcessor.java

@@ -0,0 +1,80 @@
+/*
+ * 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.component.velocity.deployment;
+
+import java.util.ArrayList;
+import java.util.TreeMap;
+
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
+import io.quarkus.deployment.builditem.FeatureBuildItem;
+import io.quarkus.deployment.builditem.IndexDependencyBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
+import org.apache.camel.component.velocity.CamelVelocityClasspathResourceLoader;
+import org.apache.camel.support.DefaultExchange;
+import org.apache.camel.support.MessageSupport;
+import org.jboss.jandex.IndexView;
+
+import static java.util.stream.Collectors.toCollection;
+
+class VelocityProcessor {
+
+    private static final String FEATURE = "camel-velocity";
+
+    @BuildStep
+    FeatureBuildItem feature() {
+        return new FeatureBuildItem(FEATURE);
+    }
+
+    @BuildStep
+    NativeImageResourceBuildItem initResources() {
+        return new NativeImageResourceBuildItem(
+                "org/apache/velocity/runtime/defaults/velocity.properties",
+                "org/apache/velocity/runtime/defaults/directive.properties");
+    }
+
+    @BuildStep
+    ReflectiveClassBuildItem registerForReflection(CombinedIndexBuildItem combinedIndex) {
+        IndexView index = combinedIndex.getIndex();
+
+        ArrayList<String> dtos = index.getKnownClasses().stream().map(ci -> ci.name().toString())
+                .filter(n -> n.startsWith("org.apache.velocity.runtime") ||
+                        n.startsWith("org.apache.velocity.util.introspection"))
+                .sorted()
+                .collect(toCollection(ArrayList::new));
+
+        dtos.add(CamelVelocityClasspathResourceLoader.class.getName());
+
+        return new ReflectiveClassBuildItem(false, false, dtos.toArray(new String[dtos.size()]));
+    }
+
+    @BuildStep
+    ReflectiveClassBuildItem registerForReflectionWithMethods() {
+        return new ReflectiveClassBuildItem(true, false,
+                TreeMap.class.getName(),
+                //required fir supplemental context
+                MessageSupport.class.getName(),
+                //required for values in properties
+                DefaultExchange.class.getName());
+    }
+
+    @BuildStep
+    IndexDependencyBuildItem registerDependencyForIndex() {
+        return new IndexDependencyBuildItem("org.apache.velocity", "velocity-engine-core");
+    }
+}

extensions-jvm/velocity/pom.xml → extensions/velocity/pom.xml

@@ -35,6 +35,5 @@
     <modules>
         <module>deployment</module>
         <module>runtime</module>
-        <module>integration-test</module>
     </modules>
 </project>

extensions-jvm/velocity/runtime/pom.xml → extensions/velocity/runtime/pom.xml

@@ -34,6 +34,7 @@
 
     <properties>
         <camel.quarkus.jvmSince>1.1.0</camel.quarkus.jvmSince>
+        <camel.quarkus.nativeSince>1.2.0</camel.quarkus.nativeSince>
     </properties>
 
     <dependencyManagement>

extensions/velocity/runtime/src/main/doc/configuration.adoc

@@ -0,0 +1,15 @@
+Beyond standard usages described above, a trick is needed when using velocity templates from classpath resources in native mode. In such a situation, one needs to explicitly embed the resources in the native executable by specifying the `include-patterns` option.
+
+For instance, the route below would load the velocity template from a classpath resource named _template/simple.vm_:
+[source,java]
+----
+from("direct:start").to("velocity://template/simple.vm");
+----
+
+In order to work in native mode the `include-patterns` configuration should be set. For instance, in the `application.properties` file as below :
+[source,properties]
+----
+quarkus.camel.native.resources.include-patterns = template/*.vm
+----
+
+More information about selecting resources for inclusion in the native executable could be found at xref:user-guide/native-mode.adoc#embedding-resource-in-native-executable[Embedding resource in native executable].

extensions/velocity/runtime/src/main/doc/limitations.adoc

@@ -0,0 +1,3 @@
+Configuration property `contentCache` doesn't have any effect on endpoint in native mode.
+The resources used in native mode have to be embed in the native executable (see following chapter),
+therefore they can not be changed during runtime.

extensions-jvm/velocity/runtime/src/main/resources/META-INF/quarkus-extension.yaml → extensions/velocity/runtime/src/main/resources/META-INF/quarkus-extension.yaml

@@ -24,9 +24,8 @@
 name: "Camel Velocity"
 description: "Transform messages using a Velocity template"
 metadata:
-  unlisted: true
   guide: "https://camel.apache.org/camel-quarkus/latest/reference/extensions/velocity.html"
   categories:
   - "integration"
   status:
-  - "preview"
+  - "stable"

integration-tests/pom.xml

@@ -154,6 +154,7 @@
         <module>tika</module>
         <module>twitter</module>
         <module>validator</module>
+        <module>velocity</module>
         <module>vertx</module>
         <module>vertx-websocket</module>
         <module>weather</module>