You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by GitBox <gi...@apache.org> on 2020/07/08 11:22:00 UTC
[GitHub] [camel-quarkus] lburgazzoli opened a new pull request #1464: improve bootstrap and configuration documentation
lburgazzoli opened a new pull request #1464:
URL: https://github.com/apache/camel-quarkus/pull/1464
[ ] An issue should be filed for the change unless this is a trivial change (fixing a typo or similar). One issue should ideally be fixed by not more than one commit and the other way round, each commit should fix just one issue, without pulling in other changes.
[ ] Each commit in the pull request should have a meaningful and properly spelled subject line and body. Copying the title of the associated issue is typically enough. Please include the issue number in the commit message prefixed by #.
[ ] The pull request description should explain what the pull request does, how, and why. If the info is available in the associated issue or some other external document, a link is enough.
[ ] Phrases like Fix #<issueNumber> or Fixes #<issueNumber> will auto-close the named issue upon merging the pull request. Using them is typically a good idea.
[ ] Please run mvn process-resources -Pformat (and amend the changes if necessary) before sending the pull request.
[ ] Contributor guide is your good friend: https://camel.apache.org/camel-quarkus/latest/contributor-guide.html
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on a change in pull request #1464: improve bootstrap and configuration documentation
Posted by GitBox <gi...@apache.org>.
jamesnetherton commented on a change in pull request #1464:
URL: https://github.com/apache/camel-quarkus/pull/1464#discussion_r451474961
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -34,16 +37,68 @@ public class Configurations {
}
}
----
+<1> Camel uses the uri scheme to look-up component from its registry wich requires to add the `@Named` annotation to the method otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
Review comment:
```suggestion
<1> Camel uses the component URI scheme to look-up components from its registry, this requires you to add the `@Named` annotation to the method, otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
```
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -34,16 +37,68 @@ public class Configurations {
}
}
----
+<1> Camel uses the uri scheme to look-up component from its registry wich requires to add the `@Named` annotation to the method otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
+
+Because in Camel Quarkus the Camel components are discovered during the Quarkus' augmentation phase, producing a new component as shown in the example above would invalidate any optimization that may have been made.
Review comment:
```suggestion
In Camel Quarkus the Camel components are discovered during the augmentation phase, producing a new component as shown in the example above would invalidate any optimization that may have been made.
```
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -34,16 +37,68 @@ public class Configurations {
}
}
----
+<1> Camel uses the uri scheme to look-up component from its registry wich requires to add the `@Named` annotation to the method otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
+
+Because in Camel Quarkus the Camel components are discovered during the Quarkus' augmentation phase, producing a new component as shown in the example above would invalidate any optimization that may have been made.
+
+As a better alternative you can use `@Inject` to obtain an instance of a component automatically created by Camel or you can observe one of the https://github.com/apache/camel-quarkus/tree/master/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/events[events] fired by Camel Quarkus as shown in the the following examplein in which we use `@Observes` to be notified about components added to the Camel Context:
+
+[source,java]
+----
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import org.apache.camel.quarkus.core.events.ComponentAddEvent;
+import org.apache.camel.component.log.LogComponent;
+
+@ApplicationScoped
+public static class EventHandler {
+ public void onComponentAdd(@Observes ComponentAddEvent event) {
+ if (event.getComponent() instanceof LogComponent) {
+ // do something with the log component
+ }
+ }
+}
+----
+
+== Camel Main
To configure components and other aspects of Apache Camel through properties, you can add the `camel-quarkus-main`
extension which brings functionalities from https://camel.apache.org/components/latest/others/main.html[Apache Camel
Main] to Camel Quarkus.
-In the example below, we perform the same configuration of the Log component via properties like we did above using Java:
+In the example below, we apply the same configuration as the one from the Java example above by using properties:
[source,properties]
----
camel.component.log.exchange-formtatter = #class:org.apache.camel.support.processor.DefaultExchangeFormatter
camel.component.log.exchange-formtatter.show-exchange-pattern = false
camel.component.log.exchange-formtatter.show-body-type = false
----
+
+In addition to support for configuring Camel through properties, `camel-quarkus-main` allows to use conventions to configure the Camel behavior as example, if there a single `ExchangeFormatter` instance in the CDI container, then it will automatically wire that bean to the `LogComponent`.
+
+Camel Main also brings the option to write https://quarkus.io/guides/command-mode-reference[Quarkus Command Mode Applications] with control about when the Camel runtime should start:
+
+[source,java]
+----
+import io.quarkus.runtime.Quarkus;
+import io.quarkus.runtime.annotations.QuarkusMain;
+import org.apache.camel.quarkus.main.CamelMainApplication;
+
+@QuarkusMain
+public class Main {
+ public static void main(String... args) {
+ //
+ // your logic here
+ //
+
+ Quarkus.run(CamelMainApplication.class, args); // <1>
+ }
+}
+----
+<1> Start Quarkus and the Camel Quarkus runtime
+
+[NOTE]
+====
+It is recommended to perform very little loginc in the Java Main.
Review comment:
```suggestion
It is recommended to perform very little logic in the Java Main.
```
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -1,12 +1,15 @@
-= Bootstrap Camel Quarkus
+= Bootstrap and configuration
Camel Quarkus automatically configures and deploys a Camel Context bean which by default is started/stopped according to
the Quarkus Application lifecycle. The configuration step happens at build time during Quarkus' augmentation phase and
it is driven by the Camel Quarkus extensions which can be tuned using Camel Quarkus specific `camel.quarkus.*`
properties. After the configuration is done, a minimal Camel Runtime is assembled and started at
-`https://quarkus.io/guides/writing-extensions#bootstrap-three-phases[RUNTIME_INIT]` time.
-At that point, any additional configuration should be done using CDI. Below is an example showing how to configure a
-Camel Component:
+https://quarkus.io/guides/writing-extensions#bootstrap-three-phases[RUNTIME_INIT] time.
+
+
+== CDI
+
+The https://quarkus.io/guides/cdi-reference[CDI] APIs can be used to configure the Camel behavior as example, to configure the `LogComponent` you can write a code like:
Review comment:
```suggestion
The https://quarkus.io/guides/cdi-reference[CDI] APIs can be used to configure various aspects of Camel behavior. For example, to configure the `LogComponent` you can write a code like:
```
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -34,16 +37,68 @@ public class Configurations {
}
}
----
+<1> Camel uses the uri scheme to look-up component from its registry wich requires to add the `@Named` annotation to the method otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
+
+Because in Camel Quarkus the Camel components are discovered during the Quarkus' augmentation phase, producing a new component as shown in the example above would invalidate any optimization that may have been made.
+
+As a better alternative you can use `@Inject` to obtain an instance of a component automatically created by Camel or you can observe one of the https://github.com/apache/camel-quarkus/tree/master/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/events[events] fired by Camel Quarkus as shown in the the following examplein in which we use `@Observes` to be notified about components added to the Camel Context:
Review comment:
```suggestion
As a better alternative you can use `@Inject` to obtain an instance of a component automatically created by Camel or you can observe one of the https://github.com/apache/camel-quarkus/tree/master/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/events[events] fired by Camel Quarkus as shown in the the following example, in which we use `@Observes` to be notified about components added to the Camel Context:
```
##########
File path: docs/modules/ROOT/pages/user-guide/bootstrap.adoc
##########
@@ -34,16 +37,68 @@ public class Configurations {
}
}
----
+<1> Camel uses the uri scheme to look-up component from its registry wich requires to add the `@Named` annotation to the method otherwise the CDI container would create an anonymous bean and Camel would not be able to look it up.
+
+Because in Camel Quarkus the Camel components are discovered during the Quarkus' augmentation phase, producing a new component as shown in the example above would invalidate any optimization that may have been made.
+
+As a better alternative you can use `@Inject` to obtain an instance of a component automatically created by Camel or you can observe one of the https://github.com/apache/camel-quarkus/tree/master/extensions-core/core/runtime/src/main/java/org/apache/camel/quarkus/core/events[events] fired by Camel Quarkus as shown in the the following examplein in which we use `@Observes` to be notified about components added to the Camel Context:
+
+[source,java]
+----
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import org.apache.camel.quarkus.core.events.ComponentAddEvent;
+import org.apache.camel.component.log.LogComponent;
+
+@ApplicationScoped
+public static class EventHandler {
+ public void onComponentAdd(@Observes ComponentAddEvent event) {
+ if (event.getComponent() instanceof LogComponent) {
+ // do something with the log component
+ }
+ }
+}
+----
+
+== Camel Main
To configure components and other aspects of Apache Camel through properties, you can add the `camel-quarkus-main`
extension which brings functionalities from https://camel.apache.org/components/latest/others/main.html[Apache Camel
Main] to Camel Quarkus.
-In the example below, we perform the same configuration of the Log component via properties like we did above using Java:
+In the example below, we apply the same configuration as the one from the Java example above by using properties:
[source,properties]
----
camel.component.log.exchange-formtatter = #class:org.apache.camel.support.processor.DefaultExchangeFormatter
camel.component.log.exchange-formtatter.show-exchange-pattern = false
camel.component.log.exchange-formtatter.show-body-type = false
----
+
+In addition to support for configuring Camel through properties, `camel-quarkus-main` allows to use conventions to configure the Camel behavior as example, if there a single `ExchangeFormatter` instance in the CDI container, then it will automatically wire that bean to the `LogComponent`.
Review comment:
```suggestion
In addition to support configuring Camel through properties, `camel-quarkus-main` allows you to use conventions to configure the Camel behavior. For example, if there is a single `ExchangeFormatter` instance in the CDI container, then it will automatically wire that bean to the `LogComponent`.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton merged pull request #1464: improve bootstrap and configuration documentation
Posted by GitBox <gi...@apache.org>.
jamesnetherton merged pull request #1464:
URL: https://github.com/apache/camel-quarkus/pull/1464
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org