You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/11/17 08:26:15 UTC

[camel] 02/02: CAMEL-17201: camel-kamelet-main - Auto download JARs for new components/dataformats/languages in use when using regular routes

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

commit 14a1f29a3af1f15c1e7bd078f792ba5296e7e09b
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Nov 17 09:25:25 2021 +0100

    CAMEL-17201: camel-kamelet-main - Auto download JARs for new components/dataformats/languages in use when using regular routes
---
 .../src/main/docs/kamelet-main.adoc                |  7 +--
 .../DependencyDownloaderComponentResolver.java     | 48 ++---------------
 .../DependencyDownloaderDataFormatResolver.java    | 58 ++++++++++++++++++++
 ...oader.java => DependencyDownloaderKamelet.java} |  4 +-
 .../main/DependencyDownloaderLanguageResolver.java | 59 ++++++++++++++++++++
 ...omponentResolver.java => DownloaderHelper.java} | 63 ++++++----------------
 .../java/org/apache/camel/main/KameletMain.java    | 10 ++--
 ...dencyDownloader.java => KameletYamlRoutes.java} |  6 +--
 .../main/java/org/apache/camel/main/MavenGav.java  |  5 +-
 9 files changed, 155 insertions(+), 105 deletions(-)

diff --git a/dsl/camel-kamelet-main/src/main/docs/kamelet-main.adoc b/dsl/camel-kamelet-main/src/main/docs/kamelet-main.adoc
index 69e288d..94f5654 100644
--- a/dsl/camel-kamelet-main/src/main/docs/kamelet-main.adoc
+++ b/dsl/camel-kamelet-main/src/main/docs/kamelet-main.adoc
@@ -12,7 +12,8 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/others/kamelet-main.a
 
 *Since Camel {since}*
 
-A `main` class that is opinionated to boostrap and run Camel standalone with Kameleets for development and demo purposes.
+A `main` class that is opinionated to boostrap and run Camel standalone with Kamelets (or plain YAML routes)
+for development and demo purposes.
 
 == Initial configuration
 
@@ -29,9 +30,9 @@ These settings can be overridden by configuration in `application.properties`.
 
 == Automatic dependencies downloading
 
-The Kamelet Main can automatic download Kamelet YAML files from a remote location over http/https, and from github as well.
+The Kamelet Main can automatically download Kamelet YAML files from a remote location over http/https, and from github as well.
 
-The official Kameleets from the Apache Camel Kamelet Catalog is stored on github and they can be used out of the box as-is.
+The official Kamelets from the Apache Camel Kamelet Catalog is stored on github and they can be used out of the box as-is.
 
 For example a Camel route can be _coded_ in YAML which uses the Earthquake Kamelet from the catalog, as shown below:
 
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java
index 43b21da..c44e47c 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java
@@ -16,12 +16,6 @@
  */
 package org.apache.camel.main;
 
-import java.net.URL;
-import java.net.URLClassLoader;
-import java.util.HashMap;
-import java.util.Map;
-
-import groovy.grape.Grape;
 import org.apache.camel.CamelContext;
 import org.apache.camel.CamelContextAware;
 import org.apache.camel.Component;
@@ -29,17 +23,12 @@ import org.apache.camel.catalog.CamelCatalog;
 import org.apache.camel.catalog.DefaultCamelCatalog;
 import org.apache.camel.impl.engine.DefaultComponentResolver;
 import org.apache.camel.tooling.model.ComponentModel;
-import org.apache.camel.util.StopWatch;
-import org.apache.camel.util.TimeUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Auto downloaded needed JARs when resolving components.
  */
-public class DependencyDownloaderComponentResolver extends DefaultComponentResolver implements CamelContextAware {
+final class DependencyDownloaderComponentResolver extends DefaultComponentResolver implements CamelContextAware {
 
-    private static final Logger LOG = LoggerFactory.getLogger(KameletDependencyDownloader.class);
     private final CamelCatalog catalog = new DefaultCamelCatalog();
     private CamelContext camelContext;
 
@@ -60,42 +49,11 @@ public class DependencyDownloaderComponentResolver extends DefaultComponentResol
     @Override
     public Component resolveComponent(String name, CamelContext context) {
         ComponentModel model = catalog.componentModel(name);
-        if (model != null && !alreadyOnClasspath(model.getArtifactId())) {
-            downloadDependency(model.getGroupId(), model.getArtifactId(), model.getVersion());
+        if (model != null && !DownloaderHelper.alreadyOnClasspath(camelContext, model.getArtifactId())) {
+            DownloaderHelper.downloadDependency(camelContext, model.getGroupId(), model.getArtifactId(), model.getVersion());
         }
 
         return super.resolveComponent(name, context);
     }
 
-    private boolean alreadyOnClasspath(String artifactId) {
-        if (camelContext.getApplicationContextClassLoader() != null) {
-            ClassLoader cl = camelContext.getApplicationContextClassLoader();
-            if (cl instanceof URLClassLoader) {
-                URLClassLoader ucl = (URLClassLoader) cl;
-                for (URL u : ucl.getURLs()) {
-                    String s = u.toString();
-                    if (s.contains(artifactId)) {
-                        // already on classpath
-                        return true;
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-    private void downloadDependency(String groupId, String artifactId, String version) {
-        StopWatch watch = new StopWatch();
-        Map<String, Object> map = new HashMap<>();
-        map.put("classLoader", camelContext.getApplicationContextClassLoader());
-        map.put("group", groupId);
-        map.put("module", artifactId);
-        map.put("version", version);
-        map.put("classifier", "");
-
-        LOG.debug("Downloading dependency: {}:{}:{}", groupId, artifactId, version);
-        Grape.grab(map);
-        LOG.info("Downloaded dependency: {}:{}:{} took: {}", groupId, artifactId, version,
-                TimeUtils.printDuration(watch.taken()));
-    }
 }
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderDataFormatResolver.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderDataFormatResolver.java
new file mode 100644
index 0000000..5bed214
--- /dev/null
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderDataFormatResolver.java
@@ -0,0 +1,58 @@
+/*
+ * 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.main;
+
+import org.apache.camel.CamelContext;
+import org.apache.camel.CamelContextAware;
+import org.apache.camel.catalog.CamelCatalog;
+import org.apache.camel.catalog.DefaultCamelCatalog;
+import org.apache.camel.impl.engine.DefaultDataFormatResolver;
+import org.apache.camel.spi.DataFormat;
+import org.apache.camel.tooling.model.DataFormatModel;
+
+/**
+ * Auto downloaded needed JARs when resolving data formats.
+ */
+final class DependencyDownloaderDataFormatResolver extends DefaultDataFormatResolver implements CamelContextAware {
+
+    private final CamelCatalog catalog = new DefaultCamelCatalog();
+    private CamelContext camelContext;
+
+    public DependencyDownloaderDataFormatResolver(CamelContext camelContext) {
+        this.camelContext = camelContext;
+    }
+
+    @Override
+    public CamelContext getCamelContext() {
+        return camelContext;
+    }
+
+    @Override
+    public void setCamelContext(CamelContext camelContext) {
+        this.camelContext = camelContext;
+    }
+
+    @Override
+    public DataFormat createDataFormat(String name, CamelContext context) {
+        DataFormatModel model = catalog.dataFormatModel(name);
+        if (model != null && !DownloaderHelper.alreadyOnClasspath(camelContext, model.getArtifactId())) {
+            DownloaderHelper.downloadDependency(camelContext, model.getGroupId(), model.getArtifactId(), model.getVersion());
+        }
+        return super.createDataFormat(name, context);
+    }
+
+}
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloader.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderKamelet.java
similarity index 94%
rename from dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloader.java
rename to dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderKamelet.java
index 7a65cbf..f4155e3 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloader.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderKamelet.java
@@ -28,9 +28,9 @@ import org.apache.camel.support.service.ServiceSupport;
 /**
  * To automatic downloaded dependencies that Kamelets requires.
  */
-public final class DependencyDownloader extends ServiceSupport implements CamelContextAware, RouteTemplateLoaderListener {
+final class DependencyDownloaderKamelet extends ServiceSupport implements CamelContextAware, RouteTemplateLoaderListener {
 
-    private final KameletDependencyDownloader downloader = new KameletDependencyDownloader("yaml");
+    private final KameletYamlRoutes downloader = new KameletYamlRoutes("yaml");
     private CamelContext camelContext;
 
     @Override
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderLanguageResolver.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderLanguageResolver.java
new file mode 100644
index 0000000..c7164f7
--- /dev/null
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderLanguageResolver.java
@@ -0,0 +1,59 @@
+/*
+ * 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.main;
+
+import org.apache.camel.CamelContext;
+import org.apache.camel.CamelContextAware;
+import org.apache.camel.catalog.CamelCatalog;
+import org.apache.camel.catalog.DefaultCamelCatalog;
+import org.apache.camel.impl.engine.DefaultLanguageResolver;
+import org.apache.camel.spi.Language;
+import org.apache.camel.tooling.model.LanguageModel;
+
+/**
+ * Auto downloaded needed JARs when resolving languages.
+ */
+final class DependencyDownloaderLanguageResolver extends DefaultLanguageResolver implements CamelContextAware {
+
+    private final CamelCatalog catalog = new DefaultCamelCatalog();
+    private CamelContext camelContext;
+
+    public DependencyDownloaderLanguageResolver(CamelContext camelContext) {
+        this.camelContext = camelContext;
+    }
+
+    @Override
+    public CamelContext getCamelContext() {
+        return camelContext;
+    }
+
+    @Override
+    public void setCamelContext(CamelContext camelContext) {
+        this.camelContext = camelContext;
+    }
+
+    @Override
+    public Language resolveLanguage(String name, CamelContext context) {
+        LanguageModel model = catalog.languageModel(name);
+        if (model != null && !DownloaderHelper.alreadyOnClasspath(camelContext, model.getArtifactId())) {
+            DownloaderHelper.downloadDependency(camelContext, model.getGroupId(), model.getArtifactId(), model.getVersion());
+        }
+
+        return super.resolveLanguage(name, context);
+    }
+
+}
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DownloaderHelper.java
similarity index 59%
copy from dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java
copy to dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DownloaderHelper.java
index 43b21da..32e639d 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DependencyDownloaderComponentResolver.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/DownloaderHelper.java
@@ -23,51 +23,34 @@ import java.util.Map;
 
 import groovy.grape.Grape;
 import org.apache.camel.CamelContext;
-import org.apache.camel.CamelContextAware;
-import org.apache.camel.Component;
-import org.apache.camel.catalog.CamelCatalog;
-import org.apache.camel.catalog.DefaultCamelCatalog;
-import org.apache.camel.impl.engine.DefaultComponentResolver;
-import org.apache.camel.tooling.model.ComponentModel;
 import org.apache.camel.util.StopWatch;
 import org.apache.camel.util.TimeUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * Auto downloaded needed JARs when resolving components.
- */
-public class DependencyDownloaderComponentResolver extends DefaultComponentResolver implements CamelContextAware {
-
-    private static final Logger LOG = LoggerFactory.getLogger(KameletDependencyDownloader.class);
-    private final CamelCatalog catalog = new DefaultCamelCatalog();
-    private CamelContext camelContext;
-
-    public DependencyDownloaderComponentResolver(CamelContext camelContext) {
-        this.camelContext = camelContext;
-    }
+public final class DownloaderHelper {
 
-    @Override
-    public CamelContext getCamelContext() {
-        return camelContext;
-    }
+    private static final Logger LOG = LoggerFactory.getLogger(DownloaderHelper.class);
 
-    @Override
-    public void setCamelContext(CamelContext camelContext) {
-        this.camelContext = camelContext;
+    private DownloaderHelper() {
     }
 
-    @Override
-    public Component resolveComponent(String name, CamelContext context) {
-        ComponentModel model = catalog.componentModel(name);
-        if (model != null && !alreadyOnClasspath(model.getArtifactId())) {
-            downloadDependency(model.getGroupId(), model.getArtifactId(), model.getVersion());
-        }
+    public static void downloadDependency(CamelContext camelContext, String groupId, String artifactId, String version) {
+        StopWatch watch = new StopWatch();
+        Map<String, Object> map = new HashMap<>();
+        map.put("classLoader", camelContext.getApplicationContextClassLoader());
+        map.put("group", groupId);
+        map.put("module", artifactId);
+        map.put("version", version);
+        map.put("classifier", "");
 
-        return super.resolveComponent(name, context);
+        LOG.debug("Downloading dependency: {}:{}:{}", groupId, artifactId, version);
+        Grape.grab(map);
+        LOG.info("Downloaded dependency: {}:{}:{} took: {}", groupId, artifactId, version,
+                TimeUtils.printDuration(watch.taken()));
     }
 
-    private boolean alreadyOnClasspath(String artifactId) {
+    public static boolean alreadyOnClasspath(CamelContext camelContext, String artifactId) {
         if (camelContext.getApplicationContextClassLoader() != null) {
             ClassLoader cl = camelContext.getApplicationContextClassLoader();
             if (cl instanceof URLClassLoader) {
@@ -84,18 +67,4 @@ public class DependencyDownloaderComponentResolver extends DefaultComponentResol
         return false;
     }
 
-    private void downloadDependency(String groupId, String artifactId, String version) {
-        StopWatch watch = new StopWatch();
-        Map<String, Object> map = new HashMap<>();
-        map.put("classLoader", camelContext.getApplicationContextClassLoader());
-        map.put("group", groupId);
-        map.put("module", artifactId);
-        map.put("version", version);
-        map.put("classifier", "");
-
-        LOG.debug("Downloading dependency: {}:{}:{}", groupId, artifactId, version);
-        Grape.grab(map);
-        LOG.info("Downloaded dependency: {}:{}:{} took: {}", groupId, artifactId, version,
-                TimeUtils.printDuration(watch.taken()));
-    }
 }
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
index cb453ad..c656375 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletMain.java
@@ -110,7 +110,7 @@ public class KameletMain extends MainCommandLineSupport {
         super.doStart();
         if (getCamelContext() != null) {
             try {
-                // if we were veto started then mark as completed
+                // if we were vetoed started then mark as completed
                 getCamelContext().start();
             } finally {
                 if (getCamelContext().isVetoStarted()) {
@@ -146,15 +146,17 @@ public class KameletMain extends MainCommandLineSupport {
         }
         answer.setApplicationContextClassLoader(kameletClassLoader);
         answer.setRegistry(registry);
-        // use component resolver that can auto downloaded JARs
-        answer.setComponentResolver(new DependencyDownloaderComponentResolver(answer));
 
         addInitialProperty("camel.component.kamelet.location", "classpath:/kamelets,github:apache:camel-kamelets");
         addInitialProperty("camel.main.lightweight", "true");
 
         if (download) {
             try {
-                answer.addService(new DependencyDownloader());
+                // use resolver that can auto downloaded
+                answer.setComponentResolver(new DependencyDownloaderComponentResolver(answer));
+                answer.setDataFormatResolver(new DependencyDownloaderDataFormatResolver(answer));
+                answer.setLanguageResolver(new DependencyDownloaderLanguageResolver(answer));
+                answer.addService(new DependencyDownloaderKamelet());
             } catch (Exception e) {
                 throw RuntimeCamelException.wrapRuntimeException(e);
             }
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletDependencyDownloader.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletYamlRoutes.java
similarity index 96%
rename from dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletDependencyDownloader.java
rename to dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletYamlRoutes.java
index 7e6b3cc..f91fa2c 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletDependencyDownloader.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/KameletYamlRoutes.java
@@ -44,14 +44,14 @@ import static org.apache.camel.dsl.yaml.common.YamlDeserializerSupport.nodeAt;
 /**
  * Reuse the YAML DSL support for parsing Kamelets
  */
-public class KameletDependencyDownloader extends YamlRoutesBuilderLoaderSupport implements CamelContextAware {
+class KameletYamlRoutes extends YamlRoutesBuilderLoaderSupport implements CamelContextAware {
 
-    private static final Logger LOG = LoggerFactory.getLogger(KameletDependencyDownloader.class);
+    private static final Logger LOG = LoggerFactory.getLogger(KameletYamlRoutes.class);
     private CamelContext camelContext;
     private final String cp = System.getProperty("java.class.path");
     private final Set<String> downloaded = new HashSet<>();
 
-    public KameletDependencyDownloader(String extension) {
+    public KameletYamlRoutes(String extension) {
         super(extension);
     }
 
diff --git a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/MavenGav.java b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/MavenGav.java
index 9801f43..b00fc83 100644
--- a/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/MavenGav.java
+++ b/dsl/camel-kamelet-main/src/main/java/org/apache/camel/main/MavenGav.java
@@ -16,7 +16,10 @@
  */
 package org.apache.camel.main;
 
-public class MavenGav {
+/**
+ * Maven GAV model
+ */
+public final class MavenGav {
 
     private String groupId;
     private String artifactId;