Platform HTTP
Since Camel 3.0
Only consumer is supported Since Camel 3.0
The Platform HTTP is used to allow Camel to use the existing HTTP server from the runtime. For example when running Camel on Spring Boot, Quarkus, or other runtimes.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-platform-http</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Options
The Platform HTTP component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. |
false |
boolean |
autowiredEnabled (advanced) |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
boolean |
engine (advanced) |
An HTTP Server engine implementation to serve the requests |
PlatformHttpEngine |
The Platform HTTP endpoint is configured using URI syntax:
platform-http:path
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
path |
Required The path under which this endpoint serves the HTTP requests |
String |
Query Parameters (10 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. |
false |
boolean |
consumes (consumer) |
The content type this endpoint accepts as an input, such as application/xml or application/json. null or */* mean no restriction. |
String |
|
httpMethodRestrict (consumer) |
A comma separated list of HTTP methods to serve, e.g. GET,POST . If no methods are specified, all methods will be served. |
String |
|
matchOnUriPrefix (consumer) |
Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. |
false |
boolean |
produces (consumer) |
The content type this endpoint produces, such as application/xml or application/json. |
String |
|
exceptionHandler (consumer) |
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. |
ExceptionHandler |
|
exchangePattern (consumer) |
Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |
ExchangePattern |
|
fileNameExtWhitelist (consumer) |
A comma or whitespace separated list of file extensions. Uploads having these extensions will be stored locally. Null value or asterisk () will allow all files. |
String |
|
headerFilterStrategy (advanced) |
To use a custom HeaderFilterStrategy to filter headers to and from Camel message. |
HeaderFilterStrategy |
|
platformHttpEngine (advanced) |
An HTTP Server engine implementation to serve the requests of this endpoint. |
PlatformHttpEngine |
Spring Boot Auto-Configuration
When using platform-http with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-platform-http-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
|
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. |
false |
Boolean |
|
Whether to enable auto configuration of the platform-http component. This is enabled by default. |
Boolean |
||
An HTTP Server engine implementation to serve the requests. The option is a org.apache.camel.component.platform.http.spi.PlatformHttpEngine type. |
PlatformHttpEngine |