You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/08/05 14:01:34 UTC
[camel] 10/17: CAMEL-16844: component docs - prepare for regen
tables with better titles
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 4e737058588c690340ac63a137b1ad06cc3da2fa
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Aug 5 13:38:53 2021 +0200
CAMEL-16844: component docs - prepare for regen tables with better titles
---
.../src/main/docs/oaipmh-component.adoc | 79 +------
.../src/main/docs/olingo2-component.adoc | 241 +--------------------
.../src/main/docs/olingo4-component.adoc | 227 +------------------
.../src/main/docs/openstack-cinder-component.adoc | 53 +----
.../src/main/docs/openstack-glance-component.adoc | 51 -----
.../main/docs/openstack-keystone-component.adoc | 53 +----
.../src/main/docs/openstack-neutron-component.adoc | 52 +----
.../src/main/docs/openstack-nova-component.adoc | 52 +----
.../src/main/docs/openstack-swift-component.adoc | 53 +----
.../src/main/docs/optaplanner-component.adoc | 61 +-----
.../src/main/docs/paho-mqtt5-component.adoc | 103 +--------
.../camel-paho/src/main/docs/paho-component.adoc | 102 +--------
.../camel-pdf/src/main/docs/pdf-component.adoc | 51 -----
.../main/docs/pg-replication-slot-component.adoc | 81 +------
.../src/main/docs/pgevent-component.adoc | 55 -----
.../src/main/docs/platform-http-vertx.adoc | 6 +-
.../src/main/docs/platform-http-component.adoc | 52 -----
.../camel-printer/src/main/docs/lpr-component.adoc | 61 +-----
.../src/main/docs/pubnub-component.adoc | 71 ------
.../src/main/docs/pulsar-component.adoc | 149 -------------
.../src/main/docs/quartz-component.adoc | 103 ---------
.../src/main/docs/quickfix-component.adoc | 133 ------------
22 files changed, 26 insertions(+), 1863 deletions(-)
diff --git a/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc b/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
index fb7d72b..98bdda3 100644
--- a/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
+++ b/components/camel-oaipmh/src/main/docs/oaipmh-component.adoc
@@ -29,93 +29,19 @@ for this component:
== URI format
-[source,text]
----------------------------------------------------
oaipmh:url[?options]
----------------------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
// component options: START
-The OAI-PMH 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
-| *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 [...]
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The OAI-PMH endpoint is configured using URI syntax:
-
-----
-oaipmh:baseUrl
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *baseUrl* | *Required* Base URL of the repository to which the request is made through the OAI-PMH protocol | | String
-|===
-
-
-=== Query Parameters (29 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *from* (common) | Specifies a lower bound for datestamp-based selective harvesting. UTC DateTime value | | String
-| *identifier* (common) | Identifier of the requested resources. Applicable only with certain verbs | | String
-| *metadataPrefix* (common) | Specifies the metadataPrefix of the format that should be included in the metadata part of the returned records. | oai_dc | String
-| *set* (common) | Specifies membership as a criteria for set-based selective harvesting | | String
-| *until* (common) | Specifies an upper bound for datestamp-based selective harvesting. UTC DateTime value. | | String
-| *verb* (common) | Request name supported by OAI-PMh protocol | ListRecords | String
-| *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
-| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
-| *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
-| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
-| *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 [...]
-| *onlyFirst* (producer) | Returns the response of a single request. Otherwise it will make requests until there is no more data to return. | false | boolean
-| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
-| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
-| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
-| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
-| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
-| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
-| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
-| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
-| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
-| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
-| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
-| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
-| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
-| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
-| *ignoreSSLWarnings* (security) | Ignore SSL certificate warnings | false | boolean
-| *ssl* (security) | Causes the defined url to make an https request | false | boolean
-|===
// endpoint options: END
-
== Message Headers
[width="100%",cols="20%,80%",options="header",]
@@ -140,11 +66,8 @@ in Java DSL
from("direct:start").to("oaipmh:baseUrlRepository/oai/request");
---------------------------------------------------------
-
The result is a set of pages in XML format with all the records of the consulted repository.
-
-
== Consumer Example
The following is a basic example of how to receive all messages from a OAIPMH Server.
@@ -156,4 +79,6 @@ from("oaipmh:baseUrlRepository/oai/request")
.to(mock:result)
---------------------------------------------------------
+== More Information
+
For more details about OAI-PMH see the documentation: http://www.openarchives.org/pmh/
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
index 71bbe09..e5a0b11 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
@@ -31,251 +31,27 @@ SSL, OAuth2.0, etc. as required by the target OData service.
Maven users will need to add the following dependency to their pom.xml
for this component:
-[source,java]
+[source,xml]
----------------------------------------------
- <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-olingo2</artifactId>
- <version>${camel-version}</version>
- </dependency>
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-olingo2</artifactId>
+ <version>${camel-version}</version>
+</dependency>
----------------------------------------------
== URI format
-[source,java]
------------------------------------------------
- olingo2://endpoint/<resource-path>?[options]
+olingo2://endpoint/<resource-path>?[options]
------------------------------------------------
-== Olingo2 Options
-
-
-
-
// component options: START
-The Olingo2 component supports 18 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configuration* (common) | To use the shared configuration | | Olingo2Configuration
-| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String
-| *entityProviderReadProperties* (common) | Custom entity provider read properties applied to all read operations. | | EntityProviderReadProperties
-| *entityProviderWriteProperties* (common) | Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here. | | EntityPr [...]
-| *filterAlreadySeen* (common) | Set this to true to filter out results that have already been communicated by this component. | false | boolean
-| *httpHeaders* (common) | Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. | | Map
-| *proxy* (common) | HTTP proxy server configuration | | HttpHost
-| *serviceUri* (common) | Target OData service base URI, e.g. \http://services.odata.org/OData/OData.svc | | String
-| *socketTimeout* (common) | HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *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
-| *splitResult* (consumer) | For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false. | true | 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 [...]
-| *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
-| *httpAsyncClientBuilder* (advanced) | Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder
-| *httpClientBuilder* (advanced) | Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpClientBuilder
-| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters
-| *useGlobalSslContextParameters* (security) | Enable usage of global SSL context parameters. | false | boolean
-|===
// component options: END
-
-
-
-
-
-
// endpoint options: START
-The Olingo2 endpoint is configured using URI syntax:
-
-----
-olingo2:apiName/methodName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiName* | *Required* What kind of operation to perform. There are 1 enums and the value can be one of: DEFAULT | | Olingo2ApiName
-| *methodName* | *Required* What sub operation to use for the selected operation | | String
-|===
-
-
-=== Query Parameters (34 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String
-| *entityProviderReadProperties* (common) | Custom entity provider read properties applied to all read operations. | | EntityProviderReadProperties
-| *entityProviderWriteProperties* (common) | Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here. | | EntityPr [...]
-| *filterAlreadySeen* (common) | Set this to true to filter out results that have already been communicated by this component. | false | boolean
-| *httpHeaders* (common) | Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. | | Map
-| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
-| *proxy* (common) | HTTP proxy server configuration | | HttpHost
-| *serviceUri* (common) | Target OData service base URI, e.g. \http://services.odata.org/OData/OData.svc | | String
-| *socketTimeout* (common) | HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *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
-| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
-| *splitResult* (consumer) | For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false. | true | boolean
-| *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
-| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
-| *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 [...]
-| *httpAsyncClientBuilder* (advanced) | Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder
-| *httpClientBuilder* (advanced) | Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpClientBuilder
-| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
-| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
-| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
-| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
-| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
-| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
-| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
-| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
-| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
-| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
-| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
-| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
-| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
-| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
-| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters
-|===
-
-
-
-
-=== API Parameters (1 APIs):
-
-The Olingo2 endpoint is an API based component and has additional parameters based on which API name and API method is used.
-The API name and API method is located in the endpoint URI as the apiName/methodName path parameters:
-
-----
-olingo2:apiName/methodName
-----
-
-There are 1 API names as listed in the table below:
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| API Name | Type | Description
-| *DEFAULT* | Both | Olingo2 Client Api Interface
-|===
-
-Each API is documented in the following sections to come.
-
-
-==== API: DEFAULT
-
-*Both producer and consumer are supported*
-
-
-
-
-The DEFAULT API has 8 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-void batch(org.apache.olingo.odata2.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.util.List<org.apache.camel.component.olingo2.api.batch.Olingo2BatchResponse>> responseHandler);
-
-void create(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
-
-void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<org.apache.olingo.odata2.api.commons.HttpStatusCodes> responseHandler);
-
-void merge(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
-
-void patch(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
-
-void read(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
-
-void update(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
-
-void uread(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.io.InputStream> responseHandler);
-
-----
-
-The DEFAULT API is defined in the syntax as follows:
-
-----
-olingo2:DEFAULT/methodName?[parameters]
-----
-
-The 8 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *batch* | | Executes a batch request
-| *create* | | Creates a new OData resource
-| *delete* | | Deletes an OData resource and invokes callback with org
-| *merge* | | Patches/merges an OData resource using HTTP MERGE
-| *patch* | | Patches/merges an OData resource using HTTP PATCH
-| *read* | | Reads an OData resource and invokes callback with appropriate result
-| *update* | | Updates an OData resource
-| *uread* | | Reads an OData resource and invokes callback with the unparsed input stream
-|===
-
-The DEFAULT API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| batch | *data* | Ordered org.apache.camel.component.olingo2.api.batch.Olingo2BatchRequest list | Object
-| batch | *edm* | *Optional* Service Edm | Edm
-| batch | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| batch | *responseHandler* | *Optional* Callback handler | Olingo2ResponseHandler
-| create | *data* | Request data | Object
-| create | *edm* | *Optional* Service Edm | Edm
-| create | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| create | *resourcePath* | Resource path to create | String
-| create | *responseHandler* | *Optional* Callback handler | Olingo2ResponseHandler
-| delete | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| delete | *resourcePath* | Resource path for Entry | String
-| delete | *responseHandler* | *Optional* Org.apache.olingo.odata2.api.commons.HttpStatusCodes callback handler | Olingo2ResponseHandler
-| merge | *data* | Patch/merge data | Object
-| merge | *edm* | *Optional* Service Edm | Edm
-| merge | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| merge | *resourcePath* | Resource path to update | String
-| merge | *responseHandler* | *Optional* Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler | Olingo2ResponseHandler
-| patch | *data* | Patch/merge data | Object
-| patch | *edm* | *Optional* Service Edm | Edm
-| patch | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| patch | *resourcePath* | Resource path to update | String
-| patch | *responseHandler* | *Optional* Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler | Olingo2ResponseHandler
-| read | *edm* | *Optional* Service Edm, read from calling read(null, $metdata, null, responseHandler) | Edm
-| read | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| read | *queryParams* | *Optional* OData query params from \http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions | Map
-| read | *resourcePath* | OData Resource path | String
-| read | *responseHandler* | *Optional* Callback handler | Olingo2ResponseHandler
-| update | *data* | Updated data | Object
-| update | *edm* | *Optional* Service Edm | Edm
-| update | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| update | *resourcePath* | Resource path to update | String
-| update | *responseHandler* | *Optional* Org.apache.olingo.odata2.api.ep.entry.ODataEntry callback handler | Olingo2ResponseHandler
-| uread | *edm* | *Optional* Service Edm, read from calling read(null, $metdata, null, responseHandler) | Edm
-| uread | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| uread | *queryParams* | *Optional* OData query params from \http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SystemQueryOptions | Map
-| uread | *resourcePath* | OData Resource path | String
-| uread | *responseHandler* | *Optional* Callback handler | Olingo2ResponseHandler
-|===
-
-In addition to the parameters above, the DEFAULT API can also use from the 34 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelOlingo2.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelOlingo2.myParameterNameHere` header.
// endpoint options: END
+
== Endpoint HTTP Headers
The component level configuration property **httpHeaders** supplies static HTTP header information.
@@ -358,7 +134,6 @@ add an updated *!deltatoken* property with the value returned in the
consumer endpoint will produce an *ODataFeed* value the first time, and
*ODataDeltaFeed* on subsequent polls.
-
[source,java]
---------------------------------------------------------------------------------------------------------
from("olingo2://read/Manufacturers?queryParams=#paramsBean&timeUnit=SECONDS&delay=30")
diff --git a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
index c3044a7..0df6391 100644
--- a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
+++ b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
@@ -47,237 +47,12 @@ for this component:
olingo4://endpoint/<resource-path>?[options]
----
-== Olingo4 Options
-
-
// component options: START
-The Olingo4 component supports 16 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configuration* (common) | To use the shared configuration | | Olingo4Configuration
-| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String
-| *filterAlreadySeen* (common) | Set this to true to filter out results that have already been communicated by this component. | false | boolean
-| *httpHeaders* (common) | Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. | | Map
-| *proxy* (common) | HTTP proxy server configuration | | HttpHost
-| *serviceUri* (common) | Target OData service base URI, e.g. \http://services.odata.org/OData/OData.svc | | String
-| *socketTimeout* (common) | HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *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
-| *splitResult* (consumer) | For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false. | true | 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 [...]
-| *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
-| *httpAsyncClientBuilder* (advanced) | Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder
-| *httpClientBuilder* (advanced) | Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpClientBuilder
-| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters
-| *useGlobalSslContextParameters* (security) | Enable usage of global SSL context parameters. | false | boolean
-|===
// component options: END
-
-
-
-
-
-
// endpoint options: START
-The Olingo4 endpoint is configured using URI syntax:
-
-----
-olingo4:apiName/methodName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiName* | *Required* What kind of operation to perform. There are 1 enums and the value can be one of: DEFAULT | | Olingo4ApiName
-| *methodName* | *Required* What sub operation to use for the selected operation | | String
-|===
-
-
-=== Query Parameters (32 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *connectTimeout* (common) | HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *contentType* (common) | Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String
-| *filterAlreadySeen* (common) | Set this to true to filter out results that have already been communicated by this component. | false | boolean
-| *httpHeaders* (common) | Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. | | Map
-| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
-| *proxy* (common) | HTTP proxy server configuration | | HttpHost
-| *serviceUri* (common) | Target OData service base URI, e.g. \http://services.odata.org/OData/OData.svc | | String
-| *socketTimeout* (common) | HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds) | 30000 | int
-| *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
-| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
-| *splitResult* (consumer) | For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false. | true | boolean
-| *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
-| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
-| *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 [...]
-| *httpAsyncClientBuilder* (advanced) | Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder
-| *httpClientBuilder* (advanced) | Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely | | HttpClientBuilder
-| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
-| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
-| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
-| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
-| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
-| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
-| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
-| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
-| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
-| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
-| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
-| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
-| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
-| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
-| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters
-|===
-
-
-
-
-=== API Parameters (1 APIs):
-
-The Olingo4 endpoint is an API based component and has additional parameters based on which API name and API method is used.
-The API name and API method is located in the endpoint URI as the apiName/methodName path parameters:
-
-----
-olingo4:apiName/methodName
-----
-
-There are 1 API names as listed in the table below:
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| API Name | Type | Description
-| *DEFAULT* | Both | Olingo4 Client Api Interface
-|===
-
-Each API is documented in the following sections to come.
-
-
-==== API: DEFAULT
-
-*Both producer and consumer are supported*
-
-
-
-
-The DEFAULT API has 9 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.util.List<org.apache.camel.component.olingo4.api.batch.Olingo4BatchResponse>> responseHandler);
-
-void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<org.apache.olingo.commons.api.http.HttpStatusCode> responseHandler);
-
-void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
-
-void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.io.InputStream> responseHandler);
-
-----
-
-The DEFAULT API is defined in the syntax as follows:
-
-----
-olingo4:DEFAULT/methodName?[parameters]
-----
-
-The 9 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *action* | | Calls a OData action
-| *batch* | | Executes a batch request
-| *create* | | Creates a new OData resource
-| *delete* | | Deletes an OData resource and invokes callback with org
-| *merge* | | Patches/merges an OData resource using HTTP MERGE
-| *patch* | | Patches/merges an OData resource using HTTP PATCH
-| *read* | | Reads an OData resource and invokes callback with appropriate result
-| *update* | | Updates an OData resource
-| *uread* | | Reads an OData resource and invokes callback with the unparsed input stream
-|===
-
-The DEFAULT API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| action | *data* | *Optional* Action data | Object
-| action | *edm* | *Optional* Service Edm | Edm
-| action | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| action | *resourcePath* | Resource path to action | String
-| action | *responseHandler* | *Optional* Org.apache.olingo.client.api.domain.ClientEntity callback handler | Olingo4ResponseHandler
-| batch | *data* | *Optional* Ordered org.apache.camel.component.olingo4.api.batch.Olingo4BatchRequest list | Object
-| batch | *edm* | *Optional* Service Edm | Edm
-| batch | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| batch | *responseHandler* | *Optional* Callback handler | Olingo4ResponseHandler
-| create | *data* | *Optional* Request data | Object
-| create | *edm* | *Optional* Service Edm | Edm
-| create | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| create | *resourcePath* | Resource path to create | String
-| create | *responseHandler* | *Optional* Callback handler | Olingo4ResponseHandler
-| delete | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| delete | *resourcePath* | Resource path for Entry | String
-| delete | *responseHandler* | *Optional* Org.apache.olingo.commons.api.http.HttpStatusCode callback handler | Olingo4ResponseHandler
-| merge | *data* | *Optional* Patch/merge data | Object
-| merge | *edm* | *Optional* Service Edm | Edm
-| merge | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| merge | *resourcePath* | Resource path to update | String
-| merge | *responseHandler* | *Optional* Org.apache.olingo.client.api.domain.ClientEntity callback handler | Olingo4ResponseHandler
-| patch | *data* | *Optional* Patch/merge data | Object
-| patch | *edm* | *Optional* Service Edm | Edm
-| patch | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| patch | *resourcePath* | Resource path to update | String
-| patch | *responseHandler* | *Optional* Org.apache.olingo.client.api.domain.ClientEntity callback handler | Olingo4ResponseHandler
-| read | *edm* | *Optional* Service Edm, read from calling read(null, $metdata, null, responseHandler) | Edm
-| read | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| read | *queryParams* | *Optional* OData query params \http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288 | Map
-| read | *resourcePath* | OData Resource path | String
-| read | *responseHandler* | *Optional* Callback handler | Olingo4ResponseHandler
-| update | *data* | *Optional* Updated data | Object
-| update | *edm* | *Optional* Service Edm | Edm
-| update | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| update | *resourcePath* | Resource path to update | String
-| update | *responseHandler* | *Optional* Org.apache.olingo.client.api.domain.ClientEntity callback handler | Olingo4ResponseHandler
-| uread | *edm* | *Optional* Service Edm, read from calling read(null, $metdata, null, responseHandler) | Edm
-| uread | *endpointHttpHeaders* | *Optional* HTTP Headers to add/override the component versions | Map
-| uread | *queryParams* | *Optional* OData query params \http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc453752288 | Map
-| uread | *resourcePath* | OData Resource path | String
-| uread | *responseHandler* | *Optional* Callback handler | Olingo4ResponseHandler
-|===
-
-In addition to the parameters above, the DEFAULT API can also use from the 32 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelOlingo4.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelOlingo4.myParameterNameHere` header.
// endpoint options: END
+
== Endpoint HTTP Headers
The component level configuration property **httpHeaders** supplies static HTTP header information.
diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
index d0c0092..caa2294 100644
--- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
@@ -36,69 +36,20 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-cinder://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
-
// component options: START
-The OpenStack Cinder component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Cinder endpoint is configured using URI syntax:
-
-----
-openstack-cinder:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiVersion* (producer) | OpenStack API version. There are 2 enums and the value can be one of: V2, V3 | V3 | String
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *subsystem* (producer) | *Required* OpenStack Cinder subsystem. There are 2 enums and the value can be one of: snapshots, volumes | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
+
== Usage
+
You can use following settings for each subsystem:
== volumes
diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
index ea18c53..ef2b0f7 100644
--- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
@@ -36,67 +36,16 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-glance://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
-
// component options: START
-The OpenStack Glance component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Glance endpoint is configured using URI syntax:
-
-----
-openstack-glance:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (8 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiVersion* (producer) | OpenStack API version. There are 2 enums and the value can be one of: V2, V3 | V3 | String
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
-
== Usage
[width="100%",cols="20%,80%",options="header",]
diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
index be8a7b0..38fcef3 100644
--- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
@@ -16,7 +16,7 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/openstack-
The Openstack Keystone component allows messages to be sent to an OpenStack identity services.
-*The openstack-keystone component supports only Identity API v3!*
+NOTE: The openstack-keystone component supports only Identity API v3
== Dependencies
@@ -38,68 +38,19 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-keystone://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
// component options: START
-The OpenStack Keystone component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Keystone endpoint is configured using URI syntax:
-
-----
-openstack-keystone:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (8 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *subsystem* (producer) | *Required* OpenStack Keystone subsystem. There are 5 enums and the value can be one of: regions, domains, projects, users, groups | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
-
== Usage
+
You can use following settings for each subsystem:
== domains
diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
index d473174..253d93d 100644
--- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
@@ -36,69 +36,19 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-neutron://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
// component options: START
-The OpenStack Neutron component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Neutron endpoint is configured using URI syntax:
-
-----
-openstack-neutron:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiVersion* (producer) | OpenStack API version. There are 2 enums and the value can be one of: V2, V3 | V3 | String
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *subsystem* (producer) | *Required* OpenStack Neutron subsystem. There are 4 enums and the value can be one of: networks, subnets, ports, routers | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
-
== Usage
+
You can use following settings for each subsystem:
== networks
diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
index 8031434..fbf709e 100644
--- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
@@ -36,69 +36,19 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-nova://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
-
// component options: START
-The OpenStack Nova component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Nova endpoint is configured using URI syntax:
-
-----
-openstack-nova:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiVersion* (producer) | OpenStack API version. There are 2 enums and the value can be one of: V2, V3 | V3 | String
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *subsystem* (producer) | *Required* OpenStack Nova subsystem. There are 3 enums and the value can be one of: flavors, servers, keypairs | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
== Usage
+
You can use following settings for each subsystem:
== flavors
diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
index c61bf1d..23f3199 100644
--- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
@@ -36,69 +36,18 @@ where `${camel-version`} must be replaced by the actual version of Camel.
== URI Format
-[source,java]
----------------------------
openstack-swift://hosturl[?options]
----------------------------
-You can append query options to the URI in the following format
-`?options=value&option2=value&...`
-
-== URI Options
-
// component options: START
-The OpenStack Swift component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
// endpoint options: START
-The OpenStack Swift endpoint is configured using URI syntax:
-
-----
-openstack-swift:host
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | *Required* OpenStack host url | | String
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *apiVersion* (producer) | OpenStack API version. There are 2 enums and the value can be one of: V2, V3 | V3 | String
-| *config* (producer) | OpenStack configuration | | Config
-| *domain* (producer) | Authentication domain | default | String
-| *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 [...]
-| *operation* (producer) | The operation to do | | String
-| *password* (producer) | *Required* OpenStack password | | String
-| *project* (producer) | *Required* The project ID | | String
-| *subsystem* (producer) | *Required* OpenStack Swift subsystem. There are 2 enums and the value can be one of: objects, containers | | String
-| *username* (producer) | *Required* OpenStack username | | String
-|===
// endpoint options: END
-
== Usage
+
You can use following settings for each subsystem:
== containers
diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
index 1bff3d0..8030935 100644
--- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
+++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
@@ -34,7 +34,6 @@ for this component:
== URI format
-[source,java]
----------------------------------
optaplanner:solverConfig[?options]
----------------------------------
@@ -45,64 +44,12 @@ example `/org/foo/barSolverConfig.xml`.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-== OptaPlanner Options
-
-
// component options: START
-The OptaPlanner 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
-| *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 [...]
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The OptaPlanner endpoint is configured using URI syntax:
-
-----
-optaplanner:configFile
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configFile* | *Required* Specifies the location to the solver file. If useSolverManager=FALSE, Camel uses this file and create the Solver. If useSolverManager=TRUE and SolverManager is set in the header {OptaPlannerConstants.SOLVER_MANAGER} : this file is ignored by Camel usage of SolverManager. SolverManager can be injected by DI in Quarkus or Spring. | | String
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *problemId* (common) | In case of using SolverManager : the problem id | 1L | Long
-| *solverId* (common) | Specifies the solverId to user for the solver instance key | DEFAULT_SOLVER | String
-| *useSolverManager* (common) | use SolverManager instead of XML file config. Use this mode on Quarkus app. | false | boolean
-| *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
-| *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
-| *async* (producer) | Specifies to perform operations in async mode | 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 [...]
-| *threadPoolSize* (producer) | Specifies the thread pool size to use when async is true | 10 | int
-|===
// endpoint options: END
-
== Message Headers
[width="100%",cols="10%,10%,10%,10%,60%",options="header",]
@@ -136,18 +83,16 @@ The solving will take as long as specified in the `solverConfig`.
[source,xml]
-----------------------------------------------------------------------------
<solver>
- ...
+
<termination>
<!-- Terminate after 10 seconds, unless it's not feasible by then yet -->
<terminationCompositionStyle>AND</terminationCompositionStyle>
<secondsSpentLimit>10</secondsSpentLimit>
<bestScoreLimit>-1hard/0soft</bestScoreLimit>
</termination>
- ...
-<solver>
------------------------------------------------------------------------------
-
+</solver>
+-----------------------------------------------------------------------------
=== Samples
diff --git a/components/camel-paho-mqtt5/src/main/docs/paho-mqtt5-component.adoc b/components/camel-paho-mqtt5/src/main/docs/paho-mqtt5-component.adoc
index 82d6566..76ea9c9 100644
--- a/components/camel-paho-mqtt5/src/main/docs/paho-mqtt5-component.adoc
+++ b/components/camel-paho-mqtt5/src/main/docs/paho-mqtt5-component.adoc
@@ -32,7 +32,6 @@ for this component:
== URI format
-[source]
----
paho-mqtt5:topic[?options]
----
@@ -40,112 +39,12 @@ paho-mqtt5:topic[?options]
Where *topic* is the name of the topic.
-== Options
-
// component options: START
-The Paho MQTT 5 component supports 31 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *automaticReconnect* (common) | Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will [...]
-| *brokerUrl* (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String
-| *cleanStart* (common) | Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state ac [...]
-| *clientId* (common) | MQTT client identifier. The identifier must be unique. | | String
-| *configuration* (common) | To use the shared Paho configuration | | PahoMqtt5Configuration
-| *connectionTimeout* (common) | Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. | 30 | int
-| *filePersistenceDirectory* (common) | Base directory used by file persistence. Will by default use user directory. | | String
-| *keepAliveInterval* (common) | Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping mes [...]
-| *maxReconnectDelay* (common) | Get the maximum time (in millis) to wait between reconnects | 128000 | int
-| *persistence* (common) | Client persistence to be used - memory or file. There are 2 enums and the value can be one of: FILE, MEMORY | MEMORY | PahoMqtt5Persistence
-| *qos* (common) | Client quality of service level (0-2). | 2 | int
-| *receiveMaximum* (common) | Sets the Receive Maximum. This value represents the limit of QoS 1 and QoS 2 publications that the client is willing to process concurrently. There is no mechanism to limit the number of QoS 0 publications that the Server might try to send. The default value is 65535 | 65535 | int
-| *retained* (common) | Retain option | false | boolean
-| *serverURIs* (common) | Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serv [...]
-| *willMqttProperties* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The MQTT properties set for the message. | | MqttProperties
-| *willPayload* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The byte payload for the message. | | String
-| *willQos* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The quality of service to publish the message at (0, 1 or 2). | 1 | int
-| *willRetained* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Whether or not the message should be retained. | false | boolean
-| *willTopic* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to. | | String
-| *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
-| *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 [...]
-| *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
-| *client* (advanced) | To use a shared Paho client | | MqttClient
-| *customWebSocketHeaders* (advanced) | Sets the Custom WebSocket Headers for the WebSocket Connection. | | Map
-| *executorServiceTimeout* (advanced) | Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. | 1 | int
-| *httpsHostnameVerification{zwsp}Enabled* (security) | Whether SSL HostnameVerifier is enabled or not. The default value is true. | true | boolean
-| *password* (security) | Password to be used for authentication against the MQTT broker | | String
-| *socketFactory* (security) | Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. | | SocketFactory
-| *sslClientProps* (security) | Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the fi [...]
-| *sslHostnameVerifier* (security) | Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier | | HostnameVerifier
-| *userName* (security) | Username to be used for authentication against the MQTT broker | | String
-|===
// component options: END
-
-
// endpoint options: START
-The Paho MQTT 5 endpoint is configured using URI syntax:
-
-----
-paho-mqtt5:topic
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *topic* | *Required* Name of the topic | | String
-|===
-
-
-=== Query Parameters (31 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *automaticReconnect* (common) | Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will [...]
-| *brokerUrl* (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String
-| *cleanStart* (common) | Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state ac [...]
-| *clientId* (common) | MQTT client identifier. The identifier must be unique. | | String
-| *connectionTimeout* (common) | Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. | 30 | int
-| *filePersistenceDirectory* (common) | Base directory used by file persistence. Will by default use user directory. | | String
-| *keepAliveInterval* (common) | Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping mes [...]
-| *maxReconnectDelay* (common) | Get the maximum time (in millis) to wait between reconnects | 128000 | int
-| *persistence* (common) | Client persistence to be used - memory or file. There are 2 enums and the value can be one of: FILE, MEMORY | MEMORY | PahoMqtt5Persistence
-| *qos* (common) | Client quality of service level (0-2). | 2 | int
-| *receiveMaximum* (common) | Sets the Receive Maximum. This value represents the limit of QoS 1 and QoS 2 publications that the client is willing to process concurrently. There is no mechanism to limit the number of QoS 0 publications that the Server might try to send. The default value is 65535 | 65535 | int
-| *retained* (common) | Retain option | false | boolean
-| *serverURIs* (common) | Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serv [...]
-| *willMqttProperties* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The MQTT properties set for the message. | | MqttProperties
-| *willPayload* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The byte payload for the message. | | String
-| *willQos* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The quality of service to publish the message at (0, 1 or 2). | 1 | int
-| *willRetained* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. Whether or not the message should be retained. | false | boolean
-| *willTopic* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to. | | String
-| *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
-| *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
-| *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 [...]
-| *client* (advanced) | To use an existing mqtt client | | MqttClient
-| *customWebSocketHeaders* (advanced) | Sets the Custom WebSocket Headers for the WebSocket Connection. | | Map
-| *executorServiceTimeout* (advanced) | Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. | 1 | int
-| *httpsHostnameVerification{zwsp}Enabled* (security) | Whether SSL HostnameVerifier is enabled or not. The default value is true. | true | boolean
-| *password* (security) | Password to be used for authentication against the MQTT broker | | String
-| *socketFactory* (security) | Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. | | SocketFactory
-| *sslClientProps* (security) | Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the fi [...]
-| *sslHostnameVerifier* (security) | Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier | | HostnameVerifier
-| *userName* (security) | Username to be used for authentication against the MQTT broker | | String
-|===
// endpoint options: END
-
== Headers
The following headers are recognized by the Paho component:
@@ -212,7 +111,7 @@ from("direct:test")
For example this is how to read messages from the remote MQTT broker:
-[source]
+[source,java]
----
from("paho:some/queue?brokerUrl=tcp://iot.eclipse.org:1883")
.to("mock:test");
diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc
index 4cc0618..6fbaf7f 100644
--- a/components/camel-paho/src/main/docs/paho-component.adoc
+++ b/components/camel-paho/src/main/docs/paho-component.adoc
@@ -40,112 +40,12 @@ paho:topic[?options]
Where *topic* is the name of the topic.
-== Options
-
// component options: START
-The Paho component supports 31 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *automaticReconnect* (common) | Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will [...]
-| *brokerUrl* (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String
-| *cleanSession* (common) | Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state [...]
-| *clientId* (common) | MQTT client identifier. The identifier must be unique. | | String
-| *configuration* (common) | To use the shared Paho configuration | | PahoConfiguration
-| *connectionTimeout* (common) | Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. | 30 | int
-| *filePersistenceDirectory* (common) | Base directory used by file persistence. Will by default use user directory. | | String
-| *keepAliveInterval* (common) | Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping mes [...]
-| *maxInflight* (common) | Sets the max inflight. please increase this value in a high traffic environment. The default value is 10 | 10 | int
-| *maxReconnectDelay* (common) | Get the maximum time (in millis) to wait between reconnects | 128000 | int
-| *mqttVersion* (common) | Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively. | | int
-| *persistence* (common) | Client persistence to be used - memory or file. There are 2 enums and the value can be one of: FILE, MEMORY | MEMORY | PahoPersistence
-| *qos* (common) | Client quality of service level (0-2). | 2 | int
-| *retained* (common) | Retain option | false | boolean
-| *serverURIs* (common) | Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serv [...]
-| *willPayload* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | String
-| *willQos* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | int
-| *willRetained* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | false | boolean
-| *willTopic* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | String
-| *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
-| *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 [...]
-| *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
-| *client* (advanced) | To use a shared Paho client | | MqttClient
-| *customWebSocketHeaders* (advanced) | Sets the Custom WebSocket Headers for the WebSocket Connection. | | Properties
-| *executorServiceTimeout* (advanced) | Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. | 1 | int
-| *httpsHostnameVerification{zwsp}Enabled* (security) | Whether SSL HostnameVerifier is enabled or not. The default value is true. | true | boolean
-| *password* (security) | Password to be used for authentication against the MQTT broker | | String
-| *socketFactory* (security) | Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. | | SocketFactory
-| *sslClientProps* (security) | Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the fi [...]
-| *sslHostnameVerifier* (security) | Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier | | HostnameVerifier
-| *userName* (security) | Username to be used for authentication against the MQTT broker | | String
-|===
// component options: END
-
-
// endpoint options: START
-The Paho endpoint is configured using URI syntax:
-
-----
-paho:topic
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *topic* | *Required* Name of the topic | | String
-|===
-
-
-=== Query Parameters (31 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *automaticReconnect* (common) | Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will [...]
-| *brokerUrl* (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String
-| *cleanSession* (common) | Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state [...]
-| *clientId* (common) | MQTT client identifier. The identifier must be unique. | | String
-| *connectionTimeout* (common) | Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. | 30 | int
-| *filePersistenceDirectory* (common) | Base directory used by file persistence. Will by default use user directory. | | String
-| *keepAliveInterval* (common) | Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping mes [...]
-| *maxInflight* (common) | Sets the max inflight. please increase this value in a high traffic environment. The default value is 10 | 10 | int
-| *maxReconnectDelay* (common) | Get the maximum time (in millis) to wait between reconnects | 128000 | int
-| *mqttVersion* (common) | Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively. | | int
-| *persistence* (common) | Client persistence to be used - memory or file. There are 2 enums and the value can be one of: FILE, MEMORY | MEMORY | PahoPersistence
-| *qos* (common) | Client quality of service level (0-2). | 2 | int
-| *retained* (common) | Retain option | false | boolean
-| *serverURIs* (common) | Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serv [...]
-| *willPayload* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | String
-| *willQos* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | int
-| *willRetained* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | false | boolean
-| *willTopic* (common) | Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. | | String
-| *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
-| *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
-| *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 [...]
-| *client* (advanced) | To use an existing mqtt client | | MqttClient
-| *customWebSocketHeaders* (advanced) | Sets the Custom WebSocket Headers for the WebSocket Connection. | | Properties
-| *executorServiceTimeout* (advanced) | Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. | 1 | int
-| *httpsHostnameVerification{zwsp}Enabled* (security) | Whether SSL HostnameVerifier is enabled or not. The default value is true. | true | boolean
-| *password* (security) | Password to be used for authentication against the MQTT broker | | String
-| *socketFactory* (security) | Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. | | SocketFactory
-| *sslClientProps* (security) | Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the fi [...]
-| *sslHostnameVerifier* (security) | Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier | | HostnameVerifier
-| *userName* (security) | Username to be used for authentication against the MQTT broker | | String
-|===
// endpoint options: END
-
== Headers
The following headers are recognized by the Paho component:
@@ -212,7 +112,7 @@ from("direct:test")
For example this is how to read messages from the remote MQTT broker:
-[source]
+[source,java]
----
from("paho:some/queue?brokerUrl=tcp://iot.eclipse.org:1883")
.to("mock:test");
diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc
index cda7369..0a30458 100644
--- a/components/camel-pdf/src/main/docs/pdf-component.adoc
+++ b/components/camel-pdf/src/main/docs/pdf-component.adoc
@@ -36,67 +36,16 @@ following dependency to their `pom.xml`:
The PDF component only supports producer endpoints.
-[source,java]
-----------------------
pdf:operation[?options]
-----------------------
-== Options
-
// component options: START
-The PDF component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The PDF endpoint is configured using URI syntax:
-
-----
-pdf:operation
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *operation* | *Required* Operation type. There are 3 enums and the value can be one of: create, append, extractText | | PdfOperation
-|===
-
-
-=== Query Parameters (9 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *font* (producer) | Font. There are 14 enums and the value can be one of: Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic, Symbol, ZapfDingbats | Helvetica | String
-| *fontSize* (producer) | Font size in pixels | 14.0 | float
-| *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 [...]
-| *marginBottom* (producer) | Margin bottom in pixels | 20 | int
-| *marginLeft* (producer) | Margin left in pixels | 20 | int
-| *marginRight* (producer) | Margin right in pixels | 40 | int
-| *marginTop* (producer) | Margin top in pixels | 20 | int
-| *pageSize* (producer) | Page size. There are 9 enums and the value can be one of: LETTER, LEGAL, A0, A1, A2, A3, A4, A5, A6 | A4 | String
-| *textProcessingFactory* (producer) | Text processing to use. autoFormatting: Text is getting sliced by words, then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not. There are 2 enums [...]
-|===
// endpoint options: END
-
== Headers
[width="100%",cols="10%,90%",options="header",]
|=======================================================================
diff --git a/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc b/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc
index 3c0f8bf..bee47d7 100644
--- a/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc
+++ b/components/camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc
@@ -33,89 +33,16 @@ URI format
The pg-replication-slot component uses the following two styles of endpoint URI
notation:
-[source,java]
-------------------------------------------------
pg-replication-slot://host:port/database/slot:plugin[?parameters]
-------------------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
-
// component options: START
-The PostgresSQL Replication Slot component supports 2 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
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The PostgresSQL Replication Slot endpoint is configured using URI syntax:
-
-----
-pg-replication-slot:host:port/database/slot:outputPlugin
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (5 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *slot* | *Required* Replication Slot name | | String
-| *host* | Postgres host | localhost | String
-| *port* | Postgres port | 5432 | Integer
-| *database* | *Required* Postgres database name | | String
-| *outputPlugin* | *Required* Output plugin name | | String
-|===
-
-
-=== Query Parameters (24 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *password* (common) | Postgres password | | String
-| *user* (common) | Postgres user | postgres | String
-| *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
-| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
-| *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
-| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
-| *autoCreateSlot* (advanced) | Auto create slot if it does not exist | true | Boolean
-| *slotOptions* (advanced) | Slot options to be passed to the output plugin. | | Map
-| *statusInterval* (advanced) | Specifies the number of seconds between status packets sent back to Postgres server. | 10 | Integer
-| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
-| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
-| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
-| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
-| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
-| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
-| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
-| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
-| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
-| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
-| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
-| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
-| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
-| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
-|===
// endpoint options: END
-== Example
+== Examples
[source,java]
----
@@ -125,19 +52,13 @@ from("pg-replication-slot://localhost:5432/finance/sync_slot:test_decoding?user=
== Tips
-[TIP]
-====
PostgreSQL can generate a huge amount of empty transactions on certain operations (e.g. `VACUUM`). These transactions can congest
your route. Using `greedy=true` query parameter can help with this problem. It will help your route filter out empty transactions quickly
without waiting for the `delay`*`timeUnit` parameter between each exchange.
-====
-[TIP]
-====
The order of the messages is guaranteed, but the same message might come more than once. So, for example, if you're using
this component to sync data from PostgreSQL to other database, make sure your operations are idempotent (e.g. use UPSERT
instead of INSERT,...). This will make sure repeated messages won't affect your system negatively.
-====
include::{page-component-version}@camel-spring-boot::page$pg-replication-slot-starter.adoc[]
diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc
index f0d352c..29cd79f 100644
--- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc
+++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc
@@ -34,70 +34,15 @@ URI format
The pgevent component uses the following two styles of endpoint URI
notation:
-[source,java]
-------------------------------------------------
pgevent:datasource[?parameters]
pgevent://host:port/database/channel[?parameters]
-------------------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
// component options: START
-The PostgresSQL Event 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
-| *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 [...]
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The PostgresSQL Event endpoint is configured using URI syntax:
-
-----
-pgevent:host:port/database/channel
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (4 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *host* | To connect using hostname and port to the database. | localhost | String
-| *port* | To connect using hostname and port to the database. | 5432 | Integer
-| *database* | *Required* The database name. The database name can take any characters because it is sent as a quoted identifier. It is part of the endpoint URI, so diacritical marks and non-Latin letters have to be URL encoded. | | String
-| *channel* | *Required* The channel name | | String
-|===
-
-
-=== Query Parameters (7 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *datasource* (common) | To connect using the given javax.sql.DataSource instead of using hostname and port. | | DataSource
-| *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
-| *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
-| *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 [...]
-| *pass* (security) | Password for login | | String
-| *user* (security) | Username for login | postgres | String
-|===
// endpoint options: END
diff --git a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
index 21a0bdd..4acb08d 100644
--- a/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
+++ b/components/camel-platform-http-vertx/src/main/docs/platform-http-vertx.adoc
@@ -11,12 +11,8 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/others/platform-http-
The camel-platform-http-vertx is a Vert.x based implementation of the `PlatformHttp` SPI.
-[NOTE]
-====
-At this time this component is an experiment so use it with care.
-====
-
== Vert.x Route
+
This implementation will by default lookup an instance of `VertxPlatformHttpRouter` on the registry however you can
configure an existing instance using the getter/setter on the `VertxPlatformHttpEngine` class.
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 b679395..b359698 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
@@ -11,7 +11,6 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/platform-h
*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 runtime.
@@ -30,60 +29,9 @@ 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
-| *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
-|===
// 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 (10 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. 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
-|===
// endpoint options: END
-include::{page-component-version}@camel-spring-boot::page$platform-http-starter.adoc[]
diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc
index 6d302b5..54f61aa 100644
--- a/components/camel-printer/src/main/docs/lpr-component.adoc
+++ b/components/camel-printer/src/main/docs/lpr-component.adoc
@@ -18,8 +18,6 @@ in order for the component to appropriately print it. The objective is
to be able to direct specific payloads as jobs to a line printer in a
camel flow.
-This component only supports a camel producer endpoint.
-
The functionality allows for the payload to be printed on a default
printer, named local, remote or wireless linked printer using the
javax printing API under the covers.
@@ -43,74 +41,17 @@ Since the URI scheme for a printer has not been standardized (the
nearest thing to a standard being the IETF print standard) and therefore
not uniformly applied by vendors, we have chosen *"lpr"* as the scheme.
-[source,java]
-----------------------------------------------
lpr://localhost/default[?options]
lpr://remotehost:port/path/to/printer[?options]
-----------------------------------------------
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
-
// component options: START
-The Printer component supports 2 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *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 [...]
-| *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
-|===
// component options: END
-
-
-
// endpoint options: START
-The Printer endpoint is configured using URI syntax:
-
-----
-lpr:hostname:port/printername
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (3 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *hostname* | *Required* Hostname of the printer | | String
-| *port* | Port number of the printer | | int
-| *printername* | Name of the printer | | String
-|===
-
-
-=== Query Parameters (11 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *copies* (producer) | Number of copies to print | 1 | int
-| *docFlavor* (producer) | Sets DocFlavor to use. | | DocFlavor
-| *flavor* (producer) | Sets DocFlavor to use. | | String
-| *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 [...]
-| *mediaSize* (producer) | Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored, e.g. values of iso_a4 and ISO_A4 may be used. | na-letter | String
-| *mediaTray* (producer) | Sets MediaTray supported by the javax.print.DocFlavor API, for example upper,middle etc. | | String
-| *mimeType* (producer) | Sets mimeTypes supported by the javax.print.DocFlavor API | | String
-| *orientation* (producer) | Sets the page orientation. There are 4 enums and the value can be one of: portrait, landscape, reverse-portrait, reverse-landscape | portrait | String
-| *printerPrefix* (producer) | Sets the prefix name of the printer, it is useful when the printer name does not start with //hostname/printer | | String
-| *sendToPrinter* (producer) | etting this option to false prevents sending of the print data to the printer | true | boolean
-| *sides* (producer) | Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API. There are 5 enums and the value can be one of: one-sided, duplex, tumble, two-sided-short-edge, two-sided-long-edge | one-sided | String
-|===
// endpoint options: END
+
== Sending Messages to a Printer
=== Printer Producer
diff --git a/components/camel-pubnub/src/main/docs/pubnub-component.adoc b/components/camel-pubnub/src/main/docs/pubnub-component.adoc
index 934c6ce..3817134 100644
--- a/components/camel-pubnub/src/main/docs/pubnub-component.adoc
+++ b/components/camel-pubnub/src/main/docs/pubnub-component.adoc
@@ -24,8 +24,6 @@ Use cases include:
** Multiplayer games
** Interactive media: audience-participating voting system
-
-
Maven users will need to add the following dependency to their `pom.xml`
for this component:
@@ -41,82 +39,15 @@ for this component:
== URI format
-[source,java]
------------------------
pubnub:channel[?options]
------------------------
Where *channel* is the PubNub channel to publish or subscribe to.
-== Options
-
-
// component options: START
-The PubNub component supports 13 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configuration* (common) | The component configurations | | PubNubConfiguration
-| *uuid* (common) | UUID to be used as a device identifier, a default UUID is generated if not passed. | | String
-| *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
-| *withPresence* (consumer) | Also subscribe to related presence information | 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 [...]
-| *operation* (producer) | The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. WHERENOW: Obtain information about the current list of c [...]
-| *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
-| *authKey* (security) | If Access Manager is utilized, client will use this authKey in all restricted requests. | | String
-| *cipherKey* (security) | If cipher is passed, all communications to/from PubNub will be encrypted. | | String
-| *publishKey* (security) | The publish key obtained from your PubNub account. Required when publishing messages. | | String
-| *secretKey* (security) | The secret key used for message signing. | | String
-| *secure* (security) | Use SSL for secure transmission. | true | boolean
-| *subscribeKey* (security) | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events | | String
-|===
// component options: END
-
-
-
// endpoint options: START
-The PubNub endpoint is configured using URI syntax:
-
-----
-pubnub:channel
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *channel* | *Required* The channel used for subscribing/publishing events | | String
-|===
-
-
-=== Query Parameters (14 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *uuid* (common) | UUID to be used as a device identifier, a default UUID is generated if not passed. | | String
-| *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
-| *withPresence* (consumer) | Also subscribe to related presence information | false | boolean
-| *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
-| *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 [...]
-| *operation* (producer) | The operation to perform. PUBLISH: Default. Send a message to all subscribers of a channel. FIRE: allows the client to send a message to BLOCKS Event Handlers. These messages will go directly to any Event Handlers registered on the channel. HERENOW: Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count. WHERENOW: Obtain information about the current list of c [...]
-| *pubnub* (advanced) | *Autowired* Reference to a Pubnub client in the registry. | | PubNub
-| *authKey* (security) | If Access Manager is utilized, client will use this authKey in all restricted requests. | | String
-| *cipherKey* (security) | If cipher is passed, all communications to/from PubNub will be encrypted. | | String
-| *publishKey* (security) | The publish key obtained from your PubNub account. Required when publishing messages. | | String
-| *secretKey* (security) | The secret key used for message signing. | | String
-| *secure* (security) | Use SSL for secure transmission. | true | boolean
-| *subscribeKey* (security) | The subscribe key obtained from your PubNub account. Required when subscribing to channels or listening for presence events | | String
-|===
// endpoint options: END
@@ -219,7 +150,6 @@ from("direct:control")
.to("pubnub:myChannel?publishKey=mypublishKey&subscribeKey=mySubscribeKey&operation=gethistory");
----
-
There is a couple of examples in test directory that shows some of the PubNub features.
They require a PubNub account, from where you can obtain a publish- and subscribe key.
@@ -227,5 +157,4 @@ The example PubNubSensorExample already contains a subscribe key provided by Pub
The example illustrates the PubNub component subscribing to a infinite stream of sensor data.
-
include::{page-component-version}@camel-spring-boot::page$pubnub-starter.adoc[]
diff --git a/components/camel-pulsar/src/main/docs/pulsar-component.adoc b/components/camel-pulsar/src/main/docs/pulsar-component.adoc
index ce49ee5..14ff8e0 100644
--- a/components/camel-pulsar/src/main/docs/pulsar-component.adoc
+++ b/components/camel-pulsar/src/main/docs/pulsar-component.adoc
@@ -27,163 +27,14 @@ their `pom.xml` for this component.
== URI format
-[source,text]
----------------------
pulsar:[persistent|non-persistent]://tenant/namespace/topic
----------------------
-== Options
-
-
// component options: START
-The Pulsar component supports 38 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configuration* (common) | Allows to pre-configure the Pulsar component with common options that the endpoints will reuse. | | PulsarConfiguration
-| *ackGroupTimeMillis* (consumer) | Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100 | 100 | long
-| *ackTimeoutMillis* (consumer) | Timeout for unacknowledged messages in milliseconds - defaults to 10000 | 10000 | long
-| *allowManualAcknowledgement* (consumer) | Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs. | false | boolean
-| *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
-| *consumerName* (consumer) | Name of the consumer when subscription is EXCLUSIVE | sole-consumer | String
-| *consumerNamePrefix* (consumer) | Prefix to add to consumer names when a SHARED or FAILOVER subscription is used | cons | String
-| *consumerQueueSize* (consumer) | Size of the consumer queue - defaults to 10 | 10 | int
-| *deadLetterTopic* (consumer) | Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ | | String
-| *maxRedeliverCount* (consumer) | Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created | | Integer
-| *messageListener* (consumer) | Whether to use the messageListener interface, or to receive messages using a separate thread pool | true | boolean
-| *negativeAckRedeliveryDelay{zwsp}Micros* (consumer) | Set the negative acknowledgement delay | 60000000 | long
-| *numberOfConsumers* (consumer) | Number of consumers - defaults to 1 | 1 | int
-| *numberOfConsumerThreads* (consumer) | Number of threads to receive and handle messages when using a separate thread pool | 1 | int
-| *readCompacted* (consumer) | Enable compacted topic reading. | false | boolean
-| *subscriptionInitialPosition* (consumer) | Control the initial position in the topic of a newly created subscription. Default is latest message. There are 2 enums and the value can be one of: EARLIEST, LATEST | LATEST | SubscriptionInitialPosition
-| *subscriptionName* (consumer) | Name of the subscription to use | subs | String
-| *subscriptionTopicsMode* (consumer) | Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions. There are 3 enums and the value can be one of: PersistentOnly, NonPersistentOnly, AllTopics | PersistentOnly | RegexSubscriptionMode
-| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. There are 4 enums and the value can be one of: EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED | EXCLUSIVE | SubscriptionType
-| *topicsPattern* (consumer) | Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace | false | boolean
-| *pulsarMessageReceiptFactory* (consumer) | Provide a factory to create an alternate implementation of PulsarMessageReceipt. | | PulsarMessageReceiptFactory
-| *batcherBuilder* (producer) | Control batching method used by the producer. | DEFAULT | BatcherBuilder
-| *batchingEnabled* (producer) | Control whether automatic batching of messages is enabled for the producer. | true | boolean
-| *batchingMaxMessages* (producer) | The maximum size to batch messages. | 1000 | int
-| *batchingMaxPublishDelayMicros* (producer) | The maximum time period within which the messages sent will be batched if batchingEnabled is true. | 1000 | long
-| *blockIfQueueFull* (producer) | Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError | false | boolean
-| *compressionType* (producer) | Compression type to use. There are 5 enums and the value can be one of: NONE, LZ4, ZLIB, ZSTD, SNAPPY | NONE | CompressionType
-| *initialSequenceId* (producer) | The first message published will have a sequence Id of initialSequenceId 1. | -1 | long
-| *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 [...]
-| *maxPendingMessages* (producer) | Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true | 1000 | int
-| *maxPendingMessagesAcross{zwsp}Partitions* (producer) | The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition. | 50000 | int
-| *messageRouter* (producer) | Custom Message Router to use | | MessageRouter
-| *messageRoutingMode* (producer) | Message Routing Mode to use. There are 3 enums and the value can be one of: SinglePartition, RoundRobinPartition, CustomPartition | RoundRobinPartition | MessageRoutingMode
-| *producerName* (producer) | Name of the producer. If unset, lets Pulsar select a unique identifier. | | String
-| *sendTimeoutMs* (producer) | Send timeout in milliseconds | 30000 | int
-| *autoConfiguration* (advanced) | The pulsar auto configuration | | AutoConfiguration
-| *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
-| *pulsarClient* (advanced) | *Autowired* The pulsar client | | PulsarClient
-|===
// component options: END
-
-
-
-
-
// endpoint options: START
-The Pulsar endpoint is configured using URI syntax:
-
-----
-pulsar:persistence://tenant/namespace/topic
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (4 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *persistence* | *Required* Whether the topic is persistent or non-persistent. There are 2 enums and the value can be one of: persistent, non-persistent | | String
-| *tenant* | *Required* The tenant | | String
-| *namespace* | *Required* The namespace | | String
-| *topic* | *Required* The topic | | String
-|===
-
-
-=== Query Parameters (35 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *ackGroupTimeMillis* (consumer) | Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100 | 100 | long
-| *ackTimeoutMillis* (consumer) | Timeout for unacknowledged messages in milliseconds - defaults to 10000 | 10000 | long
-| *allowManualAcknowledgement* (consumer) | Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs. | false | boolean
-| *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
-| *consumerName* (consumer) | Name of the consumer when subscription is EXCLUSIVE | sole-consumer | String
-| *consumerNamePrefix* (consumer) | Prefix to add to consumer names when a SHARED or FAILOVER subscription is used | cons | String
-| *consumerQueueSize* (consumer) | Size of the consumer queue - defaults to 10 | 10 | int
-| *deadLetterTopic* (consumer) | Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ | | String
-| *maxRedeliverCount* (consumer) | Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created | | Integer
-| *messageListener* (consumer) | Whether to use the messageListener interface, or to receive messages using a separate thread pool | true | boolean
-| *negativeAckRedeliveryDelay{zwsp}Micros* (consumer) | Set the negative acknowledgement delay | 60000000 | long
-| *numberOfConsumers* (consumer) | Number of consumers - defaults to 1 | 1 | int
-| *numberOfConsumerThreads* (consumer) | Number of threads to receive and handle messages when using a separate thread pool | 1 | int
-| *readCompacted* (consumer) | Enable compacted topic reading. | false | boolean
-| *subscriptionInitialPosition* (consumer) | Control the initial position in the topic of a newly created subscription. Default is latest message. There are 2 enums and the value can be one of: EARLIEST, LATEST | LATEST | SubscriptionInitialPosition
-| *subscriptionName* (consumer) | Name of the subscription to use | subs | String
-| *subscriptionTopicsMode* (consumer) | Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions. There are 3 enums and the value can be one of: PersistentOnly, NonPersistentOnly, AllTopics | PersistentOnly | RegexSubscriptionMode
-| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. There are 4 enums and the value can be one of: EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED | EXCLUSIVE | SubscriptionType
-| *topicsPattern* (consumer) | Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace | false | boolean
-| *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
-| *batcherBuilder* (producer) | Control batching method used by the producer. | DEFAULT | BatcherBuilder
-| *batchingEnabled* (producer) | Control whether automatic batching of messages is enabled for the producer. | true | boolean
-| *batchingMaxMessages* (producer) | The maximum size to batch messages. | 1000 | int
-| *batchingMaxPublishDelayMicros* (producer) | The maximum time period within which the messages sent will be batched if batchingEnabled is true. | 1000 | long
-| *blockIfQueueFull* (producer) | Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError | false | boolean
-| *compressionType* (producer) | Compression type to use. There are 5 enums and the value can be one of: NONE, LZ4, ZLIB, ZSTD, SNAPPY | NONE | CompressionType
-| *initialSequenceId* (producer) | The first message published will have a sequence Id of initialSequenceId 1. | -1 | long
-| *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 [...]
-| *maxPendingMessages* (producer) | Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true | 1000 | int
-| *maxPendingMessagesAcross{zwsp}Partitions* (producer) | The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition. | 50000 | int
-| *messageRouter* (producer) | Custom Message Router to use | | MessageRouter
-| *messageRoutingMode* (producer) | Message Routing Mode to use. There are 3 enums and the value can be one of: SinglePartition, RoundRobinPartition, CustomPartition | RoundRobinPartition | MessageRoutingMode
-| *producerName* (producer) | Name of the producer. If unset, lets Pulsar select a unique identifier. | | String
-| *sendTimeoutMs* (producer) | Send timeout in milliseconds | 30000 | int
-|===
// endpoint options: END
-// message-headers options: START
-=== Message headers evaluated by the Pulsar producer
-
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|===
-| Header | Type | Description
-| `CamelPulsarProducerMessageKey` | `String` | Sets the key on the message for the Pulsar routing policy
-| `CamelPulsarProducerMessageProperties` | `Map<String,String>` | The properties to set on the Pulsar message
-| `CamelPulsarProducerEventTime` | `long` | Sets the event time on the message
-|===
-
-=== Message headers set by the Pulsar consumer
-
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|===
-| Header | Type | Description
-| `properties` | `Map<String,String>` | The properties from the Pulsar message or the empty Map if unset on the Pulsar message
-| `producer_name` | `String` | The name of the producer that created the message
-| `sequence_id` | `long` | Sequence identifier of the Pulsar message
-| `publish_time` | `long` | Time the Pulsar message was published to the topic
-| `message_id` | `MessageId` | Unique identifier of the message
-| `event_time` | `long` | The event time associated with the message or 0 if unset on the Pulsar message
-| `key` | `String` | The key of the Pulsar message in String form or the empty string if unset on the Pulsar message
-| `key_bytes` | `byte[]` | The bytes in the key. If the key has been base64 encoded, it is decoded before being returned. Otherwise, if the key is a plain string, the UTF-8 encoded bytes of the string.
-| `topic_name` | `String` | The topic to which the message was published
-| `manual_acknowledgement` | `PulsarManualAcknowledgement` | If allowManualAcknowledgement is set, this will contain the object for manually acknowledging the Pulsar message; otherwise it is unset
-|===
-// message-headers options: END
-
include::{page-component-version}@camel-spring-boot::page$pulsar-starter.adoc[]
diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc
index 18bce1a..a88bee7 100644
--- a/components/camel-quartz/src/main/docs/quartz-component.adoc
+++ b/components/camel-quartz/src/main/docs/quartz-component.adoc
@@ -45,115 +45,12 @@ cron expression is provided, the component uses a simple trigger. If no
`groupName` is provided, the quartz component uses the `Camel` group
name.
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-== Options
-
-
-
// component options: START
-The Quartz component supports 13 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
-| *enableJmx* (consumer) | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true | true | boolean
-| *prefixInstanceName* (consumer) | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default, to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's. | true | boolean
-| *prefixJobNameWithEndpointId* (consumer) | Whether to prefix the quartz job with the endpoint id. This option is default false. | false | boolean
-| *properties* (consumer) | Properties to configure the Quartz scheduler. | | Map
-| *propertiesFile* (consumer) | File name of the properties to load from the classpath | | String
-| *propertiesRef* (consumer) | References to an existing Properties or Map to lookup in the registry to use for configuring quartz. | | String
-| *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
-| *scheduler* (advanced) | To use the custom configured Quartz scheduler, instead of creating a new Scheduler. | | Scheduler
-| *schedulerFactory* (advanced) | To use the custom SchedulerFactory which is used to create the Scheduler. | | SchedulerFactory
-| *autoStartScheduler* (scheduler) | Whether or not the scheduler should be auto started. This options is default true | true | boolean
-| *interruptJobsOnShutdown* (scheduler) | Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted. When a job is interrupted then Camel will mark the exchange to stop continue routing and set java.util.concurrent.RejectedExecutionException as caused exception. Therefore use this with care, as its often better to allow Camel jobs to complete an [...]
-| *startDelayedSeconds* (scheduler) | Seconds to wait before starting the quartz scheduler. | | int
-|===
// component options: END
-
-
-
-
// endpoint options: START
-The Quartz endpoint is configured using URI syntax:
-
-----
-quartz:groupName/triggerName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (2 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *groupName* | The quartz group name to use. The combination of group name and trigger name should be unique. | Camel | String
-| *triggerName* | *Required* The quartz trigger name to use. The combination of group name and trigger name should be unique. | | String
-|===
-
-
-=== Query Parameters (18 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
-| *cron* (consumer) | Specifies a cron expression to define when to trigger. | | String
-| *deleteJob* (consumer) | If set to true, then the trigger automatically delete when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | true | boolean
-| *durableJob* (consumer) | Whether or not the job should remain stored after it is orphaned (no triggers point to it). | false | boolean
-| *pauseJob* (consumer) | If set to true, then the trigger automatically pauses when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | false | boolean
-| *recoverableJob* (consumer) | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. | false | boolean
-| *stateful* (consumer) | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job. | false | boolean
-| *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
-| *customCalendar* (advanced) | Specifies a custom calendar to avoid specific range of date | | Calendar
-| *jobParameters* (advanced) | To configure additional options on the job. | | Map
-| *prefixJobNameWithEndpointId* (advanced) | Whether the job name should be prefixed with endpoint id | false | boolean
-| *triggerParameters* (advanced) | To configure additional options on the trigger. | | Map
-| *usingFixedCamelContextName* (advanced) | If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | false | boolean
-| *autoStartScheduler* (scheduler) | Whether or not the scheduler should be auto started. | true | boolean
-| *fireNow* (scheduler) | If it is true will fire the trigger when the route is start when using SimpleTrigger. | false | boolean
-| *startDelayedSeconds* (scheduler) | Seconds to wait before starting the quartz scheduler. | | int
-| *triggerStartDelay* (scheduler) | In case of scheduler has already started, we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. | 500 | long
-|===
// endpoint options: END
-
-For example, the following routing rule will fire two timer events to
-the `mock:results` endpoint:
-
-[source,java]
-----
-from("quartz://myGroup/myTimerName?trigger.repeatInterval=2&trigger.repeatCount=1").routeId("myRoute")
- .to("mock:result");
-----
-
-When using `stateful=true`, the
-http://quartz-scheduler.org/api/2.0.0/org/quartz/JobDataMap.html[JobDataMap]
-is re-persisted after every execution of the job, thus preserving state
-for the next execution.
-
-[NOTE]
-====
-*Running in OSGi and having multiple bundles with quartz routes*
-
-If you run in OSGi such as Apache ServiceMix, or Apache Karaf, and have
-multiple bundles with Camel routes that start from
-xref:quartz-component.adoc[Quartz] endpoints, then make sure if you assign an `id`
-to the `<camelContext>` that this id is unique, as this is
-required by the `QuartzScheduler` in the OSGi container. If you do not
-set any `id` on `<camelContext>` then a unique id is auto assigned, and there is no problem.
-====
-
== Configuring quartz.properties file
By default Quartz will look for a `quartz.properties` file in the
diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
index 3a53f5b..1b2b1c8 100644
--- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc
+++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
@@ -33,7 +33,6 @@ for this component:
== URI format
-[source]
----
quickfix:configFile[?sessionID=sessionID&lazyCreateEngine=true|false]
----
@@ -43,7 +42,6 @@ the FIX engine (located as a resource found in your classpath). The
optional *sessionID* identifies a specific FIX session. The format of
the sessionID is:
-[source]
----
(BeginString):(SenderCompID)[/(SenderSubID)[/(SenderLocationID)]]->(TargetCompID)[/(TargetSubID)[/(TargetLocationID)]]
----
@@ -57,7 +55,6 @@ component's property *lazyCreateEngines* is being used.
Example URIs:
-[source]
----
quickfix:config.cfg
@@ -82,58 +79,9 @@ include the session-related fields in the FIX message being sent. If a
session is specified in the URI then the component will automatically
inject the session-related fields into the FIX message.
-== Options
-
// component options: START
-The QuickFix component supports 7 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyCreateEngines* (common) | If set to true, the engines will be created and started when needed (when first message is send) | false | boolean
-| *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
-| *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 [...]
-| *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
-| *logFactory* (advanced) | To use the given LogFactory | | LogFactory
-| *messageFactory* (advanced) | To use the given MessageFactory | | MessageFactory
-| *messageStoreFactory* (advanced) | To use the given MessageStoreFactory | | MessageStoreFactory
-|===
// component options: END
-
// endpoint options: START
-The QuickFix endpoint is configured using URI syntax:
-
-----
-quickfix:configurationName
-----
-
-with the following path and query parameters:
-
-=== Path Parameters (1 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *configurationName* | *Required* Path to the quickfix configuration file. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the configuration file using these protocols (classpath is default). ref will lookup the configuration file in the registry. bean will call a method on a bean to be used as the configuration. For bean you can specify the method name after dot, eg bean:myBean.myMethod | | String
-|===
-
-
-=== Query Parameters (6 parameters):
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *lazyCreateEngine* (common) | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used, the engine is started at the endpoint creation. When this parameter is missing, the value of component's property lazyCreateEngines is being used. | false | boolean
-| *sessionID* (common) | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID) | | SessionID
-| *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
-| *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
-| *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 [...]
-|===
// endpoint options: END
@@ -513,86 +461,5 @@ from("quickfix:examples/inprocess.cfg?sessionID=FIX.4.2:TRADER->MARKET").
bean(new MyTradeExecutionProcessor());
----
-== QuickFIX/J Component Prior to Camel 2.5
-
-The *quickfix* component is an implementation of the
-http://www.quickfixj.org/[QuickFIX/J] engine for Java . This engine
-allows to connect to a FIX server which is used to exchange financial
-messages according to http://www.fixprotocol.org/[FIX protocol]
-standard.
-
-*Note:* The component can be used to send/receives messages to a FIX
-server.
-
-== URI format
-
-[source]
-----
-quickfix-server:config file
-quickfix-client:config file
-----
-
-Where *config file* is the location (in your classpath) of the quickfix
-configuration file used to configure the engine at the startup.
-
-*Note:* Information about parameters available for quickfix can be found
-on
-http://www.quickfixj.org/quickfixj/usermanual/usage/configuration.html[QuickFIX/J]
-web site.
-
-The quickfix-server endpoint must be used to receive from FIX server FIX
-messages and quickfix-client endpoint in the case that you want to send
-messages to a FIX gateway.
-
-== Exchange data format
-
-The QuickFIX/J engine is like CXF component a messaging bus using MINA
-as protocol layer to create the socket connection with the FIX engine
-gateway.
-
-When QuickFIX/J engine receives a message, then it create a
-QuickFix.Message instance which is next received by the camel endpoint.
-This object is a 'mapping object' created from a FIX message formatted
-initially as a collection of key value pairs data. You can use this
-object or you can use the method 'toString' to retrieve the original FIX
-message.
-
-*Note:* Alternatively, you can use xref:dataformats:bindy-dataformat.adoc[camel bindy dataformat] to transform the FIX message into your own java POJO
-
-When a message must be send to QuickFix, then you must create a
-QuickFix.Message instance.
-
-== Lazy creating engines
-
-You can configure the QuickFixComponent to
-lazy create and start the engines, which then only start these
-on-demand. For example you can use this when you have multiple Camel
-applications in a cluster with master/slaves. And want the slaves to be
-standby.
-
-== Samples
-
-Direction : to FIX gateway
-
-[source,xml]
-----
-<route>
- <from uri="activemq:queue:fix"/>
- <bean ref="fixService" method="createFixMessage"/> // bean method in charge to transform message into a QuickFix.Message
- <to uri="quickfix-client:META-INF/quickfix/client.cfg"/> // Quickfix engine who will send the FIX messages to the gateway
-</route>
-----
-
-Direction : from FIX gateway
-
-[source,xml]
-----
-<route>
- <from uri="quickfix-server:META-INF/quickfix/server.cfg"/> // QuickFix engine who will receive the message from FIX gateway
- <bean ref="fixService" method="parseFixMessage"/> // bean method parsing the QuickFix.Message
- <to uri="uri="activemq:queue:fix"/>"
-</route>
-----
-
include::{page-component-version}@camel-spring-boot::page$quickfix-starter.adoc[]