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
commit f7f4b690f1e20e5265401be968bb7cb565c65314
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Mon Aug 9 13:36:41 2021 +0200
Polish and cleanup documentation
---
docs/user-manual/modules/ROOT/pages/building.adoc | 37 ++++---------
.../modules/ROOT/pages/camel-catalog.adoc | 4 +-
.../ROOT/pages/camel-component-maven-plugin.adoc | 3 -
.../ROOT/pages/camel-configuration-utilities.adoc | 64 +++++++++-------------
4 files changed, 40 insertions(+), 68 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/building.adoc
b/docs/user-manual/modules/ROOT/pages/building.adoc
index c6921a4..c4f83a6 100644
--- a/docs/user-manual/modules/ROOT/pages/building.adoc
+++ b/docs/user-manual/modules/ROOT/pages/building.adoc
@@ -11,9 +11,9 @@ Download a distribution or JAR.
*Required:*
* Java
-** 1.8 or 1.11
+** 1.8 or 11
-* https://github.com/takari/maven-wrapper[Maven Wrapper] is used and bundled.
+* https://github.com/takari/maven-wrapper[Maven Wrapper] can be used and
bundled.
* Otherwise, http://maven.apache.org/download.html[download and install Maven]
** Maven 3.6.x or newer is required to build Camel 3 onwards
@@ -28,7 +28,7 @@ To build camel maven has to be configured to use more memory
[[Building-UnixLinuxMac]]
Unix/Linux/Mac
-[source,text]
+[source,bash]
------------------------------------------------------------
export MAVEN_OPTS="-Xms2048m -Xmx3584m"
------------------------------------------------------------
@@ -37,7 +37,7 @@ export MAVEN_OPTS="-Xms2048m -Xmx3584m"
[[Building-Windows]]
Windows
-[source,text]
+[source,bash]
-------------------------------------------------------
set MAVEN_OPTS="-Xms2048m -Xmx3584m"
-------------------------------------------------------
@@ -45,9 +45,9 @@ set MAVEN_OPTS="-Xms2048m -Xmx3584m"
[[Building-Anormalbuild]]
== A normal build
-Beware this runs all the unit tests which takes a couple of hours.
+Beware this runs all the unit tests which takes many hours.
-[source,text]
+[source,bash]
-----------------
mvn clean install
-----------------
@@ -56,9 +56,9 @@ mvn clean install
== A quick build without running tests
The following skips building the manual, the distro and does not execute
-the unit tests, which can complete in 15-20 minutes.
+the unit tests, which can complete in less than 10 minutes.
-[source,text]
+[source,bash]
-------------------------------
mvn clean install -Pfastinstall
-------------------------------
@@ -66,7 +66,7 @@ mvn clean install -Pfastinstall
[[Building-Anormalbuildwithoutrunningtestsbutcheckstyleverificationenabled]]
== A normal build without running tests but checkstyle verification enabled
-[source,text]
+[source,bash]
-------------------------------------------
mvn clean install -Pfastinstall,sourcecheck
-------------------------------------------
@@ -75,9 +75,9 @@ mvn clean install -Pfastinstall,sourcecheck
== Building with checkstyle
To enable source style checking with checkstyle, build Camel with the
--Psourcecheck parameter
+`-Psourcecheck` parameter
-[source,text]
+[source,bash]
-------------------------------
mvn clean install -Psourcecheck
-------------------------------
@@ -89,21 +89,8 @@ If you want to build jar files with the source code, that
for instance
Eclipse can important so you can debug the Camel code as well. Then you
can run this command from the camel root folder:
-[source,text]
+[source,bash]
------------------------------------------
mvn clean source:jar install -Pfastinstall
------------------------------------------
-[[Building-Workingwithkaraffeatures]]
-== Working with karaf features
-
-If you change anything in the features.xml from `platform/karaf` you can
-run a validation step to ensure the generated features.xml file is
-correct. You can do this running the following maven goal from the
-`platform` directory.
-
-[source,text]
-----------------------------
-mvn clean install -Pvalidate
-----------------------------
-
diff --git a/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
b/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
index bc58710..9b252eb 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-catalog.adoc
@@ -1,8 +1,6 @@
[[CamelCatalog]]
= Camel Catalog
-*Since Camel 2.17*
-
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:
@@ -25,7 +23,7 @@ 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.
-The
xref:camel-report-maven-plugin.adoc#_running_the_goal_on_any_maven_project[Camel
Maven validation] plugin uses the catalog during validation of all the
+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
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 3273677..da6150f 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
@@ -19,10 +19,7 @@ This goal will generate the following metadata files and
Java files:
[NOTE]
====
-
-
In order for the plugin to work probably, you will need to have the proper
Camel annotations in your component. Example, `@Component` for component class,
`@UriEndpoint` for endpoint class, `@UriParams` ..etc. You can take a look at
these annotation how being used in any of the existing Camel components in
github. Or even better, you can use xref:camel-maven-archetypes.adoc[Camel
Maven Archetypes] to bootstrap the initial component, this already include all
the necessary batteries for yo [...]
-
====
== Adding the plugin to your pom.xml
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 dd58ade..251fc90 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-configuration-utilities.adoc
@@ -1,47 +1,40 @@
[[CamelConfigurationUtilities-JSSEUtility]]
= JSSE Utility
-The JSSE Utility, available as of *2.8*, allows you to easily configure
-aspects of the
-http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html[Java
+The JSSE Utility allows you to easily configure aspects of the
+https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[Java
Secure Socket Extension] (JSSE) API in order to greatly simplify the use
of custom transport layer security (TLS) settings on Camel components.
[[CamelConfigurationUtilities-SupportedComponents]]
== Supported Components
-The following Camel components directly support the use of this
-configuration utility:
+A number of Camel components support this such as::
* xref:components::http-component.adoc[HTTP]
* xref:components::jetty-component.adoc[Jetty]
* xref:components::ahc-component.adoc[AHC]
* xref:components::netty-component.adoc[Netty]
* xref:components::cometd-component.adoc[Cometd]
-* FTP2
* xref:components::irc-component.adoc[IRC]
* xref:components::mail-component.adoc[Mail]
-* MINA 2
-
-The following Camel components indirectly support the use of this
-configuration utility:
-
-* xref:components::cxf-component.adoc[CXF]
-* xref:components::http-component.adoc[HTTP]
[[CamelConfigurationUtilities-Configuration]]
== Configuration
The key component in configuring TLS through the JSSE API is the
-SSLContext. The
-http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLContext[SSLContext]
+SSLContext.
+
+The
http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLContext[SSLContext]
provides socket factories for both
-http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLSocketFactory[client-side]
+http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLSocketFactory[client-side]
and
-http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLSocketFactory[server-side]
+http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLSocketFactory[server-side]
sockets as well as another component called an
-http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLENG[SSLEngine]
-that is used by non-blocking IO to support TLS. The JSSE configuration
+http://download.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#SSLENG[SSLEngine]
+that is used by non-blocking IO to support TLS.
+
+The JSSE configuration
utility provides an easy to use builder for configuring these JSSE
components, among others, in a manner that allows you to provide all
configuration options up front during the initialization of your
@@ -80,7 +73,7 @@ SSLContextParameters (sslContextParameters) contain the
following elements:
* trustManagers (element)
* secureRandom (element)
* clientParameters (element)
-* serverParameters (elment)
+* serverParameters (element)
provider::
The optional provider identifier for the JSSE implementation to use when
@@ -93,7 +86,7 @@ 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::
-*Camel 2.13:* An optional certificate alias to use. This is useful when
+An optional certificate alias to use. This is useful when
the keystore has multiple certificates.
sessionTimeout::
This optional property defines the timeout period, in seconds, for
@@ -216,7 +209,7 @@
http://download.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefG
Secure Socket Extension Reference Guide] for information about standard
algorithm names.
trustManager::
-*Camel 2.17:* To use a existing configured trust manager instead of using
+To use a 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
@@ -290,7 +283,7 @@ excludes takes precedence over the include patterns.
SecureRandomParameters contain the following elements:
* algorithm (attribute)
-* provider (attribte)
+* provider (attribute)
algorithm::
This optional property represents the Random Number Generator (RNG)
algorithm identifier for the SecureRandom factory method used to create
@@ -370,11 +363,8 @@ See
<<CamelConfigurationUtilities-SSLContextServerParameters>>.
[[CamelConfigurationUtilities-Examples]]
== Examples
-[[CamelConfigurationUtilities-ProgrammaticUsage]]
-=== Programmatic Usage
-
[[CamelConfigurationUtilities-SettingClientAuthenticationOntheServerSide]]
-Setting Client Authentication On the Server Side
+=== Setting Client Authentication On the Server Side
This configuration sets the server side aspects of the TLS configuration
to require client authentication during the handshake process. This
@@ -403,7 +393,7 @@ SSLEngine engine = scp.createSSLEngine();
-------------------------------------------------------------------
[[CamelConfigurationUtilities-ConfiguringDifferentOptionsontheClientandServerSide]]
-Configuring Different Options on the Client and Server Side
+== Configuring Different Options on the Client and Server Side
In this example, both the client and server sides share the same custom
key store; however, the client side allows any supported cipher suite
@@ -436,7 +426,7 @@ SSLEngine engine = scp.createSSLEngine();
-------------------------------------------------------------------
[[CamelConfigurationUtilities-UsingCamelPropertyPlaceholders]]
-Using Camel Property Placeholders
+== Using Camel Property Placeholders
This configuration utility fully supports the use of property
placeholders (see xref:using-propertyplaceholder.adoc[Using
@@ -483,7 +473,7 @@ format.
====
[[CamelConfigurationUtilities-SettingClientAuthenticationOntheServerSide.1]]
-Setting Client Authentication On the Server Side
+=== Setting Client Authentication On the Server Side
This configuration sets the server side aspects of the TLS configuration
to require client authentication during the handshake process. This
@@ -519,7 +509,7 @@ SSLContext.
---------------------------------------------------------------------------------------------------------------
[[CamelConfigurationUtilities-ConfiguringDifferentOptionsontheClientandServerSide.1]]
-Configuring Different Options on the Client and Server Side
+=== Configuring Different Options on the Client and Server Side
In this example, both the client and server sides share the same custom
key store; however, the client side allows any supported cipher suite
@@ -554,7 +544,7 @@ exclude any cipher suites that match the patterns
.*_NULL_.* and
--------------------------------------------------------------
[[CamelConfigurationUtilities-UsingCamelPropertyPlaceholders.1]]
-Using Camel Property Placeholders
+=== Using Camel Property Placeholders
This configuration utility fully supports the use of property
placeholders (see xref:using-propertyplaceholder.adoc[Using
@@ -598,9 +588,9 @@ ID example is used to resolve the property placeholders.
---------------------------------------------------------------------------------------------------------------
[[CamelConfigurationUtilities-UsingSpringBoot.1]]
-Using Spring-Boot
+=== Using Spring-Boot
-As of *2.19.0*, Camel provides a global SSL configuration that can be
customized using the
+Camel provides a global SSL configuration that can be customized using the
spring-boot _application.properties_ or _application.yml_ file.
Components do not use the global SSL configuration by default, but this
behavior can
@@ -610,8 +600,8 @@ included in all components that support the global SSL
configuration.
The following example shows how to configure global SSL parameters (in
_application.yml_) and enable their
usage in the _camel-undertow_ component.
-[source,text]
----------------------------------------------------------------------------------------------------------------
+[source,yaml]
+----
camel:
# To enable global SSL in undertow
component:
@@ -630,4 +620,4 @@ camel:
resource: "/cacerts"
password: "changeit"
type: "jks"
----------------------------------------------------------------------------------------------------------------
+----
