camel.apache.org/servlet
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for servlet

gitea_admin 2026-03-11 14:42:14 +00:00
parent 4636b31ac9
commit 6f2ef4a8b9
1 changed files with 44 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
Home.md

@ -1,21 +1,51 @@
# Deploy the Project on CamelX Platform # Servlet
Deploy on CamelX Platform in three steps Serve HTTP requests by a Servlet.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `servlet` |
| Support Level | Stable |
| Labels | http |
| Version | 4.10.2 |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-servlet</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `contextPath` | string | ✓ | | The context-path to use |
| `disableStreamCache` | boolean | | `false` | Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body. |
| `headerFilterStrategy` | object | | | To use a custom HeaderFilterStrategy to filter header to and from Camel message. |
| `httpBinding` | object | | | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. |
| `chunked` | boolean | | `true` | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response |
| `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. |
| `async` | boolean | | `false` | Configure the consumer to work in async mode |
| `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. |
| `logException` | boolean | | `false` | If enabled and an Exchange failed processing on the consumer side the exception's stack trace will be logged when the exception stack trace is not sent in the response's body. |
| `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. |
| `responseBufferSize` | integer | | | To use a custom buffer size on the jakarta.servlet.ServletResponse. |
| `servletName` | string | | `CamelServlet` | Name of the servlet to use |
| `attachmentMultipartBinding` | boolean | | `false` | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. |
| `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. |
| `eagerCheckContentAvailable` | boolean | | `false` | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data. |
| `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. |
| `fileNameExtWhitelist` | string | | | Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. |
| `mapHttpMessageBody` | boolean | | `true` | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping. |
| `mapHttpMessageFormUrlEncodedBody` | boolean | | `true` | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping. |
| `mapHttpMessageHeaders` | boolean | | `true` | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping. |
| `optionsEnabled` | boolean | | `false` | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. |
| `traceEnabled` | boolean | | `false` | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. |