From 686f4b30f4a6cff7a4fe3441e0ca3b1cdf07fcdf Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:42:55 +0000 Subject: [PATCH] Update wiki Home page for undertow --- Home.md | 64 ++++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 50 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..e76b71f 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,57 @@ -# Deploy the Project on CamelX Platform +# Undertow -Deploy on CamelX Platform in three steps +Expose HTTP and WebSocket endpoints and access external HTTP/WebSocket servers. -## 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 | `undertow` | +| Support Level | Stable | +| Labels | http,networking | +| 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-undertow + 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 url of the HTTP endpoint to use. | +| `useStreaming` | boolean | | `false` | For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively. | +| `accessLog` | boolean | | `false` | Whether or not the consumer should write access log | +| `httpMethodRestrict` | string | | | Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | +| `matchOnUriPrefix` | boolean | | `false` | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | +| `muteException` | boolean | | `false` | If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. | +| `optionsEnabled` | boolean | | `false` | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | +| `transferException` | boolean | | `false` | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send 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 the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | +| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. | +| `handlers` | string | | | Specifies a comma-delimited set of io.undertow.server.HttpHandler instances to lookup in your Registry. These handlers are added to the Undertow handler chain (for example, to add security). Important: You can not use different handlers with different Undertow endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers. | +| `cookieHandler` | object | | | Configure a cookie handler to maintain a HTTP session | +| `keepAlive` | boolean | | `true` | Setting to ensure socket is not closed due to inactivity | +| `options` | object | | | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192 | +| `preserveHostHeader` | boolean | | `true` | If the option is true, UndertowProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. | +| `reuseAddresses` | boolean | | `true` | Setting to facilitate socket multiplexing | +| `tcpNoDelay` | boolean | | `true` | Setting to improve TCP protocol performance | +| `throwExceptionOnFailure` | boolean | | `true` | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | +| `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. | +| `accessLogReceiver` | object | | | Which Undertow AccessLogReceiver should be used Will use JBossLoggingAccessLogReceiver if not specified | +| `headerFilterStrategy` | object | | | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | +| `undertowHttpBinding` | object | | | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. | +| `allowedRoles` | string | | | Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles. | +| `securityConfiguration` | object | | | OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration. | +| `securityProvider` | object | | | Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI). | +| `sslContextParameters` | object | | | To configure security using SSLContextParameters | +| `fireWebSocketChannelEvents` | boolean | | `false` | if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType. | +| `sendTimeout` | integer | | `30000` | Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds). | +| `sendToAll` | boolean | | | To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message. |