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 <angusyo...@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 <angusyo...@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]
----
