You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/17 10:42:15 UTC
(camel) branch main updated (6498af9cedd -> ef11dd0a0e0)
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
from 6498af9cedd CAMEL-20433: camel-jbang - Log command sorting when logging muliple integrations can cause sort error.
new 6924961c501 CAMEL-20410: documentation fixes for camel-platform-http
new 44a0a3f060f CAMEL-20410: documentation fixes for camel-platform-http-main
new ef11dd0a0e0 CAMEL-20410: documentation fixes for camel-platform-http-vertx
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../src/main/docs/platform-http-main.adoc | 8 ++++----
.../src/main/docs/platform-http-vertx.adoc | 19 +++++++++----------
.../src/main/docs/platform-http-component.adoc | 18 ++++++++++++------
3 files changed, 25 insertions(+), 20 deletions(-)
(camel) 02/03: CAMEL-20410: documentation fixes for camel-platform-http-main
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 44a0a3f060ff55af2fb75ad2263484d5dc36c4aa
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 09:29:29 2024 +0100
CAMEL-20410: documentation fixes for camel-platform-http-main
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/platform-http-main.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/components/camel-platform-http-main/src/main/docs/platform-http-main.adoc b/components/camel-platform-http-main/src/main/docs/platform-http-main.adoc
index 71f723ae80a..e99e970bf95 100644
--- a/components/camel-platform-http-main/src/main/docs/platform-http-main.adoc
+++ b/components/camel-platform-http-main/src/main/docs/platform-http-main.adoc
@@ -15,13 +15,13 @@ The embedded HTTP server is using VertX from the `camel-platform-http-vertx` dep
== Enabling
-The HTTP server for `camel-main` (is default disabled), and you need to explicit enable this
+The HTTP server for `camel-main` is disabled by default, and you need to explicitly enable this
by setting `camel.server.enabled=true` in application.properties.
-== Auto detection from classpath
+== Auto-detection from classpath
-To use this implementation all you need to do is to add the `camel-platform-http-main` dependency to the classpath,
-and the platform http component should auto-detect this.
+To use this implementation all you need to do is to add the `camel-platform-http-main` dependency to the classpath.
+Then, the platform http component should auto-detect this.
== See More
(camel) 03/03: CAMEL-20410: documentation fixes for camel-platform-http-vertx
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit ef11dd0a0e080c8e81fea86e65723a3930b52fce
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 09:37:14 2024 +0100
CAMEL-20410: documentation fixes for camel-platform-http-vertx
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/platform-http-vertx.adoc | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
index ad9bff498f2..6b03844f1f4 100644
--- a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
+++ b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
@@ -13,10 +13,10 @@ The camel-platform-http-vertx is a Vert.x based implementation of the `PlatformH
== Vert.x Route
-This implementation will by default lookup an instance of `VertxPlatformHttpRouter` on the registry however you can
+This implementation will by default lookup the instance of `VertxPlatformHttpRouter` on the registry, however, you can
configure an existing instance using the getter/setter on the `VertxPlatformHttpEngine` class.
-== Auto detection from classpath
+== Auto-detection from classpath
To use this implementation all you need to do is to add the `camel-platform-http-vertx` dependency to the classpath,
and the platform http component should auto-detect this.
@@ -32,11 +32,10 @@ and the platform http component should auto-detect this.
|`CamelVertxPlatformHttpRemoteAddress` |`io.vertx.core.net.SocketAddress` |The remote address for the connection if present on the Vert.x Web `RoutingContext`.
|=======================================================================
-Camel also populates *all* request.parameter and Camel also populates *all* request.parameter and request.headers. For
-example, given a client request with the URL,
+Camel also populates *all* `request.parameter` and Camel also populates *all* `request.headers`.
+For example, given a client request with the URL,
`\http://myserver/myserver?orderid=123`, the exchange will contain a
-header named `orderid` with the value 123.
-request.headers. For example, given a client request with the URL, `\http://myserver/myserver?orderid=123`, the exchange will contain a header named `orderid` with the value 123.
+header named `orderid` with value `123`.
== VertxPlatformHttpServer
@@ -68,7 +67,7 @@ context.start();
Platform HTTP component can act as a reverse proxy, in that case `Exchange.HTTP_URI`, `Exchange.HTTP_HOST` headers are populated from the absolute URL received on the request line of the HTTP request.
-Here's an example of a HTTP proxy that simply redirects the Exchange to the origin server.
+Here's an example of an HTTP proxy that simply redirects the Exchange to the origin server.
[source,java]
----
@@ -85,7 +84,7 @@ Camel `HttpMessage` as shown in the custom `Processor` below :
[source,java]
----
.process(exchange -> {
- // grab message as HttpMessage
+ // grab the message as HttpMessage
HttpMessage message = exchange.getMessage(HttpMessage.class);
// use getRequest() / getResponse() to access Vertx directly
// you can add custom headers
@@ -115,8 +114,8 @@ Http authentication is disabled by default. In can be enabled by calling `setEna
Default http authentication takes http-basic credentials and compares them with those provided in camel-platform-http-vertx-auth.properties file.
To be more specific, default http authentication uses https://vertx.io/docs/apidocs/io/vertx/ext/web/handler/BasicAuthHandler.html[BasicAuthHandler] and https://vertx.io/docs/vertx-auth-properties/java/[PropertyFileAuthentication].
-To set up custom authentication, you need to create custom `AuthenticationConfigEntries`, as shown in example below.
-Mind that in Vert.x order of adding `AuthenticationHandlers` matters, so `AuthenticationConfigEntries` with more specific url path are applied first.
+To set up custom authentication, you need to create custom `AuthenticationConfigEntries`, as shown in the example below.
+Mind that in Vert.x order of adding `AuthenticationHandlers` matters, so `AuthenticationConfigEntries` with a more specific url path is applied first.
[source,java]
----
(camel) 01/03: CAMEL-20410: documentation fixes for camel-platform-http
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6924961c5012eb8214a2d30931d3e71ad2b61607
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sat Feb 17 09:27:07 2024 +0100
CAMEL-20410: documentation fixes for camel-platform-http
- Fixed samples
- Converted to use tabs
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/platform-http-component.adoc | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/components/camel-platform-http/src/main/docs/platform-http-component.adoc b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
index 7fe9993fd7b..6d67c31b7bb 100644
--- a/components/camel-platform-http/src/main/docs/platform-http-component.adoc
+++ b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
@@ -15,7 +15,7 @@
*{component-header}*
The Platform HTTP is used to allow Camel to use the existing HTTP server from the runtime.
-For example when running Camel on Spring Boot, Quarkus, or other runtimes.
+For example, when running Camel on Spring Boot, Quarkus, or other runtimes.
Maven users will need to add the following dependency to their `pom.xml` for this component:
@@ -31,11 +31,15 @@ Maven users will need to add the following dependency to their `pom.xml` for thi
== Platform HTTP Provider
-To use Platform HTTP a provider (engine) is required to be available on the classpath.
+To use Platform HTTP, a provider (engine) is required to be available on the classpath.
The purpose is to have drivers for different runtimes such as Quarkus, or Spring Boot.
-To use Quarkus:
+To use it with different runtimes:
+[tabs]
+====
+Quarkus::
++
[source,xml]
----
<dependency>
@@ -46,8 +50,8 @@ To use Quarkus:
</dependency>
----
-And for Spring Boot:
-
+Spring Boot::
++
[source,xml]
----
<dependency>
@@ -57,6 +61,8 @@ And for Spring Boot:
<!-- use the same version as your Camel version -->
</dependency>
----
+====
+
// component-configure options: START
@@ -75,6 +81,6 @@ include::spring-boot:partial$starter.adoc[]
== Implementing a reverse proxy
-Platform HTTP component can act as a reverse proxy, in that case some headers are populated from the absolute URL received on the request line of the HTTP request. Those headers are specific to the underlining platform.
+Platform HTTP component can act as a reverse proxy. In that case, some headers are populated from the absolute URL received on the request line of the HTTP request. Those headers are specific to the underlining platform.
At this moment, this feature is only supported for Quarkus implemented in `camel-platform-http-vertx` component.