You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ja...@apache.org on 2021/12/08 07:34:28 UTC
[camel] branch main updated: CAMEL-17290: Add message headers section to camel-platform-http-vertx documentaion
This is an automated email from the ASF dual-hosted git repository.
jamesnetherton 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 c1cac81 CAMEL-17290: Add message headers section to camel-platform-http-vertx documentaion
c1cac81 is described below
commit c1cac8150dc10bfc0574914bb57f5eede9991ece
Author: James Netherton <ja...@gmail.com>
AuthorDate: Wed Dec 8 07:33:48 2021 +0000
CAMEL-17290: Add message headers section to camel-platform-http-vertx documentaion
---
.../src/main/docs/platform-http-vertx.adoc | 15 +++++++++++++++
1 file changed, 15 insertions(+)
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 bbdf80f..a60d839 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
@@ -21,6 +21,21 @@ configure an existing instance using the getter/setter on the `VertxPlatformHttp
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.
+== Message Headers
+
+[width="100%",cols="10%,20%,70%",options="header",]
+|=======================================================================
+|Name |Type |Description
+
+|`CamelVertxPlatformHttpAuthenticatedUser` |`io.vertx.ext.auth.User` |If an authenticated user is present on the Vert.x Web `RoutingContext`, this header is populated with a `User` object continaing the `Principal`.
+|=======================================================================
+
+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,
+`\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.
+
== VertxPlatformHttpServer
In addition to the implementation of the `PlatformHttp` SPI based on Vert.x, this module provides a Vert.x based HTTP