This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 4b7c988 CAMEL-16861: Cleanup docs
4b7c988 is described below
commit 4b7c988c4df8357c3f193a2e314ea14c4b13674c
Author: Claus Ibsen <[email protected]>
AuthorDate: Mon Nov 1 10:38:44 2021 +0100
CAMEL-16861: Cleanup docs
---
docs/user-manual/modules/ROOT/nav.adoc | 1 -
.../user-manual/modules/ROOT/pages/camel-boot.adoc | 32 -----
.../modules/ROOT/pages/camel-catalog.adoc | 31 +++--
.../ROOT/pages/camel-component-maven-plugin.adoc | 10 +-
.../ROOT/pages/camel-configuration-utilities.adoc | 141 ++++++++++++---------
.../modules/ROOT/pages/camel-jbang.adoc | 18 +--
.../modules/ROOT/pages/camel-maven-archetypes.adoc | 4 +-
.../modules/ROOT/pages/camel-maven-plugin.adoc | 26 +---
.../ROOT/pages/camel-report-maven-plugin.adoc | 45 ++++---
docs/user-manual/modules/ROOT/pages/index.adoc | 1 -
10 files changed, 146 insertions(+), 163 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/nav.adoc
b/docs/user-manual/modules/ROOT/nav.adoc
index d842afb..d6a1623 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -5,7 +5,6 @@
** link:/community/books/[Books]
** xref:building.adoc[Building]
** xref:camel-jbang.adoc[Camel JBang]
-** xref:camel-boot.adoc[Camel Boot]
** xref:camel-maven-plugin.adoc[Camel Maven Plugin]
** xref:camel-component-maven-plugin.adoc[Camel Component Maven Plugin]
** xref:camel-report-maven-plugin.adoc[Camel Maven Report Plugin]
diff --git a/docs/user-manual/modules/ROOT/pages/camel-boot.adoc
b/docs/user-manual/modules/ROOT/pages/camel-boot.adoc
deleted file mode 100644
index 3dcfb1e..0000000
--- a/docs/user-manual/modules/ROOT/pages/camel-boot.adoc
+++ /dev/null
@@ -1,32 +0,0 @@
-= Camel Boot
-
-Camel lets you boot up a JVM process and configure Camel nicely using
-whichever dependency injection framework you choose.
-
-For each of the main dependency injection frameworks, Camel has a Main
-class with a `public static void run(String[] args)` function so that
-you can boot up your JVM which then also bootstraps the Dependency
-Injection framework to load all the camel contexts and services
-required.
-
-The following camel boot options are supported:
-
-[[CamelBoot-CDI]]
-== CDI
-
-Using the xref:components:others:cdi.adoc[camel-cdi module] you can boot up
your Camel
-Java process using the *org.apache.camel.cdi.Main* class
-
-[[CamelBoot-Spring]]
-== Spring
-
-Using the xref:components:others:spring-main.adoc[Spring] you can boot your
-Camel Java process using the *org.apache.camel.spring.Main* class
-
-[[CamelBoot-SpringBoot]]
-== Spring Boot
-
-You can combine Spring Boot with Camel using
-Camel's Spring Boot integration. In this case
-your application looks and feels like a regular Spring Boot application
-but with full Camel integration.
diff --git a/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
b/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
index 15f4b89..f08dc39 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
@@ -2,30 +2,38 @@
Each release includes a catalog with all sorts of information about what’s
included in the release.
-The catalog is shipped in an independent standalone camel-catalog JAR
containing the following information:
+== About Camel Catalog
-- List of all components, data formats, languages, EIPs, and everything else
in the
-release
-- Curated lists for Spring Boot and Apache Karaf runtime
+The catalog is shipped in an independent standalone `camel-catalog` JAR
containing the following information:
+
+- List of all components, data formats, languages, EIPs, and everything else
in the release
+- Curated lists for Camel Quarkus, Camel Spring Boot, and Camel Karaf runtimes
- JSON schema with extensive details for every option
- Human-readable documentation for every option
- Categorization of options (for example, find all database components)
- XML schema for the XML DSLs
- Maven Archetype Catalog of all the Camel archetypes
-- Component documentation as ascii doc
-- Validator for Camel endpoint and Simple language
-- API to create Camel endpoint URLs
-- Java API
+
+There is also a Java API for tooling:
+
+- validating Camel endpoints and the Simple language
+- creating Camel endpoint URLs
The catalog provides a wealth of information that tooling can tap into and use.
-For example,
https://plugins.jetbrains.com/plugin/9371-apache-camel-idea-plugin[Camel
tooling for IDEA],
https://marketplace.eclipse.org/content/language-support-apache-camel[Eclipse]
and
https://marketplace.visualstudio.com/items?itemName=redhat.vscode-apache-camel[VSCode]
uses the catalog in the editor
-to know all details about every EIP and component Camel supports.
+=== Tooling using Camel Catalog
+
+The following tools uses the catalog in their editor:
+
+- https://plugins.jetbrains.com/plugin/9371-apache-camel-idea-plugin[Camel
tooling for IDEA]
+- https://marketplace.eclipse.org/content/language-support-apache-camel[Camel
tooling for Eclipse]
+-
https://marketplace.visualstudio.com/items?itemName=redhat.vscode-apache-camel[Camel
tooling for VS Code]
+-
https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan[Camel
Karavan for VS Code]
The xref:camel-report-maven-plugin.adoc[Camel Maven validation] plugin uses
the catalog during validation of all the
Camel endpoints found while scanning the source code.
-== Layout of camel-catalog
+=== Layout of camel-catalog
JAR includes the information using the following directory layout:
@@ -38,7 +46,6 @@ org
├── archetypes (Maven archetype catalog)
├── components (JSON schema)
├── dataformats (JSON schema)
- ├── docs (Ascii docs)
├── languages (JSON schema)
├── main (JSON schema)
├── models (JSON schema)
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-component-maven-plugin.adoc
b/docs/user-manual/modules/ROOT/pages/camel-component-maven-plugin.adoc
index da6150f..b58c4bb 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-component-maven-plugin.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-component-maven-plugin.adoc
@@ -6,7 +6,10 @@ Maven Plugin] allows third party component developers to
generate all the necess
== Goals Supported
-=== :generate
+The following goals is supported:
+
+=== generate
+
This goal will generate the following metadata files and Java files:
* Jandex index: it will generate a Jandex index for used Java annotations
within the project which allows to more efficiency to search and load the
annotations to generate other metadata as mentioned below.
@@ -44,4 +47,7 @@ In case you *did not* use the Camel Maven Archetypes to
bootstrap the initial co
</plugin>
----
-This will attach this plugin `:generate` goal to Maven's `process-classes`, in
order to generate all the necessary files being describe above upon
compilation. Thus, `mvn test`, `mvn package`, `mvn verify` and `mvn install`
phases should run this plugin.
+This will attach the plugin `generate` goal to Maven's `process-classes`,
+in order to generate all the necessary files being described above upon
compilation.
+
+Thus, `mvn test`, `mvn package`, `mvn verify` and `mvn install` phases should
run this plugin.
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
b/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
index 1515f7b..491b875 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
@@ -5,7 +5,7 @@
https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-
Secure Socket Extension] (JSSE) API in order to greatly simplify the use
of custom transport layer security (TLS) settings on Camel components.
-== Supported Components
+== Supported JSSE Components
A number of Camel components support this (such as but not limited to):
@@ -17,7 +17,7 @@ A number of Camel components support this (such as but not
limited to):
* xref:components::netty-component.adoc[Netty]
* xref:components::mail-component.adoc[Mail]
-== Configuration
+== Configuring JSSE with Camel
The key component in configuring TLS through the JSSE API is the `SSLContext`.
@@ -55,11 +55,11 @@ contain the following elements:
provider::
The optional provider identifier for the JSSE implementation to use when
-constructing the SSLContext. If omitted, the standard provider look-up
+constructing the SSLContext. If omitted, the standard provider look-up
mechanism is used to resolve the provider.
secureSocketProtocol::
The optional secure socket protocol. See
https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html[Java
Security Standard Algorithm Names]
-for information about standard protocol names. If omitted, TLS is used by
default.
+for information about standard protocol names. If omitted, TLS is used by
default.
Note that this property is related to but distinctly different from the
secureSocketProtocols and secureSocketProtocolsFilter properties.
certAlias::
@@ -71,65 +71,75 @@ sessions on both the client and server side as well as in
the SSLEngine.
cipherSuites::
This optional property represents a collection of explicitly named
cipher suites to enable on both the client and server side as well as in
-the SSLEngine. These values take precedence over filters supplied in
-cipherSuitesFilter. The utility attempts to enable the listed cipher
-suites regardless of whether or not the JSSE provider actually supports
-them or not. This behavior guarantees that listed cipher suites are
-always enabled when listed. For a more lenient option, use
+the SSLEngine. These values take precedence over filters supplied in
+cipherSuitesFilter. The utility attempts to enable the listed cipher
+suites regardless of whether the JSSE provider actually supports
+them or not. This behavior guarantees that listed cipher suites are
+always enabled when listed. For a more lenient option, use
cipherSuitesFilter.
cipherSuitesFilter::
This optional property represents a collection of include and exclude
patterns for cipher suites to enable on both the client and server side
-as well as in the SSLEngine. The patterns are applied over only the
-available cipher suites. The exclude patterns have precedence over the
-include patterns. If no cipherSuites and no cipherSuitesFilter are
-present, the default patterns applied are: +
-Includes .\*; +
+as well as in the SSLEngine. The patterns are applied over only the
+available cipher suites. The excludes patterns have precedence over the
+includes patterns. If no cipherSuites and no cipherSuitesFilter are
+present, the default patterns applied are:
+
+[source,text]
+----
+Includes .\*;
Excludes .*_NULL_.*, .\*_anon_.*, .\*DES.*, .\*EXPORT.*, .\*MD5, .*RC4.*
+----
+
secureSocketProtocols::
This optional property represents a collection of explicitly named
secure socket protocols, such as SSLv3/TLS/etc., to enable on both the
-client and server side as well as in the SSLEngine. These values take
+client and server side as well as in the SSLEngine. These values take
precedence over filters supplied in secureSocketProtocolsFilter. The
-utility attempts to enable the listed protocols regardless of whether or
-not the JSSE provider actually supports them or not. This behavior
-guarantees that listed protocols are always enabled when listed. For a
+utility attempts to enable the listed protocols regardless of whether
+the JSSE provider actually supports them or not. This behavior
+guarantees that listed protocols are always enabled when listed. For a
more lenient option, use secureSocketProtocolsFilter.
secureSocketProtocolsFilter::
This optional property represents a collection of include and exclude
patterns for secure socket protocols to enable on both the client and
-server side as well as in the SSLEngine. The patterns are applied over
-only the available protocols. The exclude patterns have precedence over
-the include patterns. If no secureSocketProtocols and no
+server side as well as in the SSLEngine. The patterns are applied over
+only the available protocols. The excludes patterns have precedence over
+the includes patterns. If no secureSocketProtocols and no
secureSocketProtocolsFilter are present, the default patterns applied
-are: Includes .*
+are:
+
+[source,text]
+----
+Includes .*
+----
keyManagers::
This optional property configures the source of key material for
providing identity of client and server side connections as well as in
-the SSLEngine. If omitted, no source of key material is provided and
+the SSLEngine. If omitted, no source of key material is provided and
the SSLContext is suitable only for client-side usage when mutual
-authentication is not in use. You typically configure this property
+authentication is not in use. You typically configure this property
with a key store containing a client or server private key.
trustManagers::
This optional property configures the source of material for verifying
-trust of key material used in the handshake process. If omitted, the
-default trust manager is automatically used. See the
+trust of key material used in the handshake process. If omitted, the
+default trust manager is automatically used. See the
https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html#GUID-7D9F43B8-AABF-4C5B-93E6-3AFB18B66150[JSSE
documentation] for more information on how the default trust manager is
-configured. You typically configure this property with a key store
+configured. You typically configure this property with a key store
containing trusted CA certificates.
secureRandom::
This optional property configures the secure random number generator
-used by the client and server side as well as in the SSLEngine. If
+used by the client and server side as well as in the SSLEngine. If
omitted, the default secure random number generator is used.
clientParameters::
This optional property configures additional settings that apply only to
-the client side aspects of the SSLContext. If present, these settings
+the client side aspects of the SSLContext. If present, these settings
override the settings specified at the SSLContextParameters level.
serverParameters::
This optional property configures additional settings that apply only to
-the server side aspects of the SSLContext. If present, these settings
+the server side aspects of the SSLContext. If present, these settings
override the settings specified at the SSLContextParameters level.
@@ -150,18 +160,18 @@ PKCS#11, the key password may be provided through other
means and is
omitted entirely in this configuration.
provider::
The optional provider identifier for the KeyManagerFactory used to
-create the KeyManagers represented by this object's configuration. If
+create the KeyManagers represented by this object's configuration. If
omitted, the default look-up behavior is used.
algorithm::
The optional algorithm name for the KeyManagerFactory used to create the
-KeyManager represented by this object's configuration. See the
+KeyManager represented by this object's configuration. See the
https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html[Java
Secure Socket Extension Reference Guide] for information about standard
algorithm names.
keyStore::
This optional property represents the key store that provides key
-material to the key manager. This is typically configured with a key
-store containing a user or server private key. In some cases, such as
+material to the key manager. This is typically configured with a key
+store containing a user or server private key. In some cases, such as
when using PKCS#11, the key store is omitted entirely.
=== TrustManagersParameters
@@ -175,7 +185,7 @@ TrustManagersParameters contain the following elements:
provider::
The optional provider identifier for the TrustManagerFactory used to
-create the TrustManagers represented by this object's configuration. If
+create the TrustManagers represented by this object's configuration. If
omitted, the default look-up behavior is used.
algorithm::
The optional algorithm name for the TrustManagerFactory used to create
@@ -184,11 +194,12 @@
https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-
Secure Socket Extension Reference Guide] for information about standard
algorithm names.
trustManager::
-To use a existing configured trust manager instead of using
+To use an existing configured trust manager instead of using
TrustManagerFactory to get the TrustManager.
keyStore::
-See <<CamelConfigurationUtilities-KeyStoreParameters>>. This optional property
represents the key store that provides key
-material to the trust manager. This is typically configured with a key
+See <<CamelConfigurationUtilities-KeyStoreParameters>>.
+This optional property represents the key store that provides key
+material to the trust manager. This is typically configured with a key
store containing trusted CA certificates / public keys. In some cases,
such as when using PKCS#11, the key store is omitted entirely.
@@ -203,20 +214,20 @@ KeyStoreParameters contain the following elements:
* resource (attribute)
type::
-The optional type of the key store. See the
+The optional type of the key store. See the
https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html[Java
Security Standard Algorithm Names]
-for more information on standard names. If omitted, defaults to the default
+for more information on standard names. If omitted, defaults to the default
lookup mechanism as defined by `KeyStore.getDefaultType()`
password::
The optional password for reading/opening/verifying the key store.
provider::
The optional provider identifier for the provider used to create the
-KeyStores represented by this object's configuration. If omitted, the
+KeyStores represented by this object's configuration. If omitted, the
default look-up behavior is used.
resource::
This optional property represents the location of the key store resource
-to load the key store from. In some cases, the resource is omitted as
-the key store content is provided by other means. The loading of the
+to load the key store from. In some cases, the resource is omitted as
+the key store content is provided by other means. The loading of the
resource, if provided, is attempted by treating the resource as a file
path, a class path resource, and a URL in that order. An exception is
thrown if the resource cannot be resolved to readable input stream using
@@ -231,14 +242,16 @@ FilterParameters contain the following elements:
* exclude (element, multiple string)
include::
This optional property represents zero or more regular expression
-patterns for which matching values should be included. The list of
-excludes takes precedence over the include patterns.
+patterns for which matching values should be included. The list of
+excludes takes precedence over the includes patterns.
exclude::
This optional property represents zero or more regular expression
-patterns for which matching values should be included. The list of
-excludes takes precedence over the include patterns.
+patterns for which matching values should be included. The list of
+excludes takes precedence over the includes patterns.
+
=== SecureRandomParameters
+
SecureRandomParameters contain the following elements:
* algorithm (attribute)
@@ -252,9 +265,10 @@ for information about standard RNG algorithm names.
provider::
The optional provider identifier for the SecureRandom factory method
used to create the SecureRandom represented by this object's
-configuration. If omitted, the default look-up behavior is used.
+configuration. If omitted, the default look-up behavior is used.
=== SSLContextServerParameters
+
SSLContextServerParameters contain the following elements:
* clientAuthentication (attribute)
@@ -267,32 +281,34 @@ SSLContextServerParameters contain the following elements:
clientAuthentication::
This optional property indicates if the server side does not request,
requests, or requires clients to provide authentication credentials
-during the handshake process. This is commonly referred to as mutual
-authentication, two direction SSL/TLS, or two-legged SSL/TLS. +
- Valid values are: NONE, WANT, REQUIRE
+during the handshake process. This is commonly referred to as mutual
+authentication, two direction SSL/TLS, or two-legged SSL/TLS.
+Valid values are: NONE, WANT, REQUIRE
+
sessionTimeout::
This optional property defines the timeout period, in seconds, for
-sessions on the server side. This setting affects both the
-SSLServerSocketFactory/SSLServerSocket as well as the server side of the
+sessions on the server side. This setting affects both the
+SSLServerSocketFactory/SSLServerSocket and the server side of the
SSLEngine.
cipherSuites::
This optional property overrides the value of this
-setting in the SSLContextParameters. This option has no affect on the
+setting in the SSLContextParameters. This option has no effect on the
SSLEngine configuration.
cipherSuitesFilter::
This optional property overrides the value of this
-setting in the SSLContextParameters. This option has no affect on the
+setting in the SSLContextParameters. This option has no effect on the
SSLEngine configuration.
secureSocketProtocols::
This optional property overrides the
-value of this setting in the SSLContextParameters. This option has no
-affect on the SSLEngine configuration.
+value of this setting in the SSLContextParameters. This option has no
+effect on the SSLEngine configuration.
secureSocketProtocolsFilter::
This optional property overrides the value of this
-setting in the SSLContextParameters. This option has no affect on the
+setting in the SSLContextParameters. This option has no effect on the
SSLEngine configuration.
=== SSLContextClientParameters
+
SSLContextClientParameters contains the following elements:
* sniHostNames (elements)
@@ -351,8 +367,13 @@ SSLEngine engine = scp.createSSLEngine();
In this example, both the client and server sides share the same custom
key store; however, the client side allows any supported cipher suite
while the server side will use the default cipher suite filter and
-exclude any cipher suites that match the patterns .*_NULL_.* and
-.*_anon_.*.
+exclude any cipher suites that match the patterns:
+
+[source,text]
+----
+.*_NULL_.*
+.*_anon_.*
+----
[source,java]
-------------------------------------------------------------------
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
index 9dd4c0c..add02b4 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang.adoc
@@ -1,9 +1,9 @@
= Camel JBang
-A JBang-based Camel app for searching for kamelets, components, languages,
running routes. This component is available from *Camel 3.12* and newer
versions.
+A JBang-based Camel app for searching for kamelets, components, languages,
running routes.
+The `camel-jbang` is available from *Camel 3.12* and newer versions.
-[[CamelJBang-Installation]]
== Installation
JBang makes it easy for us by providing an installation feature that works
with Github. If you have JBang installed on your system, then you can run the
following command to install CamelJBang:
@@ -13,9 +13,7 @@ JBang makes it easy for us by providing an installation
feature that works with
jbang app install CamelJBang@apache/camel
----
-
-[[CamelJBang-Usage]]
-== Usage
+== Using Camel JBang
The CamelJBang supports multiple commands. Running the command below, will
print all of them:
@@ -26,8 +24,7 @@ CamelJBang.java [command]
All the commands support the `--help` and will display the appropriate help if
that flag is provided.
-[[CamelJBang-Search]]
-== Search
+=== Search
You can use the CLI to search for kamelets, components, languages and
miscelaneous components (others). Running the following command will present a
list of items that can be searched:
@@ -71,8 +68,7 @@ The same behavior also works for all the other search
commands. The table below
|===
-[[CamelJBang-Init-Kamets]]
-== Init Kamelets
+=== Init Kamelets
The init sub-command can be used to simplify creating Kamelets. Through this
command, it is possible to create new Kamelets through pre-configured
templates. It works in two steps: first it is necessary to bootstrap the
Kamelet by creating a properties file with the parameters necessary to create
the Kamelet. Once the properties file is correctly set, then it is possible to
create a pre-filled Kamelet by processing that properties file.
@@ -99,8 +95,7 @@ Running this command will create a new file in the `work`
directory. The name of
After the file is generated, it may still need to require final adjustments,
such as correctly setting the name, the icon and other requirements for
official Kamelets. Please consult the Kamelet development documentation for
updated details.
-[[CamelJBang-Init-Bindings]]
-== Init Bindings
+=== Init Bindings
The init sub-command can also be used to simplify creating Kamelets bindings.
Through this command, it is possible to create new bindings through
pre-configured templates. Use the `--kamelet` option (you can list the
available ones using the search command) to set the Kamelet to generate the
binding for.
@@ -121,7 +116,6 @@ CamelJBang init binding --destination
/path/to/destination/directory/ --kamelet
----
-[[CamelJBang-Running]]
== Running Routes
At the moment it is possible to run YAML-based routes which also refer to
Kamelets in the catalog.
diff --git a/docs/user-manual/modules/ROOT/pages/camel-maven-archetypes.adoc
b/docs/user-manual/modules/ROOT/pages/camel-maven-archetypes.adoc
index 18ef1f6..340c0dc 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-maven-archetypes.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-maven-archetypes.adoc
@@ -2,7 +2,6 @@
Camel is distributed with the following archetypes for Maven end users.
-[[CamelMavenArchetypes-ArchetypeSupported]]
== Archetype Supported
[width="100%",cols="50%,50%",options="header",]
@@ -58,8 +57,7 @@ The maven coordinates for these archetypes is the following:
</dependency>
----
-[[CamelMavenArchetypes-Snapshotarchetypes]]
-== Snapshot archetypes
+=== Snapshot Archetypes
If you would like to use an archetype from an unreleased version of
Camel, you just need to let the maven-archetype-plugin know where to
diff --git a/docs/user-manual/modules/ROOT/pages/camel-maven-plugin.adoc
b/docs/user-manual/modules/ROOT/pages/camel-maven-plugin.adoc
index d7e134d..168e7fd 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-maven-plugin.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-maven-plugin.adoc
@@ -10,8 +10,9 @@ The Camel Maven Plugin supports the following goals
The `camel:run` goal of the Camel Maven Plugin is used to run your Camel
Spring configurations in a forked JVM from Maven.
A good example application to get you started is the Spring Example.
+[source,bash]
----
-cd examples/camel-example-spring
+cd examples/spring
mvn camel:run
----
@@ -27,6 +28,7 @@ If you want to boot up your Camel routes a little faster, you
could try the `cam
The maven plugin *run* goal supports the following options which can be
configured from the command line (use `-D` syntax), or defined in the `pom.xml`
file in the `<configuration>` tag.
+[width="100%",cols="2,2,6",options="header",]
|===
| Parameter | Default Value | Description
| duration | -1 | Sets the time duration (seconds) that the application will
run for before terminating. A value <= 0 will run forever.
@@ -49,6 +51,7 @@ You should add the CDI container of your choice (e.g. Weld or
OpenWebBeans) to t
From the source of Camel you can run a CDI example via
+[source,bash]
----
cd examples/camel-example-cdi
mvn compile camel:run
@@ -70,27 +73,6 @@ You can enable this in the configuration using:
</plugin>
----
-=== Using live reload of XML files
-
-You can configure the plugin to scan for XML file changes and trigger a reload
of the Camel routes which are contained in those XML files.
-
-[source,xml]
-----
-<plugin>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-maven-plugin</artifactId>
- <configuration>
-
<fileWatcherDirectory>src/main/resources/META-INF/spring</fileWatcherDirectory>
- </configuration>
-</plugin>
-----
-
-Then the plugin watches this directory. This allows you to edit the source
code from your editor and save the file, and have
- the running Camel application pickup those changes.
-
-Notice its only changes of Camel routes, eg `<routes>`, or `<route>` which is
supported.
-You cannot change Spring or OSGi Blueprint `<bean>` elements.
-
== camel:prepare-fatjar
diff --git a/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
b/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
index 8167e8f..7e05009 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-report-maven-plugin.adoc
@@ -15,8 +15,9 @@ For validating the source code for mis configured Camel:
- seda/direct endpoint pairs
- configuration in properties files
-Then you can run the validate goal from the command line or from within your
Java editor such as IDEA or Eclipse.
+Then you can run validate goal from the command line or from within your Java
editor such as IDEA or Eclipse.
+[source,bash]
----
mvn camel-report:validate
----
@@ -66,38 +67,41 @@ changed accordingly to `process-test-classes` as shown
below:
=== Running the goal on any Maven project
-You can also run the validate goal on any Maven project without having to add
the plugin to the `pom.xml` file.
+You can also run validate goal on any Maven project without having to add the
plugin to the `pom.xml` file.
Doing so requires to specify the plugin using its fully qualified name. For
example to run the goal on
-the `camel-example-cdi` from Apache Camel you can run
+the `cdi` from Apache Camel you can run
+[source,bash]
----
-$cd camel-example-cdi
-$mvn org.apache.camel:camel-report-maven-plugin:2.20.0:validate
+$cd examples/cdi
+$mvn org.apache.camel:camel-report-maven-plugin:3.13.0:validate
----
which then runs and outputs the following:
----
[INFO] ------------------------------------------------------------------------
-[INFO] Building Camel :: Example :: CDI 3.0.0
+[INFO] Building Camel :: Example :: CDI 3.13.0
[INFO] ------------------------------------------------------------------------
[INFO]
-[INFO] --- camel-report-maven-plugin:3.0.0:validate (default-cli) @
camel-example-cdi ---
-[INFO] Endpoint validation success: (4 = passed, 0 = invalid, 0 = incapable, 0
= unknown components)
+[INFO] --- camel-report-maven-plugin:3.13.0:validate (default-cli) @
camel-example-cdi ---
+[INFO] Endpoint validation success: (5 = passed, 0 = invalid, 0 = incapable, 0
= unknown components, 0 = deprecated options)
[INFO] Simple validation success: (0 = passed, 0 = invalid)
+[INFO] Endpoint pair (seda/direct) validation success: (0 = pairs)
+[INFO] Duplicate route id validation success: (0 = ids)
+[INFO] Configuration validation success: (0 = passed, 0 = invalid, 0 =
incapable, 0 = unknown components, 0 = deprecated options)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
----
-The validation passed, and 4 endpoints was validated. Now suppose we made a
typo in one of the Camel endpoint uris in the source code, such as:
+The validation passed, and 5 endpoints was validated. Now suppose we made a
typo in one of the Camel endpoint uris in the source code, such as:
[source,java]
----
@Uri("timer:foo?period=5000")
----
-
is changed to include a typo error in the `period` option
[source,java]
@@ -105,15 +109,15 @@ is changed to include a typo error in the `period` option
@Uri("timer:foo?perid=5000")
----
-And when running the validate goal again reports the following:
+And when running validate goal again reports the following:
----
[INFO] ------------------------------------------------------------------------
-[INFO] Building Camel :: Example :: CDI 3.0.0
+[INFO] Building Camel :: Example :: CDI 3.13.0
[INFO] ------------------------------------------------------------------------
[INFO]
-[INFO] --- camel-report-maven-plugin:3.0.0:validate (default-cli) @
camel-example-cdi ---
-[WARNING] Endpoint validation error at:
org.apache.camel.example.cdi.MyRoutes(MyRoutes.java:32)
+[INFO] --- camel-report-maven-plugin:3.13.0:validate (default-cli) @
camel-example-cdi ---
+[WARNING] Endpoint validation error at:
org.apache.camel.example.cdi.MyRoutes(MyRoutes.java:31)
timer:foo?perid=5000
@@ -155,6 +159,7 @@ The maven plugin *validate* goal supports the following
options which can be con
For example to turn off ignoring usage of deprecated options from the command
line, you can run:
+[source,bash]
----
$mvn camel-report:validate -Dcamel.ignoreDeprecated=true
----
@@ -166,6 +171,7 @@ Notice that you must prefix the `-D` command argument with
`camel.`, eg `camel.i
If you have a Maven project then you can run the plugin to validate the
endpoints in the unit test source code as well.
You can pass in the options using `-D` style as shown:
+[source,bash]
----
$cd myproject
$mvn org.apache.camel:camel-report-maven-plugin:3.0.0:validate
-DincludeTest=true
@@ -220,6 +226,7 @@ This can be done either in the configuration of the
`maven-surefire-plugin`:
Or from the command line when running tests:
+[source,bash]
----
mvn clean test -DCamelTestRouteCoverage=true
----
@@ -239,7 +246,7 @@ public class FooApplicationTest {
==== Enabling via isDumpRouteCoverage method
-However if you are using `camel-test` and your unit tests are extending
`CamelTestSupport` then you can
+However, if you are using `camel-test-junit5` and your unit tests are
extending `CamelTestSupport` then you can
turn on route coverage as shown:
[source,java]
@@ -250,7 +257,7 @@ public boolean isDumpRouteCoverage() {
}
----
-Routes that can be route coveraged must have an unique id assigned, in other
words you cannot use anonymous routes.
+Routes that can be route covered must have a unique id assigned, in other
words you cannot use anonymous routes.
You do this using `routeId` in Java DSL:
@@ -276,20 +283,22 @@ And in XML DSL you just assign the route id via the id
attribute
After unit testing with:
+[source,bash]
----
mvn test
----
You can then run the goal to report the route coverage
+[source,bash]
----
mvn camel-report:route-coverage
----
-Which then reports which routes has missing route coverage with precise source
code line reporting:
+Which then reports which routes have missing route coverage with precise
source code line reporting:
----
-[INFO] --- camel-camel-report-plugin:3.0.0:route-coverage (default-cli) @
camel-example-spring-boot-xml ---
+[INFO] --- camel-camel-report-plugin:3.13.0:route-coverage (default-cli) @
camel-example-spring-boot-xml ---
[INFO] Discovered 1 routes
[INFO] Route coverage summary:
diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc
b/docs/user-manual/modules/ROOT/pages/index.adoc
index 828ce11..9f0e78f 100644
--- a/docs/user-manual/modules/ROOT/pages/index.adoc
+++ b/docs/user-manual/modules/ROOT/pages/index.adoc
@@ -43,7 +43,6 @@ For a deeper and better understanding of Apache Camel, an
xref:faq:what-is-camel
* xref:getting-started.adoc[Getting Started]
* xref:book-getting-started.adoc[Longer Getting Started Guide]
-* xref:camel-boot.adoc[Camel Boot]
* xref:components:others:cdi.adoc[Working with Camel and CDI]
* xref:spring.adoc[Working with Camel and Spring]
* xref:faq:how-do-i-configure-endpoints.adoc[How do I configure endpoints?]
