CAMEL-17257: camel-core - RouteBuilder should store source location o…

…f the file from the DSL loader
bvn13 · Dec 1, 2021 · 9b6cf15 · 9b6cf15
1 parent 216e074
commit 9b6cf15
Show file tree

Hide file tree

Showing 17 changed files with 169 additions and 69 deletions.
diff --git a/core/camel-api/src/main/java/org/apache/camel/Route.java b/core/camel-api/src/main/java/org/apache/camel/Route.java
@@ -23,6 +23,7 @@
 
 import org.apache.camel.spi.InterceptStrategy;
 import org.apache.camel.spi.ManagementInterceptStrategy;
+import org.apache.camel.spi.Resource;
 import org.apache.camel.spi.RouteController;
 import org.apache.camel.spi.RouteError;
 import org.apache.camel.spi.RoutePolicy;
@@ -133,6 +134,13 @@ public interface Route extends RuntimeConfiguration {
      */
     String getConfigurationId();
 
+    /**
+     * Gets the source resource that this route is located from
+     *
+     * @return the source, or null if this route is not loaded from a resource
+     */
+    Resource getSourceResource();
+
     /**
      * Gets the camel context
      *

diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/RouteFactory.java b/core/camel-api/src/main/java/org/apache/camel/spi/RouteFactory.java
@@ -34,10 +34,12 @@ public interface RouteFactory {
      * @param  routeId          the route id
      * @param  routeDescription the route description
      * @param  endpoint         the input endpoint (consumer)
+     * @param  resource         the source resource (if loaded via a DSL routes loader)
      * @return                  the created route
      */
     Route createRoute(
             CamelContext camelContext, NamedNode routeDefinition,
-            String routeId, String routeDescription, Endpoint endpoint);
+            String routeId, String routeDescription, Endpoint endpoint,
+            Resource resource);
 
 }
diff --git a/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/AbstractCamelContext.java b/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/AbstractCamelContext.java
@@ -3068,8 +3068,13 @@ protected void logStartSummary() {
                 // use basic endpoint uri to not log verbose details or potential sensitive data
                 String uri = order.getRoute().getEndpoint().getEndpointBaseUri();
                 uri = URISupport.sanitizeUri(uri);
-                lines.add(String.format("    %s %s (%s)", status, id, uri));
-
+                String loc = order.getRoute().getSourceResource() != null
+                        ? order.getRoute().getSourceResource().getLocation() : null;
+                if (startupSummaryLevel == StartupSummaryLevel.Verbose && loc != null) {
+                    lines.add(String.format("    %s %s (%s) (source: %s)", status, id, uri, loc));
+                } else {
+                    lines.add(String.format("    %s %s (%s)", status, id, uri));
+                }
                 String cid = order.getRoute().getConfigurationId();
                 if (cid != null) {
                     configs.add(String.format("    %s (%s)", id, cid));
@@ -3087,7 +3092,12 @@ protected void logStartSummary() {
                     // use basic endpoint uri to not log verbose details or potential sensitive data
                     String uri = route.getEndpoint().getEndpointBaseUri();
                     uri = URISupport.sanitizeUri(uri);
-                    lines.add(String.format("    %s %s (%s)", status, id, uri));
+                    String loc = route.getSourceResource() != null ? route.getSourceResource().getLocation() : null;
+                    if (startupSummaryLevel == StartupSummaryLevel.Verbose && loc != null) {
+                        lines.add(String.format("    %s %s (%s) (source: %s)", status, id, uri, loc));
+                    } else {
+                        lines.add(String.format("    %s %s (%s)", status, id, uri));
+                    }
 
                     String cid = route.getConfigurationId();
                     if (cid != null) {

diff --git a/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/DefaultRoute.java b/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/DefaultRoute.java
@@ -43,6 +43,7 @@
 import org.apache.camel.spi.IdAware;
 import org.apache.camel.spi.InterceptStrategy;
 import org.apache.camel.spi.ManagementInterceptStrategy;
+import org.apache.camel.spi.Resource;
 import org.apache.camel.spi.RouteController;
 import org.apache.camel.spi.RouteError;
 import org.apache.camel.spi.RouteIdAware;
@@ -66,6 +67,7 @@ public class DefaultRoute extends ServiceSupport implements Route {
     private NamedNode route;
     private final String routeId;
     private final String routeDescription;
+    private final Resource sourceResource;
     private final List<Processor> eventDrivenProcessors = new ArrayList<>();
     private final List<InterceptStrategy> interceptStrategies = new ArrayList<>(0);
     private ManagementInterceptStrategy managementInterceptStrategy;
@@ -100,12 +102,13 @@ public class DefaultRoute extends ServiceSupport implements Route {
     private Consumer consumer;
 
     public DefaultRoute(CamelContext camelContext, NamedNode route, String routeId,
-                        String routeDescription, Endpoint endpoint) {
+                        String routeDescription, Endpoint endpoint, Resource resource) {
         this.camelContext = camelContext;
         this.route = route;
         this.routeId = routeId;
         this.routeDescription = routeDescription;
         this.endpoint = endpoint;
+        this.sourceResource = resource;
     }
 
     @Override
@@ -167,6 +170,11 @@ public String getConfigurationId() {
         return value != null ? (String) value : null;
     }
 
+    @Override
+    public Resource getSourceResource() {
+        return sourceResource;
+    }
+
     @Override
     public void initializeServices() throws Exception {
         // gather all the services for this route
@@ -631,7 +639,7 @@ protected void gatherRootServices(List<Service> services) throws Exception {
     public Navigate<Processor> navigate() {
         Processor answer = getProcessor();
 
-        // we want navigating routes to be easy, so skip the initial channel
+        // we want to navigate routes to be easy, so skip the initial channel
         // and navigate to its output where it all starts from end user point of view
         if (answer instanceof Navigate) {
             Navigate<Processor> nav = (Navigate<Processor>) answer;

diff --git a/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/DefaultRouteFactory.java b/core/camel-base-engine/src/main/java/org/apache/camel/impl/engine/DefaultRouteFactory.java
@@ -20,6 +20,7 @@
 import org.apache.camel.Endpoint;
 import org.apache.camel.NamedNode;
 import org.apache.camel.Route;
+import org.apache.camel.spi.Resource;
 import org.apache.camel.spi.RouteFactory;
 
 /**
@@ -29,7 +30,8 @@ public class DefaultRouteFactory implements RouteFactory {
 
     @Override
     public Route createRoute(
-            CamelContext camelContext, NamedNode routeDefinition, String routeId, String routeDescription, Endpoint endpoint) {
-        return new DefaultRoute(camelContext, routeDefinition, routeId, routeDescription, endpoint);
+            CamelContext camelContext, NamedNode routeDefinition, String routeId, String routeDescription,
+            Endpoint endpoint, Resource resource) {
+        return new DefaultRoute(camelContext, routeDefinition, routeId, routeDescription, endpoint, resource);
     }
 }
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/builder/RouteBuilder.java b/core/camel-core-model/src/main/java/org/apache/camel/builder/RouteBuilder.java
@@ -65,6 +65,7 @@
 public abstract class RouteBuilder extends BuilderSupport implements RoutesBuilder, Ordered {
     protected Logger log = LoggerFactory.getLogger(getClass());
 
+    private Resource resource;
     private final AtomicBoolean initialized = new AtomicBoolean();
     private final List<RouteBuilderLifecycleStrategy> lifecycleInterceptors = new ArrayList<>();
     private final List<TransformerBuilder> transformerBuilders = new ArrayList<>();
@@ -83,6 +84,20 @@ public RouteBuilder(CamelContext context) {
         super(context);
     }
 
+    /**
+     * The {@link Resource} which is the source code for this route (such as XML, YAML, Groovy or Java source file)
+     */
+    public Resource getResource() {
+        return resource;
+    }
+
+    /**
+     * Sets the {@link Resource} which is the source code for this route (such as XML, YAML, Groovy or Java source file)
+     */
+    public void setResource(Resource resource) {
+        this.resource = resource;
+    }
+
     /**
      * Add routes to a context using a lambda expression. It can be used as following:
      *
@@ -591,6 +606,9 @@ protected void checkInitialized() throws Exception {
 
             configure();
 
+            // remember the source resource
+            getRouteCollection().setResource(getResource());
+
             for (RouteDefinition route : getRouteCollection().getRoutes()) {
                 // ensure the route is prepared after configure method is complete
                 getRouteCollection().prepareRoute(route);

diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RouteDefinition.java
@@ -46,6 +46,7 @@
 import org.apache.camel.model.rest.RestDefinition;
 import org.apache.camel.spi.AsEndpointUri;
 import org.apache.camel.spi.Metadata;
+import org.apache.camel.spi.Resource;
 import org.apache.camel.spi.RoutePolicy;
 
 /**
@@ -88,6 +89,7 @@ public class RouteDefinition extends OutputDefinition<RouteDefinition> implement
     private List<PropertyDefinition> routeProperties;
     private Map<String, Object> templateParameters;
     private RouteTemplateContext routeTemplateContext;
+    private Resource resource;
 
     public RouteDefinition() {
     }
@@ -702,6 +704,15 @@ public void setRouteTemplateContext(RouteTemplateContext routeTemplateContext) {
         this.routeTemplateContext = routeTemplateContext;
     }
 
+    public Resource getResource() {
+        return resource;
+    }
+
+    @XmlTransient
+    public void setResource(Resource resource) {
+        this.resource = resource;
+    }
+
     // Properties
     // -----------------------------------------------------------------------
 

diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java
@@ -32,6 +32,7 @@
 import org.apache.camel.builder.EndpointConsumerBuilder;
 import org.apache.camel.spi.AsEndpointUri;
 import org.apache.camel.spi.Metadata;
+import org.apache.camel.spi.Resource;
 import org.apache.camel.support.OrderedComparator;
 import org.apache.camel.support.PatternHelper;
 import org.slf4j.Logger;
@@ -64,6 +65,8 @@ public class RoutesDefinition extends OptionalIdentifiedDefinition<RoutesDefinit
     private CamelContext camelContext;
     @XmlTransient
     private ErrorHandlerFactory errorHandlerFactory;
+    @XmlTransient
+    private Resource resource;
 
     public RoutesDefinition() {
     }
@@ -151,6 +154,14 @@ public void setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory) {
         this.errorHandlerFactory = errorHandlerFactory;
     }
 
+    public Resource getResource() {
+        return resource;
+    }
+
+    public void setResource(Resource resource) {
+        this.resource = resource;
+    }
+
     // Fluent API
     // -------------------------------------------------------------------------
 
@@ -222,6 +233,9 @@ public void prepareRoute(RouteDefinition route) {
         // reset before preparing route
         route.resetPrepare();
 
+        // remember the source resource
+        route.setResource(resource);
+
         // merge global and route scoped together
         List<OnExceptionDefinition> oe = new ArrayList<>(onExceptions);
         List<InterceptDefinition> icp = new ArrayList<>(intercepts);

diff --git a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/RouteReifier.java b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/RouteReifier.java
@@ -99,7 +99,7 @@ protected Route doCreateRoute() throws Exception {
         String id = definition.idOrCreate(camelContext.adapt(ExtendedCamelContext.class).getNodeIdFactory());
         String desc = definition.getDescriptionText();
         Route route = camelContext.adapt(ExtendedCamelContext.class).getRouteFactory().createRoute(camelContext, definition, id,
-                desc, endpoint);
+                desc, endpoint, definition.getResource());
 
         // configure error handler
         route.setErrorHandlerFactory(definition.getErrorHandlerFactory());

diff --git a/...t/java/org/apache/camel/processor/exceptionpolicy/DefaultExceptionPolicyStrategyTest.java b/...t/java/org/apache/camel/processor/exceptionpolicy/DefaultExceptionPolicyStrategyTest.java
@@ -55,7 +55,7 @@ public class DefaultExceptionPolicyStrategyTest {
 
     private ExceptionPolicy exceptionPolicy(Class<? extends Throwable> exceptionClass) {
         CamelContext cc = new DefaultCamelContext();
-        Route context = new DefaultRoute(cc, null, null, null, null);
+        Route context = new DefaultRoute(cc, null, null, null, null, null);
         return new DefaultErrorHandlerReifier<>(context, null)
                 .createExceptionPolicy(new OnExceptionDefinition(exceptionClass));
     }

diff --git a/core/camel-core/src/test/java/org/apache/camel/reifier/ProcessorReifierTest.java b/core/camel-core/src/test/java/org/apache/camel/reifier/ProcessorReifierTest.java
@@ -25,7 +25,7 @@
 public class ProcessorReifierTest {
     @Test
     public void testHandleCustomProcessorDefinition() {
-        Route ctx = new DefaultRoute(null, null, null, null, null);
+        Route ctx = new DefaultRoute(null, null, null, null, null, null);
         ProcessorReifier.registerReifier(MyProcessorDefinition.class, ProcessReifier::new);
         ProcessReifier ref = (ProcessReifier) ProcessorReifier.reifier(ctx, new MyProcessorDefinition());
         Assertions.assertTrue(ref.definition instanceof MyProcessorDefinition);

diff --git a/...mel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/EndpointRouteBuilder.java b/...mel-endpointdsl/src/main/java/org/apache/camel/builder/endpoint/EndpointRouteBuilder.java
@@ -73,6 +73,7 @@ public static EndpointRouteBuilder loadEndpointRoutesBuilder(
             @Override
             public void configure() throws Exception {
                 CamelContextAware.trySetCamelContext(resource, getContext());
+                setResource(resource);
 
                 try (Reader reader = resource.getReader()) {
                     consumer.accept(reader, this);

diff --git a/...management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java b/...management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
@@ -35,6 +35,9 @@ public interface ManagedRouteMBean extends ManagedPerformanceCounterMBean {
     @ManagedAttribute(description = "Route Description")
     String getDescription();
 
+    @ManagedAttribute(description = "Route Source Location")
+    String getSourceLocation();
+
     @ManagedAttribute(description = "Route Configuration ID")
     String getRouteConfigurationId();
 

diff --git a/core/camel-management/src/main/java/org/apache/camel/management/mbean/ManagedRoute.java b/core/camel-management/src/main/java/org/apache/camel/management/mbean/ManagedRoute.java
@@ -72,6 +72,7 @@ public class ManagedRoute extends ManagedPerformanceCounter implements TimerList
     protected final Route route;
     protected final String description;
     protected final String configurationId;
+    protected final String sourceLocation;
     protected final CamelContext context;
     private final LoadTriplet load = new LoadTriplet();
     private final String jmxDomain;
@@ -81,6 +82,7 @@ public ManagedRoute(CamelContext context, Route route) {
         this.context = context;
         this.description = route.getDescription();
         this.configurationId = route.getConfigurationId();
+        this.sourceLocation = route.getSourceResource() != null ? route.getSourceResource().getLocation() : null;
         this.jmxDomain = context.getManagementStrategy().getManagementAgent().getMBeanObjectDomainName();
     }
 
@@ -144,6 +146,11 @@ public String getDescription() {
         return description;
     }
 
+    @Override
+    public String getSourceLocation() {
+        return sourceLocation;
+    }
+
     @Override
     public String getRouteConfigurationId() {
         return configurationId;