| [[platform-http-component]] |
| = Platform HTTP Component |
| //THIS FILE IS COPIED: EDIT THE SOURCE FILE: |
| :page-source: components/camel-platform-http/src/main/docs/platform-http-component.adoc |
| :docTitle: Platform HTTP |
| :artifactId: camel-platform-http |
| :description: Expose HTTP endpoints using the HTTP server available in the current platform. |
| :since: 3.0 |
| :supportLevel: Stable |
| :component-header: Only consumer is supported |
| |
| *Since Camel {since}* |
| |
| *{component-header}* |
| *Since Camel 3.0* |
| |
| |
| The Platform HTTP is used to allow Camel to use the existing HTTP server from the rumtime. |
| 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: |
| |
| [source,xml] |
| ---- |
| <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 |
| |
| // component options: START |
| The Platform HTTP component supports 3 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | 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 |
| | *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean |
| | *engine* (advanced) | An HTTP Server engine implementation to serve the requests | | PlatformHttpEngine |
| |=== |
| // component options: END |
| |
| |
| // endpoint options: START |
| The Platform HTTP endpoint is configured using URI syntax: |
| |
| ---- |
| platform-http:path |
| ---- |
| |
| with the following path and query parameters: |
| |
| === Path Parameters (1 parameters): |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *path* | *Required* The path under which this endpoint serves the HTTP requests | | String |
| |=== |
| |
| |
| === Query Parameters (12 parameters): |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | 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. 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 |
| | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean |
| | *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 |
| | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
| |=== |
| // endpoint options: END |
| |
| |
| include::camel-spring-boot::page$platform-http-starter.adoc[] |
