You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by lb...@apache.org on 2020/01/28 11:22:37 UTC

[camel] branch master updated: Add a RouteBuilderLifecycleStrategy to intercept RouteBuilder related events

This is an automated email from the ASF dual-hosted git repository.

lburgazzoli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new 041ebb0  Add a RouteBuilderLifecycleStrategy to intercept RouteBuilder related events
041ebb0 is described below

commit 041ebb03ed508b7ff32e13ff4ef20f5241b4d00e
Author: lburgazzoli <lb...@gmail.com>
AuthorDate: Mon Jan 27 19:51:37 2020 +0100

    Add a RouteBuilderLifecycleStrategy to intercept RouteBuilder related events
---
 .../org/apache/camel/builder/RouteBuilder.java     | 30 +++++++++++++++++--
 .../builder/RouteBuilderLifecycleStrategy.java     | 34 ++++++++++++++++++++++
 .../org/apache/camel/builder/RouteBuilderTest.java | 29 ++++++++++++++++++
 3 files changed, 90 insertions(+), 3 deletions(-)

diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilder.java b/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilder.java
index 2d3e5d9..4fc6bef 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilder.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilder.java
@@ -71,6 +71,7 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
     private List<TransformerBuilder> transformerBuilders = new ArrayList<>();
     private List<ValidatorBuilder> validatorBuilders = new ArrayList<>();
     private RoutesDefinition routeCollection = new RoutesDefinition();
+    private final List<RouteBuilderLifecycleStrategy> lifecycleInterceptors = new ArrayList<>();
 
     public RouteBuilder() {
         this(null);
@@ -96,7 +97,7 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
     /**
      * Add routes to a context using a lambda expression. It can be used as
      * following:
-     * 
+     *
      * <pre>
      * RouteBuilder.addRoutes(context, rb ->
      *     rb.from("direct:inbound").bean(ProduceTemplateBean.class)));
@@ -209,7 +210,7 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
 
     /**
      * Create a new {@code TransformerBuilder}.
-     * 
+     *
      * @return the builder
      */
     public TransformerBuilder transformer() {
@@ -220,7 +221,7 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
 
     /**
      * Create a new {@code ValidatorBuilder}.
-     * 
+     *
      * @return the builder
      */
     public ValidatorBuilder validator() {
@@ -469,6 +470,20 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
         getRouteCollection().setErrorHandlerFactory(getErrorHandlerBuilder());
     }
 
+    /**
+     * Adds the given {@link RouteBuilderLifecycleStrategy} to be used.
+     */
+    public void addLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor) {
+        lifecycleInterceptors.add(interceptor);
+    }
+
+    /**
+     * Adds the given {@link RouteBuilderLifecycleStrategy}.
+     */
+    public void removeLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor) {
+        lifecycleInterceptors.remove(interceptor);
+    }
+
     // Implementation methods
     // -----------------------------------------------------------------------
     protected void checkInitialized() throws Exception {
@@ -478,12 +493,21 @@ public abstract class RouteBuilder extends BuilderSupport implements RoutesBuild
             if (camelContext.adapt(ExtendedCamelContext.class).getErrorHandlerFactory() instanceof ErrorHandlerBuilder) {
                 setErrorHandlerBuilder((ErrorHandlerBuilder)camelContext.adapt(ExtendedCamelContext.class).getErrorHandlerFactory());
             }
+
+            for (RouteBuilderLifecycleStrategy interceptor : lifecycleInterceptors) {
+                interceptor.beforeConfigure(this);
+            }
+
             configure();
             // mark all route definitions as custom prepared because
             // a route builder prepares the route definitions correctly already
             for (RouteDefinition route : getRouteCollection().getRoutes()) {
                 route.markPrepared();
             }
+
+            for (RouteBuilderLifecycleStrategy interceptor : lifecycleInterceptors) {
+                interceptor.afterConfigure(this);
+            }
         }
     }
 
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilderLifecycleStrategy.java b/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilderLifecycleStrategy.java
new file mode 100644
index 0000000..dc6b8d4
--- /dev/null
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteBuilderLifecycleStrategy.java
@@ -0,0 +1,34 @@
+/*
+ * 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.builder;
+
+/**
+ * Strategy for {@link RouteBuilder} lifecycle notifications.
+ */
+public interface RouteBuilderLifecycleStrategy {
+    /**
+     * This method is invoked before the {@link RouteBuilder#configure()} method is invoked.
+     */
+    default void beforeConfigure(RouteBuilder builder) {
+    }
+
+    /**
+     * This method is invoked after the {@link RouteBuilder#configure()} method is invoked.
+     */
+    default void afterConfigure(RouteBuilder builder) {
+    }
+}
diff --git a/core/camel-core/src/test/java/org/apache/camel/builder/RouteBuilderTest.java b/core/camel-core/src/test/java/org/apache/camel/builder/RouteBuilderTest.java
index 39adcdb..e5d6063 100644
--- a/core/camel-core/src/test/java/org/apache/camel/builder/RouteBuilderTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/builder/RouteBuilderTest.java
@@ -19,6 +19,7 @@ package org.apache.camel.builder;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicInteger;
 
 import org.apache.camel.CamelContext;
 import org.apache.camel.Channel;
@@ -542,4 +543,32 @@ public class RouteBuilderTest extends TestSupport {
 
         assertEquals(2, routes.size());
     }
+
+    @Test
+    public void testLifecycleInterceptor() throws Exception {
+        AtomicInteger before = new AtomicInteger();
+        AtomicInteger after = new AtomicInteger();
+
+        RouteBuilder builder = new RouteBuilder() {
+            public void configure() throws Exception {
+            }
+        };
+
+        builder.addLifecycleInterceptor(new RouteBuilderLifecycleStrategy() {
+            @Override
+            public void beforeConfigure(RouteBuilder builder) {
+                before.incrementAndGet();
+            }
+            @Override
+            public void afterConfigure(RouteBuilder builder) {
+                after.incrementAndGet();
+            }
+        });
+
+        DefaultCamelContext context = new DefaultCamelContext();
+        context.addRoutes(builder);
+
+        assertEquals(1, before.get());
+        assertEquals(1, after.get());
+    }
 }