This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 23ee1596a1eaced14e09d6ffb22241e8e5217929
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Fri Nov 29 14:38:05 2019 +0100
Camel-platform-http: Added component and endpoint options through
placeholders
---
.../src/main/docs/platform-http-component.adoc | 58 +++++++++++++++++++++-
1 file changed, 57 insertions(+), 1 deletion(-)
diff --git
a/components/camel-platform-http/src/main/docs/platform-http-component.adoc
b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
index 57eb69c..9f6fc02 100644
--- a/components/camel-platform-http/src/main/docs/platform-http-component.adoc
+++ b/components/camel-platform-http/src/main/docs/platform-http-component.adoc
@@ -25,6 +25,62 @@ for this component:
</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
+| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *lazyStartProducer* (producer) | 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 [...]
+| *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
+|===
+// 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 (11 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
+| *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. | | 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
+
// spring-boot-auto-configure options: START
== Spring Boot Auto-Configuration
@@ -53,4 +109,4 @@ The component supports 4 options, which are listed below.
| *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.lazy-start-producer* | 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 proces [...]
|===
-// spring-boot-auto-configure options: END
\ No newline at end of file
+// spring-boot-auto-configure options: END
