From c2a715d29582aab10e6fab5b6f78b60749ab49e7 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:42:59 +0000 Subject: [PATCH] Update wiki Home page for vertx-http --- Home.md | 58 +++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..a8b6bd1 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,51 @@ -# Deploy the Project on CamelX Platform +# Vert.x HTTP Client -Deploy on CamelX Platform in three steps +Send requests to external HTTP servers using Vert.x -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `vertx-http` | +| Support Level | Stable | +| Labels | http | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-vertx-http + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `httpUri` | string | ✓ | | The HTTP URI to connect to | +| `connectTimeout` | integer | | `60000` | The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. | +| `cookieStore` | object | | `InMemoryCookieStore` | A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used | +| `headerFilterStrategy` | object | | `VertxHttpHeaderFilterStrategy` | A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | +| `httpMethod` | object | | | The HTTP method to use. The HttpMethod header cannot override this option if set | +| `okStatusCodeRange` | string | | `200-299` | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included | +| `responsePayloadAsByteArray` | boolean | | `true` | Whether the response body should be byte or as io.vertx.core.buffer.Buffer | +| `sessionManagement` | boolean | | `false` | Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this | +| `throwExceptionOnFailure` | boolean | | `true` | Disable throwing HttpOperationFailedException in case of failed responses from the remote server | +| `timeout` | integer | | `-1` | The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout. | +| `transferException` | boolean | | `false` | If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk. | +| `useCompression` | boolean | | `false` | Set whether compression is enabled to handled compressed (E.g gzipped) responses | +| `vertxHttpBinding` | object | | | A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. | +| `webClientOptions` | object | | | Sets customized options for configuring the Vert.x WebClient | +| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | +| `proxyHost` | string | | | The proxy server host address | +| `proxyPassword` | string | | | The proxy server password if authentication is required | +| `proxyPort` | integer | | | The proxy server port | +| `proxyType` | object | | | The proxy server type | +| `proxyUsername` | string | | | The proxy server username if authentication is required | +| `basicAuthPassword` | string | | | The password to use for basic authentication | +| `basicAuthUsername` | string | | | The user name to use for basic authentication | +| `bearerToken` | string | | | The bearer token to use for bearer token authentication | +| `sslContextParameters` | object | | | To configure security using SSLContextParameters |