Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 96. Platform HTTP

Since Camel 3.0

Only consumer is supported

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.

96.1. Dependencies
Copy link

When using platform-http with Red Hat build of Camel 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>
</dependency>
Copy to Clipboard Toggle word wrap

96.2. Platform HTTP Provider
Copy link

To use Platform HTTP a provider (engine) is required to be available on the classpath. The purpose is to have drivers for different runtimes such as Quarkus, VertX, or Spring Boot.

At this moment there is only support for Quarkus and VertX by camel-platform-http-vertx. This JAR must be on the classpath otherwise the Platform HTTP component cannot be used and an exception will be thrown on startup. 

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-platform-http-vertx</artifactId>
    <version>4.0.0.redhat-00036</version>
    <!-- use the same version as your Camel core version -->
</dependency>
Copy to Clipboard Toggle word wrap

96.3. Configuring Options
Copy link

Camel components are configured on two levels:

  • Component level
  • Endpoint level

96.3.1. Component Level Options
Copy link

The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on.

Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all.

You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code.

96.3.2. Endpoint Level Options
Copy link

At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both.

You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java.

When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings.

Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code.

96.4. Component Options
Copy link

The Platform HTTP component supports 3 options, which are listed below.

Expand
NameDescriptionDefaultType

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

96.4.1. Endpoint Options
Copy link

The Platform HTTP endpoint is configured using URI syntax: 

platform-http:path
Copy to Clipboard Toggle word wrap

with the following path and query parameters:

96.4.1.1. Path Parameters (1 parameters)
Copy link

Expand
NameDescriptionDefaultType

path (consumer)

Required The path under which this endpoint serves the HTTP requests, for proxy use 'proxy'.

 

String

96.4.1.2. Query Parameters (11 parameters)
Copy link

Expand
NameDescriptionDefaultType

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

muteException (consumer)

If enabled and an Exchange failed processing on the consumer side the response’s body won’t contain the exception’s stack trace.

true

boolean

produces (consumer)

The content type this endpoint produces, such as application/xml or application/json.

 

String

bridgeErrorHandler (consumer (advanced))

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

exceptionHandler (consumer (advanced))

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 (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly
  • InOut
  • InOptionalOut
 

ExchangePattern

fileNameExtWhitelist (consumer (advanced))

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

96.5. Spring Boot Auto-Configuration
Copy link

The component supports 4 options, which are listed below.

Expand
NameDescriptionDefaultType

camel.component.platform-http.autowired-enabled

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

camel.component.platform-http.bridge-error-handler

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

camel.component.platform-http.enabled

Whether to enable auto configuration of the platform-http component. This is enabled by default.

 

Boolean

camel.component.platform-http.engine

An HTTP Server engine implementation to serve the requests. The option is a org.apache.camel.component.platform.http.spi.PlatformHttpEngine type.

 

PlatformHttpEngine

96.5.1. Implementing a reverse proxy
Copy link

Platform HTTP component can act as a reverse proxy, in that case some headers are populated from the absolute URL received on the request line of the HTTP request. Those headers are specific to the underlining platform.

At this moment, this feature is only supported for Vert.x in camel-platform-http-vertx component.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat