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/12/30 12:04:29 UTC
[camel] 13/30: CAMEL-17384: Developer Console SPI
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch console
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9d4b7308d73cb07703edcdc31462959870182fac
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Mon Dec 27 16:53:55 2021 +0100
CAMEL-17384: Developer Console SPI
---
.../main/java/org/apache/camel/CamelContext.java | 12 +++++++----
.../camel/impl/engine/AbstractCamelContext.java | 12 +++++------
.../camel/impl/ExtendedCamelContextConfigurer.java | 12 +++++------
.../camel/impl/lw/LightweightCamelContext.java | 8 ++++----
.../impl/lw/LightweightRuntimeCamelContext.java | 4 ++--
.../MainConfigurationPropertiesConfigurer.java | 6 ++++++
.../camel-main-configuration-metadata.json | 1 +
core/camel-main/src/main/docs/main.adoc | 3 ++-
.../camel/main/DefaultConfigurationConfigurer.java | 1 +
.../camel/main/DefaultConfigurationProperties.java | 24 ++++++++++++++++++++++
.../java/org/apache/camel/main/KameletMain.java | 2 +-
11 files changed, 61 insertions(+), 24 deletions(-)
diff --git a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
index 3193799..e3b1111 100644
--- a/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
+++ b/core/camel-api/src/main/java/org/apache/camel/CamelContext.java
@@ -1187,14 +1187,18 @@ public interface CamelContext extends CamelContextLifecycle, RuntimeConfiguratio
void setLoadHealthChecks(Boolean loadHealthChecks);
/**
- * Whether to load custom dev consoles by scanning classpath.
+ * Whether to enable developer console (requires camel-console on classpath).
+ *
+ * The developer console is only for assisting during development. This is NOT for production usage.
*/
- Boolean isLoadDevConsoles();
+ Boolean isDevConsole();
/**
- * Whether to load custom dev consoles by scanning classpath.
+ * Whether to enable developer console (requires camel-console on classpath)
+ *
+ * The developer console is only for assisting during development. This is NOT for production usage.
*/
- void setLoadDevConsoles(Boolean loadDevConsoles);
+ void setDevConsole(Boolean loadDevConsoles);
/**
* Whether or not type converter statistics is enabled.
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
index 99e7ae1..2de27f3 100644
--- 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
@@ -263,7 +263,7 @@ public abstract class AbstractCamelContext extends BaseService
private Boolean disableJMX = Boolean.FALSE;
private Boolean loadTypeConverters = Boolean.FALSE;
private Boolean loadHealthChecks = Boolean.FALSE;
- private Boolean loadDevConsoles = Boolean.FALSE;
+ private Boolean devConsole = Boolean.FALSE;
private Boolean typeConverterStatisticsEnabled = Boolean.FALSE;
private Boolean dumpRoutes = Boolean.FALSE;
private Boolean useMDCLogging = Boolean.FALSE;
@@ -2770,7 +2770,7 @@ public abstract class AbstractCamelContext extends BaseService
startupStepRecorder.endStep(step3);
}
// ensure additional dev consoles is loaded
- if (loadDevConsoles) {
+ if (devConsole) {
StartupStep step4 = startupStepRecorder.beginStep(CamelContext.class, null, "Scan DevConsoles");
DevConsoleRegistry dcr = getExtension(DevConsoleRegistry.class);
if (dcr != null) {
@@ -4228,13 +4228,13 @@ public abstract class AbstractCamelContext extends BaseService
this.loadHealthChecks = loadHealthChecks;
}
- public Boolean isLoadDevConsoles() {
- return loadDevConsoles != null && loadDevConsoles;
+ public Boolean isDevConsole() {
+ return devConsole != null && devConsole;
}
@Override
- public void setLoadDevConsoles(Boolean loadDevConsoles) {
- this.loadDevConsoles = loadDevConsoles;
+ public void setDevConsole(Boolean loadDevConsoles) {
+ this.devConsole = loadDevConsoles;
}
@Override
diff --git a/core/camel-core-engine/src/generated/java/org/apache/camel/impl/ExtendedCamelContextConfigurer.java b/core/camel-core-engine/src/generated/java/org/apache/camel/impl/ExtendedCamelContextConfigurer.java
index 31ab8e8..a433692 100644
--- a/core/camel-core-engine/src/generated/java/org/apache/camel/impl/ExtendedCamelContextConfigurer.java
+++ b/core/camel-core-engine/src/generated/java/org/apache/camel/impl/ExtendedCamelContextConfigurer.java
@@ -61,6 +61,8 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "DeferServiceFactory": target.setDeferServiceFactory(property(camelContext, org.apache.camel.spi.DeferServiceFactory.class, value)); return true;
case "delayer":
case "Delayer": target.setDelayer(property(camelContext, java.lang.Long.class, value)); return true;
+ case "devconsole":
+ case "DevConsole": target.setDevConsole(property(camelContext, java.lang.Boolean.class, value)); return true;
case "devconsoleresolver":
case "DevConsoleResolver": target.setDevConsoleResolver(property(camelContext, org.apache.camel.console.DevConsoleResolver.class, value)); return true;
case "dumproutes":
@@ -95,8 +97,6 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "LanguageResolver": target.setLanguageResolver(property(camelContext, org.apache.camel.spi.LanguageResolver.class, value)); return true;
case "lightweight":
case "Lightweight": target.setLightweight(property(camelContext, boolean.class, value)); return true;
- case "loaddevconsoles":
- case "LoadDevConsoles": target.setLoadDevConsoles(property(camelContext, java.lang.Boolean.class, value)); return true;
case "loadhealthchecks":
case "LoadHealthChecks": target.setLoadHealthChecks(property(camelContext, java.lang.Boolean.class, value)); return true;
case "loadtypeconverters":
@@ -248,6 +248,8 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "DeferServiceFactory": return org.apache.camel.spi.DeferServiceFactory.class;
case "delayer":
case "Delayer": return java.lang.Long.class;
+ case "devconsole":
+ case "DevConsole": return java.lang.Boolean.class;
case "devconsoleresolver":
case "DevConsoleResolver": return org.apache.camel.console.DevConsoleResolver.class;
case "dumproutes":
@@ -282,8 +284,6 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "LanguageResolver": return org.apache.camel.spi.LanguageResolver.class;
case "lightweight":
case "Lightweight": return boolean.class;
- case "loaddevconsoles":
- case "LoadDevConsoles": return java.lang.Boolean.class;
case "loadhealthchecks":
case "LoadHealthChecks": return java.lang.Boolean.class;
case "loadtypeconverters":
@@ -436,6 +436,8 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "DeferServiceFactory": return target.getDeferServiceFactory();
case "delayer":
case "Delayer": return target.getDelayer();
+ case "devconsole":
+ case "DevConsole": return target.isDevConsole();
case "devconsoleresolver":
case "DevConsoleResolver": return target.getDevConsoleResolver();
case "dumproutes":
@@ -470,8 +472,6 @@ public class ExtendedCamelContextConfigurer extends org.apache.camel.support.com
case "LanguageResolver": return target.getLanguageResolver();
case "lightweight":
case "Lightweight": return target.isLightweight();
- case "loaddevconsoles":
- case "LoadDevConsoles": return target.isLoadDevConsoles();
case "loadhealthchecks":
case "LoadHealthChecks": return target.isLoadHealthChecks();
case "loadtypeconverters":
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightCamelContext.java b/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightCamelContext.java
index 41e15c4..9259fa5 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightCamelContext.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightCamelContext.java
@@ -901,13 +901,13 @@ public class LightweightCamelContext implements ExtendedCamelContext, CatalogCam
}
@Override
- public Boolean isLoadDevConsoles() {
- return delegate.isLoadDevConsoles();
+ public Boolean isDevConsole() {
+ return delegate.isDevConsole();
}
@Override
- public void setLoadDevConsoles(Boolean loadDevConsoles) {
- delegate.setLoadDevConsoles(loadDevConsoles);
+ public void setDevConsole(Boolean loadDevConsoles) {
+ delegate.setDevConsole(loadDevConsoles);
}
@Override
diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightRuntimeCamelContext.java b/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightRuntimeCamelContext.java
index 49cf2d8..ec2fc12 100644
--- a/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightRuntimeCamelContext.java
+++ b/core/camel-core-engine/src/main/java/org/apache/camel/impl/lw/LightweightRuntimeCamelContext.java
@@ -1201,12 +1201,12 @@ public class LightweightRuntimeCamelContext implements ExtendedCamelContext, Cat
}
@Override
- public Boolean isLoadDevConsoles() {
+ public Boolean isDevConsole() {
throw new UnsupportedOperationException();
}
@Override
- public void setLoadDevConsoles(Boolean loadDevConsoles) {
+ public void setDevConsole(Boolean loadDevConsoles) {
throw new UnsupportedOperationException();
}
diff --git a/core/camel-main/src/generated/java/org/apache/camel/main/MainConfigurationPropertiesConfigurer.java b/core/camel-main/src/generated/java/org/apache/camel/main/MainConfigurationPropertiesConfigurer.java
index 4025964..5ac8b2d 100644
--- a/core/camel-main/src/generated/java/org/apache/camel/main/MainConfigurationPropertiesConfigurer.java
+++ b/core/camel-main/src/generated/java/org/apache/camel/main/MainConfigurationPropertiesConfigurer.java
@@ -55,6 +55,8 @@ public class MainConfigurationPropertiesConfigurer extends org.apache.camel.supp
case "ConsumerTemplateCacheSize": target.setConsumerTemplateCacheSize(property(camelContext, int.class, value)); return true;
case "debugging":
case "Debugging": target.setDebugging(property(camelContext, boolean.class, value)); return true;
+ case "devconsoleenabled":
+ case "DevConsoleEnabled": target.setDevConsoleEnabled(property(camelContext, boolean.class, value)); return true;
case "dumproutes":
case "DumpRoutes": target.setDumpRoutes(property(camelContext, boolean.class, value)); return true;
case "durationhitexitcode":
@@ -270,6 +272,8 @@ public class MainConfigurationPropertiesConfigurer extends org.apache.camel.supp
case "ConsumerTemplateCacheSize": return int.class;
case "debugging":
case "Debugging": return boolean.class;
+ case "devconsoleenabled":
+ case "DevConsoleEnabled": return boolean.class;
case "dumproutes":
case "DumpRoutes": return boolean.class;
case "durationhitexitcode":
@@ -486,6 +490,8 @@ public class MainConfigurationPropertiesConfigurer extends org.apache.camel.supp
case "ConsumerTemplateCacheSize": return target.getConsumerTemplateCacheSize();
case "debugging":
case "Debugging": return target.isDebugging();
+ case "devconsoleenabled":
+ case "DevConsoleEnabled": return target.isDevConsoleEnabled();
case "dumproutes":
case "DumpRoutes": return target.isDumpRoutes();
case "durationhitexitcode":
diff --git a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index 6cdd85c..be7963c 100644
--- a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++ b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -27,6 +27,7 @@
{ "name": "camel.main.configurations", "description": "Sets the configuration objects used to configure the camel context.", "sourceType": "org.apache.camel.main.MainConfigurationProperties", "type": "object", "javaType": "java.util.List" },
{ "name": "camel.main.consumerTemplateCacheSize", "description": "Consumer template endpoints cache size.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type": "integer", "javaType": "int", "defaultValue": 1000 },
{ "name": "camel.main.debugging", "description": "Sets whether debugging is enabled or not. Default is false.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },
+ { "name": "camel.main.devConsoleEnabled", "description": "Whether to enable developer console (requires camel-console on classpath). The developer console is only for assisting during development. This is NOT for production usage.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean", "javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.dumpRoutes", "description": "If dumping is enabled then Camel will during startup dump all loaded routes (incl rests and route templates) represented as XML DSL into the log. This is intended for trouble shooting or to assist during development. Sensitive information that may be configured in the route endpoints could potentially be included in the dump output and is therefore not recommended to be used for production usage. This requires to have camel-xml-jaxb [...]
{ "name": "camel.main.durationHitExitCode", "description": "Sets the exit code for the application if duration was hit", "sourceType": "org.apache.camel.main.MainConfigurationProperties", "type": "integer", "javaType": "int" },
{ "name": "camel.main.durationMaxAction", "description": "Controls whether the Camel application should shutdown the JVM, or stop all routes, when duration max is triggered.", "sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type": "string", "javaType": "java.lang.String", "defaultValue": "shutdown", "enum": [ "shutdown", "stop" ] },
diff --git a/core/camel-main/src/main/docs/main.adoc b/core/camel-main/src/main/docs/main.adoc
index f9df45a..914d7e4 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -21,7 +21,7 @@ The following tables lists all the options:
// main options: START
=== Camel Main configurations
-The camel.main supports 104 options, which are listed below.
+The camel.main supports 105 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
@@ -43,6 +43,7 @@ The camel.main supports 104 options, which are listed below.
| *camel.main.configurations* | Sets the configuration objects used to configure the camel context. | | List
| *camel.main.consumerTemplate{zwsp}CacheSize* | Consumer template endpoints cache size. | 1000 | int
| *camel.main.debugging* | Sets whether debugging is enabled or not. Default is false. | false | boolean
+| *camel.main.devConsoleEnabled* | Whether to enable developer console (requires camel-console on classpath). The developer console is only for assisting during development. This is NOT for production usage. | false | boolean
| *camel.main.dumpRoutes* | If dumping is enabled then Camel will during startup dump all loaded routes (incl rests and route templates) represented as XML DSL into the log. This is intended for trouble shooting or to assist during development. Sensitive information that may be configured in the route endpoints could potentially be included in the dump output and is therefore not recommended to be used for production usage. This requires to have camel-xml-jaxb on the classpath to be able [...]
| *camel.main.durationHitExitCode* | Sets the exit code for the application if duration was hit | | int
| *camel.main.durationMaxAction* | Controls whether the Camel application should shutdown the JVM, or stop all routes, when duration max is triggered. | shutdown | String
diff --git a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationConfigurer.java b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationConfigurer.java
index 5f290b8..6e1f857 100644
--- a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationConfigurer.java
+++ b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationConfigurer.java
@@ -228,6 +228,7 @@ public final class DefaultConfigurationConfigurer {
camelContext.setMDCLoggingKeysPattern(config.getMdcLoggingKeysPattern());
camelContext.setLoadTypeConverters(config.isLoadTypeConverters());
camelContext.setLoadHealthChecks(config.isLoadHealthChecks());
+ camelContext.setDevConsole(config.isDevConsoleEnabled());
if (config.isRoutesReloadEnabled()) {
RouteWatcherReloadStrategy reloader = new RouteWatcherReloadStrategy(
config.getRoutesReloadDirectory(), config.isRoutesReloadDirectoryRecursive());
diff --git a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
index 53ed817..30c28e9 100644
--- a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
+++ b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
@@ -53,6 +53,7 @@ public abstract class DefaultConfigurationProperties<T> {
private int consumerTemplateCacheSize = 1000;
private boolean loadTypeConverters;
private boolean loadHealthChecks;
+ private boolean devConsoleEnabled;
private int logDebugMaxChars;
private boolean streamCachingEnabled;
private String streamCachingSpoolDirectory;
@@ -376,6 +377,19 @@ public abstract class DefaultConfigurationProperties<T> {
this.loadHealthChecks = loadHealthChecks;
}
+ public boolean isDevConsoleEnabled() {
+ return devConsoleEnabled;
+ }
+
+ /**
+ * Whether to enable developer console (requires camel-console on classpath).
+ *
+ * The developer console is only for assisting during development. This is NOT for production usage.
+ */
+ public void setDevConsoleEnabled(boolean devConsoleEnabled) {
+ this.devConsoleEnabled = devConsoleEnabled;
+ }
+
public int getLogDebugMaxChars() {
return logDebugMaxChars;
}
@@ -1585,6 +1599,16 @@ public abstract class DefaultConfigurationProperties<T> {
}
/**
+ * Whether to enable developer console (requires camel-console on classpath).
+ *
+ * The developer console is only for assisting during development. This is NOT for production usage.
+ */
+ public T withDevConsoleEnabled(boolean devConsoleEnabled) {
+ this.devConsoleEnabled = devConsoleEnabled;
+ return (T) this;
+ }
+
+ /**
* Is used to limit the maximum length of the logging Camel message bodies. If the message body is longer than the
* limit, the log message is clipped. Use -1 to have unlimited length. Use for example 1000 to log at most 1000
* characters.
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 924ba23..963c46b 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
@@ -173,7 +173,7 @@ public class KameletMain extends MainCommandLineSupport {
}
if (console) {
// turn on developer console
- answer.setLoadDevConsoles(true);
+ configure().withDevConsoleEnabled(true);
VertxHttpServer.registerConsole(answer);
}