CAMEL-15312: Renamed builder
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteTemplateParameterBuilder.java b/core/camel-core-engine/src/main/java/org/apache/camel/builder/TemplatedRouteBuilder.java
similarity index 70%
rename from core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteTemplateParameterBuilder.java
rename to core/camel-core-engine/src/main/java/org/apache/camel/builder/TemplatedRouteBuilder.java
index 52dc6a3..6b2d0ed 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/builder/RouteTemplateParameterBuilder.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/builder/TemplatedRouteBuilder.java
@@ -28,7 +28,7 @@
/**
* Fluent builder for adding new routes from route templates.
*/
-public final class RouteTemplateParameterBuilder {
+public final class TemplatedRouteBuilder {
private final CamelContext camelContext;
private final String routeTemplateId;
@@ -36,11 +36,18 @@
private final Map<String, Object> parameters = new HashMap<>();
private Consumer<RouteTemplateDefinition> handler;
- public static RouteTemplateParameterBuilder builder(CamelContext camelContext, String routeTemplateId) {
- return new RouteTemplateParameterBuilder(camelContext, routeTemplateId);
+ /**
+ * Creates a new {@link TemplatedRouteBuilder} to specify input parameters, and others, for the route template.
+ *
+ * @param camelContext the camel context
+ * @param routeTemplateId the id of the route template
+ * @return the builder
+ */
+ public static TemplatedRouteBuilder builder(CamelContext camelContext, String routeTemplateId) {
+ return new TemplatedRouteBuilder(camelContext, routeTemplateId);
}
- private RouteTemplateParameterBuilder(CamelContext camelContext, String routeTemplateId) {
+ private TemplatedRouteBuilder(CamelContext camelContext, String routeTemplateId) {
this.camelContext = camelContext;
this.routeTemplateId = routeTemplateId;
}
@@ -51,7 +58,7 @@
*
* @param routeId the route id
*/
- public RouteTemplateParameterBuilder routeId(String routeId) {
+ public TemplatedRouteBuilder routeId(String routeId) {
this.routeId = routeId;
return this;
}
@@ -62,17 +69,23 @@
* @param name parameter name
* @param value parameter value
*/
- public RouteTemplateParameterBuilder parameter(String name, Object value) {
+ public TemplatedRouteBuilder parameter(String name, Object value) {
parameters.put(name, value);
return this;
}
- public RouteTemplateParameterBuilder handler(Consumer<RouteTemplateDefinition> handler) {
+ /**
+ * Sets a handler which gives access to the route template model that will be used for creating the route.
+ * This can be used to do validation. Any changes to the model happens before the route is created and added,
+ * however these changes affect future usage of the same template.
+ *
+ * @param handler the handler with callback to invoke with the given route template
+ */
+ public TemplatedRouteBuilder handler(Consumer<RouteTemplateDefinition> handler) {
this.handler = handler;
return this;
}
-
/**
* Adds the route to the {@link CamelContext} which is built from the configured route template.
*
diff --git a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateBeforeContextStartingTest.java b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateBeforeContextStartingTest.java
index 33c13aa..0accda7 100644
--- a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateBeforeContextStartingTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateBeforeContextStartingTest.java
@@ -51,13 +51,13 @@
getMockEndpoint("mock:cheese").expectedBodiesReceived("Hello Cheese");
getMockEndpoint("mock:cake").expectedBodiesReceived("Hello Cake");
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.routeId("first")
.parameter("foo", "one")
.parameter("bar", "cheese")
.add();
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.routeId("second")
.parameter("foo", "two")
.parameter("bar", "cake")
diff --git a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateModelLifecycleTest.java b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateModelLifecycleTest.java
index c84d22c..c8d9f95 100644
--- a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateModelLifecycleTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateModelLifecycleTest.java
@@ -50,7 +50,7 @@
}
});
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.parameter("foo", "one")
.parameter("bar", "result")
.routeId("myRoute")
@@ -80,7 +80,7 @@
context.start();
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.parameter("foo", "one")
.parameter("bar", "result")
.routeId("myRoute")
diff --git a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateTest.java b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateTest.java
index b16bcf5..f5bb935 100644
--- a/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/builder/RouteTemplateTest.java
@@ -82,19 +82,19 @@
getMockEndpoint("mock:cheese").expectedBodiesReceived("Hello Cheese");
getMockEndpoint("mock:cake").expectedBodiesReceived("Hello Cake");
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.routeId("first")
.parameter("foo", "one")
.parameter("bar", "cheese")
.add();
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.routeId("first")
.parameter("foo", "one")
.parameter("bar", "cheese")
.add();
- RouteTemplateParameterBuilder.builder(context, "myTemplate")
+ TemplatedRouteBuilder.builder(context, "myTemplate")
.routeId("second")
.parameter("foo", "two")
.parameter("bar", "cake")
