CAMEL-10636: Component options docs - Include more details like endpoint options.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1fd504a1 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1fd504a1 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1fd504a1 Branch: refs/heads/master Commit: 1fd504a1253b5e9c0fe83cfd2c2aeeec1f44e1dd Parents: bba84aa Author: Claus Ibsen <davscl...@apache.org> Authored: Wed Dec 21 20:53:56 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Wed Dec 21 20:53:56 2016 +0100 ---------------------------------------------------------------------- camel-core/src/main/docs/direct-component.adoc | 8 +- .../src/main/docs/direct-vm-component.adoc | 12 +- camel-core/src/main/docs/log-component.adoc | 6 +- .../src/main/docs/properties-component.adoc | 36 ++--- camel-core/src/main/docs/rest-component.adoc | 10 +- .../src/main/docs/scheduler-component.adoc | 6 +- camel-core/src/main/docs/seda-component.adoc | 10 +- camel-core/src/main/docs/stub-component.adoc | 10 +- .../src/main/docs/validator-component.adoc | 6 +- camel-core/src/main/docs/vm-component.adoc | 10 +- camel-core/src/main/docs/xslt-component.adoc | 14 +- .../springboot/AMQPComponentConfiguration.java | 123 ++++++++------- .../springboot/JmsComponentConfiguration.java | 2 +- .../src/main/docs/ahc-ws-component.adoc | 16 +- .../camel-ahc/src/main/docs/ahc-component.adoc | 16 +- .../src/main/docs/amqp-component.adoc | 158 ++++++++++--------- .../src/main/docs/apns-component.adoc | 6 +- .../docs/atmosphere-websocket-component.adoc | 18 +-- .../src/main/docs/avro-component.adoc | 6 +- .../src/main/docs/beanstalk-component.adoc | 6 +- .../camel-box/src/main/docs/box-component.adoc | 6 +- .../src/main/docs/braintree-component.adoc | 6 +- .../src/main/docs/cache-component.adoc | 10 +- .../src/main/docs/cometd-component.adoc | 16 +- .../src/main/docs/crypto-component.adoc | 6 +- .../camel-cxf/src/main/docs/cxf-component.adoc | 8 +- .../src/main/docs/cxfrs-component.adoc | 6 +- .../src/main/docs/disruptor-component.adoc | 18 +-- .../src/main/docs/docker-component.adoc | 6 +- .../camel-ejb/src/main/docs/ejb-component.adoc | 8 +- .../src/main/docs/elasticsearch-component.adoc | 6 +- .../src/main/docs/elsql-component.adoc | 12 +- .../src/main/docs/eventadmin-component.adoc | 6 +- .../src/main/docs/facebook-component.adoc | 6 +- .../src/main/docs/flink-component.adoc | 12 +- .../src/main/docs/freemarker-component.adoc | 6 +- .../src/main/docs/ganglia-component.adoc | 6 +- .../main/docs/google-calendar-component.adoc | 8 +- .../src/main/docs/google-drive-component.adoc | 8 +- .../src/main/docs/google-mail-component.adoc | 8 +- .../src/main/docs/google-pubsub-component.adoc | 6 +- .../src/main/docs/guava-eventbus-component.adoc | 8 +- .../src/main/docs/hazelcast-component.adoc | 6 +- .../src/main/docs/hbase-component.adoc | 8 +- .../src/main/docs/hdfs-component.adoc | 6 +- .../src/main/docs/hdfs2-component.adoc | 6 +- .../src/main/docs/http-component.adoc | 16 +- .../src/main/docs/http4-component.adoc | 30 ++-- .../src/main/docs/ibatis-component.adoc | 10 +- .../src/main/docs/jclouds-component.adoc | 8 +- .../src/main/docs/jdbc-component.adoc | 6 +- .../src/main/docs/jetty-component.adoc | 66 ++++---- .../src/main/docs/jgroups-component.adoc | 10 +- .../camel-jms/src/main/docs/jms-component.adoc | 155 +++++++++--------- .../camel/component/jms/JmsComponent.java | 2 +- .../camel/component/jms/JmsConfiguration.java | 1 + .../src/main/docs/jolt-component.adoc | 6 +- .../camel-jpa/src/main/docs/jpa-component.adoc | 12 +- .../camel-jsch/src/main/docs/scp-component.adoc | 6 +- .../src/main/docs/jt400-component.adoc | 6 +- .../src/main/docs/kafka-component.adoc | 6 +- .../src/main/docs/kestrel-component.adoc | 6 +- .../src/main/docs/linkedin-component.adoc | 6 +- .../src/main/docs/lucene-component.adoc | 6 +- .../src/main/docs/lumberjack-component.adoc | 6 +- .../src/main/docs/mail-component.adoc | 8 +- .../src/main/docs/metrics-component.adoc | 6 +- .../src/main/docs/mina-component.adoc | 6 +- .../src/main/docs/mina2-component.adoc | 6 +- .../src/main/docs/mqtt-component.adoc | 10 +- .../camel-msv/src/main/docs/msv-component.adoc | 8 +- .../src/main/docs/mustache-component.adoc | 6 +- .../src/main/docs/mybatis-component.adoc | 8 +- .../src/main/docs/nagios-component.adoc | 6 +- .../src/main/docs/netty-http-component.adoc | 14 +- .../src/main/docs/netty-component.adoc | 8 +- .../src/main/docs/netty4-http-component.adoc | 16 +- .../src/main/docs/netty4-component.adoc | 10 +- .../src/main/docs/olingo2-component.adoc | 6 +- .../src/main/docs/openshift-component.adoc | 12 +- .../src/main/docs/paho-component.adoc | 10 +- .../src/main/docs/paxlogging-component.adoc | 6 +- .../src/main/docs/quartz-component.adoc | 18 +-- .../src/main/docs/quartz2-component.adoc | 22 +-- .../src/main/docs/quickfix-component.adoc | 14 +- .../src/main/docs/restlet-component.adoc | 44 +++--- .../src/main/docs/salesforce-component.adoc | 36 ++--- .../src/main/docs/xquery-component.adoc | 6 +- .../src/main/docs/servicenow-component.adoc | 18 +-- .../src/main/docs/servlet-component.adoc | 18 +-- .../src/main/docs/sjms-batch-component.adoc | 8 +- .../src/main/docs/sjms-component.adoc | 22 +-- .../src/main/docs/slack-component.adoc | 6 +- .../src/main/docs/smpp-component.adoc | 6 +- .../src/main/docs/spark-rest-component.adoc | 26 +-- .../src/main/docs/spark-component.adoc | 8 +- .../src/main/docs/splunk-component.adoc | 6 +- .../src/main/docs/spring-batch-component.adoc | 8 +- .../src/main/docs/spring-event-component.adoc | 6 +- .../camel-sql/src/main/docs/sql-component.adoc | 8 +- .../src/main/docs/sql-stored-component.adoc | 6 +- .../camel-ssh/src/main/docs/ssh-component.adoc | 26 +-- .../src/main/docs/stomp-component.adoc | 14 +- .../src/main/docs/telegram-component.adoc | 6 +- .../src/main/docs/twitter-component.adoc | 20 +-- .../src/main/docs/undertow-component.adoc | 8 +- .../src/main/docs/velocity-component.adoc | 6 +- .../src/main/docs/vertx-component.adoc | 16 +- .../src/main/docs/websocket-component.adoc | 28 ++-- .../src/main/docs/xmlsecurity-component.adoc | 8 +- .../src/main/docs/yammer-component.adoc | 12 +- .../src/main/docs/zookeeper-component.adoc | 6 +- components/readme.adoc | 24 --- docs/user-manual/en/SUMMARY.md | 8 - .../maven/packaging/ReadmeComponentMojo.java | 8 + .../packaging/model/ComponentOptionModel.java | 18 +++ .../src/main/resources/component-options.mvel | 6 +- 117 files changed, 851 insertions(+), 846 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/direct-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/direct-component.adoc b/camel-core/src/main/docs/direct-component.adoc index b14afc2..e383065 100644 --- a/camel-core/src/main/docs/direct-component.adoc +++ b/camel-core/src/main/docs/direct-component.adoc @@ -38,11 +38,11 @@ The Direct component supports 2 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| block | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active. -| timeout | long | The timeout value to use if block is enabled. +| Name | Group | Default | Java Type | Description +| block | | | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active. +| timeout | | 30000 | long | The timeout value to use if block is enabled. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/direct-vm-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/direct-vm-component.adoc b/camel-core/src/main/docs/direct-vm-component.adoc index 1895e65..a6122be 100644 --- a/camel-core/src/main/docs/direct-vm-component.adoc +++ b/camel-core/src/main/docs/direct-vm-component.adoc @@ -51,13 +51,13 @@ The Direct VM component supports 4 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| block | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active. -| timeout | long | The timeout value to use if block is enabled. -| headerFilterStrategy | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. -| propagateProperties | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. +| Name | Group | Default | Java Type | Description +| block | | | boolean | If sending a message to a direct endpoint which has no active consumer then we can tell the producer to block and wait for the consumer to become active. +| timeout | | 30000 | long | The timeout value to use if block is enabled. +| headerFilterStrategy | | | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. +| propagateProperties | | true | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/log-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/log-component.adoc b/camel-core/src/main/docs/log-component.adoc index e23b558..43c9d76 100644 --- a/camel-core/src/main/docs/log-component.adoc +++ b/camel-core/src/main/docs/log-component.adoc @@ -65,10 +65,10 @@ The Log component supports 1 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| exchangeFormatter | ExchangeFormatter | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter. +| Name | Group | Default | Java Type | Description +| exchangeFormatter | | | ExchangeFormatter | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/properties-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/properties-component.adoc b/camel-core/src/main/docs/properties-component.adoc index 0a6f4a9..291be88 100644 --- a/camel-core/src/main/docs/properties-component.adoc +++ b/camel-core/src/main/docs/properties-component.adoc @@ -25,25 +25,25 @@ The Properties component supports 16 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| locations | List | A list of locations to load properties. This option will override any default locations and only use the locations from this option. -| location | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. -| encoding | String | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream) -| propertiesResolver | PropertiesResolver | To use a custom PropertiesResolver -| propertiesParser | PropertiesParser | To use a custom PropertiesParser -| cache | boolean | Whether or not to cache loaded properties. The default value is true. -| propertyPrefix | String | Optional prefix prepended to property names before resolution. -| propertySuffix | String | Optional suffix appended to property names before resolution. -| fallbackToUnaugmentedProperty | boolean | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched. -| defaultFallbackEnabled | boolean | If false the component does not attempt to find a default for the key by looking after the colon separator. -| ignoreMissingLocation | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found. -| prefixToken | String | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN). -| suffixToken | String | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN). -| initialProperties | Properties | Sets initial properties which will be used before any locations are resolved. -| overrideProperties | Properties | Sets a special list of override properties that take precedence and will use first if a property exist. -| systemPropertiesMode | int | Sets the system property mode. +| Name | Group | Default | Java Type | Description +| locations | | | List | A list of locations to load properties. This option will override any default locations and only use the locations from this option. +| location | | | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. +| encoding | | | String | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream) +| propertiesResolver | | | PropertiesResolver | To use a custom PropertiesResolver +| propertiesParser | | | PropertiesParser | To use a custom PropertiesParser +| cache | | | boolean | Whether or not to cache loaded properties. The default value is true. +| propertyPrefix | | | String | Optional prefix prepended to property names before resolution. +| propertySuffix | | | String | Optional suffix appended to property names before resolution. +| fallbackToUnaugmentedProperty | | | boolean | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched. +| defaultFallbackEnabled | | | boolean | If false the component does not attempt to find a default for the key by looking after the colon separator. +| ignoreMissingLocation | | | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found. +| prefixToken | | | String | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN). +| suffixToken | | | String | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN). +| initialProperties | | | Properties | Sets initial properties which will be used before any locations are resolved. +| overrideProperties | | | Properties | Sets a special list of override properties that take precedence and will use first if a property exist. +| systemPropertiesMode | | | int | Sets the system property mode. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/rest-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/rest-component.adoc b/camel-core/src/main/docs/rest-component.adoc index d7396c9..791ddbb 100644 --- a/camel-core/src/main/docs/rest-component.adoc +++ b/camel-core/src/main/docs/rest-component.adoc @@ -29,12 +29,12 @@ The REST component supports 3 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| componentName | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used. -| apiDoc | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. -| host | String | Host and port of HTTP service to use (override host in swagger schema) +| Name | Group | Default | Java Type | Description +| componentName | | | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used. +| apiDoc | | | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. +| host | | | String | Host and port of HTTP service to use (override host in swagger schema) |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/scheduler-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/scheduler-component.adoc b/camel-core/src/main/docs/scheduler-component.adoc index 8c67b61..989225e 100644 --- a/camel-core/src/main/docs/scheduler-component.adoc +++ b/camel-core/src/main/docs/scheduler-component.adoc @@ -42,10 +42,10 @@ The Scheduler component supports 1 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| concurrentTasks | int | Number of threads used by the scheduling thread pool. Is by default using a single thread +| Name | Group | Default | Java Type | Description +| concurrentTasks | | 1 | int | Number of threads used by the scheduling thread pool. Is by default using a single thread |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/seda-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/seda-component.adoc b/camel-core/src/main/docs/seda-component.adoc index dd177b7..00307d0 100644 --- a/camel-core/src/main/docs/seda-component.adoc +++ b/camel-core/src/main/docs/seda-component.adoc @@ -47,12 +47,12 @@ The SEDA component supports 3 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). -| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges. -| defaultQueueFactory | Exchange> | Sets the default queue factory. +| Name | Group | Default | Java Type | Description +| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). +| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges. +| defaultQueueFactory | | | Exchange> | Sets the default queue factory. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/stub-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/stub-component.adoc b/camel-core/src/main/docs/stub-component.adoc index 7400187..e7bf421 100644 --- a/camel-core/src/main/docs/stub-component.adoc +++ b/camel-core/src/main/docs/stub-component.adoc @@ -39,12 +39,12 @@ The Stub component supports 3 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). -| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges. -| defaultQueueFactory | Exchange> | Sets the default queue factory. +| Name | Group | Default | Java Type | Description +| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). +| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges. +| defaultQueueFactory | | | Exchange> | Sets the default queue factory. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/validator-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/validator-component.adoc b/camel-core/src/main/docs/validator-component.adoc index 6bc38cd..8ac1e35 100644 --- a/camel-core/src/main/docs/validator-component.adoc +++ b/camel-core/src/main/docs/validator-component.adoc @@ -61,10 +61,10 @@ The Validator component supports 1 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| resourceResolverFactory | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI +| Name | Group | Default | Java Type | Description +| resourceResolverFactory | | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/vm-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/vm-component.adoc b/camel-core/src/main/docs/vm-component.adoc index b27fbfe..3939353 100644 --- a/camel-core/src/main/docs/vm-component.adoc +++ b/camel-core/src/main/docs/vm-component.adoc @@ -70,12 +70,12 @@ The VM component supports 3 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| queueSize | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). -| concurrentConsumers | int | Sets the default number of concurrent threads processing exchanges. -| defaultQueueFactory | Exchange> | Sets the default queue factory. +| Name | Group | Default | Java Type | Description +| queueSize | | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). +| concurrentConsumers | | 1 | int | Sets the default number of concurrent threads processing exchanges. +| defaultQueueFactory | | | Exchange> | Sets the default queue factory. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/camel-core/src/main/docs/xslt-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/xslt-component.adoc b/camel-core/src/main/docs/xslt-component.adoc index ca7428d..3c10bbc 100644 --- a/camel-core/src/main/docs/xslt-component.adoc +++ b/camel-core/src/main/docs/xslt-component.adoc @@ -76,14 +76,14 @@ The XSLT component supports 5 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| xmlConverter | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter -| uriResolverFactory | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver). -| uriResolver | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory). -| contentCache | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. -| saxon | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. +| Name | Group | Default | Java Type | Description +| xmlConverter | | | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter +| uriResolverFactory | | | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver). +| uriResolver | | | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory). +| contentCache | | true | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. +| saxon | | | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java b/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java index 114bcc8..719141c 100644 --- a/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java +++ b/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java @@ -19,6 +19,7 @@ package org.apache.camel.component.amqp.springboot; import javax.jms.ConnectionFactory; import javax.jms.ExceptionListener; import org.apache.camel.LoggingLevel; +import org.apache.camel.component.amqp.AMQPComponent; import org.apache.camel.component.jms.DefaultTaskExecutorType; import org.apache.camel.component.jms.JmsConfiguration; import org.apache.camel.component.jms.JmsKeyFormatStrategy; @@ -53,7 +54,7 @@ public class AMQPComponentConfiguration { /** * Specifies whether the consumer accept messages while it is stopping. You * may consider enabling this option if you start and stop JMS routes at - * runtime while there are still messages enqued on the queue. If this + * runtime while there are still messages enqueued on the queue. If this * option is false and you stop the JMS route then messages may be rejected * and the JMS broker would have to attempt redeliveries which yet again may * be rejected and eventually the message may be moved at a dead letter @@ -73,7 +74,7 @@ public class AMQPComponentConfiguration { private Boolean allowReplyManagerQuickStop; /** * The JMS acknowledgement mode defined as an Integer. Allows you to set - * vendor-specific extensions to the acknowledgment mode. For the regular + * vendor-specific extensions to the acknowledgment mode.For the regular * modes it is preferable to use the acknowledgementModeName instead. */ private Integer acknowledgementMode; @@ -88,11 +89,11 @@ public class AMQPComponentConfiguration { * The JMS acknowledgement name which is one of: SESSION_TRANSACTED * CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE */ - private String acknowledgementModeName; + private String acknowledgementModeName = "AUTO_ACKNOWLEDGE"; /** * Specifies whether the consumer container should auto-startup. */ - private Boolean autoStartup; + private Boolean autoStartup = true; /** * Sets the cache level by ID for the underlying JMS resources. See * cacheLevelName option for more details. @@ -104,7 +105,7 @@ public class AMQPComponentConfiguration { * CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring * documentation and Transactions Cache Levels for more information. */ - private String cacheLevelName; + private String cacheLevelName = "CACHE_AUTO"; /** * Sets the cache level by name for the reply consumer when doing * request/reply over JMS. This option only applies when using fixed reply @@ -130,15 +131,16 @@ public class AMQPComponentConfiguration { * request/reply over JMS then the option replyToConcurrentConsumers is used * to control number of concurrent consumers on the reply message listener. */ - private Integer concurrentConsumers; + private Integer concurrentConsumers = 1; /** * Specifies the default number of concurrent consumers when doing * request/reply over JMS. See also the maxMessagesPerTask option to control * dynamic scaling up/down of threads. */ - private Integer replyToConcurrentConsumers; + private Integer replyToConcurrentConsumers = 1; /** - * Sets the default connection factory to be use + * The connection factory to be use. A connection factory must be configured + * either on the component or endpoint. */ private ConnectionFactory connectionFactory; /** @@ -154,11 +156,10 @@ public class AMQPComponentConfiguration { /** * Specifies whether persistent delivery is used by default. */ - private Boolean deliveryPersistent; + private Boolean deliveryPersistent = true; /** - * Specifies the delivery mode to be used. Possible values are Possibles - * values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 - * and PERSISTENT = 2. + * Specifies the delivery mode to be used. Possibles values are those + * defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. */ private Integer deliveryMode; /** @@ -186,12 +187,12 @@ public class AMQPComponentConfiguration { * Allows to configure the default errorHandler logging level for logging * uncaught exceptions. */ - private LoggingLevel errorHandlerLoggingLevel; + private LoggingLevel errorHandlerLoggingLevel = LoggingLevel.WARN; /** * Allows to control whether stacktraces should be logged or not by the * default errorHandler. */ - private Boolean errorHandlerLogStackTrace; + private Boolean errorHandlerLogStackTrace = true; /** * Set if the deliveryMode priority or timeToLive qualities of service * should be used when sending messages. This option is based on Spring's @@ -200,7 +201,7 @@ public class AMQPComponentConfiguration { * option which operates at message granularity reading QoS properties * exclusively from the Camel In message headers. */ - private Boolean explicitQosEnabled; + private Boolean explicitQosEnabled = false; /** * Specifies whether the listener session should be exposed when consuming * messages. @@ -213,12 +214,12 @@ public class AMQPComponentConfiguration { * case of dynamic scheduling; see the maxConcurrentConsumers setting). * There is additional doc available from Spring. */ - private Integer idleTaskExecutionLimit; + private Integer idleTaskExecutionLimit = 1; /** * Specify the limit for the number of consumers that are allowed to be idle * at any given time. */ - private Integer idleConsumerLimit; + private Integer idleConsumerLimit = 1; /** * Specifies the maximum number of concurrent consumers when consuming from * JMS (not for request/reply over JMS). See also the maxMessagesPerTask @@ -238,14 +239,14 @@ public class AMQPComponentConfiguration { * Specifies the maximum number of concurrent consumers for continue routing * when timeout occurred when using request/reply over JMS. */ - private Integer replyOnTimeoutToMaxConcurrentConsumers; + private Integer replyOnTimeoutToMaxConcurrentConsumers = 1; /** * The number of messages per task. -1 is unlimited. If you use a range for * concurrent consumers (eg min max) then this option can be used to set a * value to eg 100 to control how fast the consumers will shrink when less * work is required. */ - private Integer maxMessagesPerTask; + private Integer maxMessagesPerTask = -1; /** * To use a custom Spring * org.springframework.jms.support.converter.MessageConverter so you can be @@ -255,19 +256,24 @@ public class AMQPComponentConfiguration { private MessageConverter messageConverter; /** * Specifies whether Camel should auto map the received JMS message to a - * suited payload type such as javax.jms.TextMessage to a String etc. See - * section about how mapping works below for more details. + * suited payload type such as javax.jms.TextMessage to a String etc. */ - private Boolean mapJmsMessage; + private Boolean mapJmsMessage = true; /** - * When sending specifies whether message IDs should be added. + * When sending specifies whether message IDs should be added. This is just + * an hint to the JMS broker.If the JMS provider accepts this hint these + * messages must have the message ID set to null; if the provider ignores + * the hint the message ID must be set to its normal unique value */ - private Boolean messageIdEnabled; + private Boolean messageIdEnabled = true; /** * Specifies whether timestamps should be enabled by default on sending - * messages. + * messages. This is just an hint to the JMS broker.If the JMS provider + * accepts this hint these messages must have the timestamp set to zero; if + * the provider ignores the hint the timestamp must be set to its normal + * value */ - private Boolean messageTimestampEnabled; + private Boolean messageTimestampEnabled = true; /** * If true Camel will always make a JMS message copy of the message when it * is passed to the producer for sending. Copying the message is needed in @@ -286,7 +292,7 @@ public class AMQPComponentConfiguration { * is the lowest priority and 9 is the highest). The explicitQosEnabled * option must also be enabled in order for this option to have any effect. */ - private Integer priority; + private Integer priority = 4; /** * Specifies whether to inhibit the delivery of messages published by its * own connection. @@ -295,13 +301,13 @@ public class AMQPComponentConfiguration { /** * The timeout for receiving messages (in milliseconds). */ - private Long receiveTimeout; + private Long receiveTimeout = 1000L; /** * Specifies the interval between recovery attempts i.e. when a connection * is being refreshed in milliseconds. The default is 5000 ms that is 5 * seconds. */ - private Long recoveryInterval; + private Long recoveryInterval = 5000L; /** * Deprecated: Enabled by default if you specify a durableSubscriptionName * and a clientId. @@ -317,7 +323,7 @@ public class AMQPComponentConfiguration { * When sending messages specifies the time-to-live of the message (in * milliseconds). */ - private Long timeToLive; + private Long timeToLive = -1L; /** * Specifies whether to use transacted mode */ @@ -326,7 +332,7 @@ public class AMQPComponentConfiguration { * If true Camel will create a JmsTransactionManager if there is no * transactionManager injected when option transacted=true. */ - private Boolean lazyCreateTransactionManager; + private Boolean lazyCreateTransactionManager = true; /** * The Spring transaction manager to use. */ @@ -340,7 +346,7 @@ public class AMQPComponentConfiguration { * The timeout value of the transaction (in seconds) if using transacted * mode. */ - private Integer transactionTimeout; + private Integer transactionTimeout = -1; /** * Specifies whether to test the connection on startup. This ensures that * when Camel starts that all the JMS consumers have a valid connection to @@ -381,7 +387,7 @@ public class AMQPComponentConfiguration { * and thus have per message individual timeout values. See also the * requestTimeoutCheckerInterval option. */ - private Long requestTimeout; + private Long requestTimeout = 20000L; /** * Configures how often Camel should check for timed out Exchanges when * doing request/reply over JMS. By default Camel checks once per second. @@ -389,7 +395,7 @@ public class AMQPComponentConfiguration { * this interval to check more frequently. The timeout is determined by the * option requestTimeout. */ - private Long requestTimeoutCheckerInterval; + private Long requestTimeoutCheckerInterval = 1000L; /** * You can transfer the exchange over the wire instead of just the body and * headers. The following fields are transferred: In body Out body Fault @@ -416,12 +422,13 @@ public class AMQPComponentConfiguration { /** * If enabled and you are using Request Reply messaging (InOut) and an * Exchange failed with a SOAP fault (not exception) on the consumer side - * then the fault flag on link org.apache.camel.MessageisFault() will be - * send back in the response as a JMS header with the key link - * JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault - * flag will be set on the link org.apache.camel.MessagesetFault(boolean). - * You may want to enable this when using Camel components that support - * faults such as SOAP based such as cxf or spring-ws. + * then the fault flag on MessageisFault() will be send back in the response + * as a JMS header with the key org.apache.camel.component.jms. + * JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel + * the returned fault flag will be set on the link + * org.apache.camel.MessagesetFault(boolean). You may want to enable this + * when using Camel components that support faults such as SOAP based such + * as cxf or spring-ws. */ private Boolean transferFault; /** @@ -479,7 +486,7 @@ public class AMQPComponentConfiguration { * Whether to allow sending messages with no body. If this option is false * and the message body is null then an JMSException is thrown. */ - private Boolean allowNullBody; + private Boolean allowNullBody = true; /** * Only applicable when sending to JMS destination using InOnly (eg fire and * forget). Enabling this option will enrich the Camel Exchange with the @@ -529,12 +536,6 @@ public class AMQPComponentConfiguration { @NestedConfigurationProperty private QueueBrowseStrategy queueBrowseStrategy; /** - * To use a custom HeaderFilterStrategy to filter header to and from Camel - * message. - */ - @NestedConfigurationProperty - private HeaderFilterStrategy headerFilterStrategy; - /** * To use the given MessageCreatedStrategy which are invoked when Camel * creates new instances of javax.jms.Message objects when Camel is sending * a JMS message. @@ -546,12 +547,18 @@ public class AMQPComponentConfiguration { * the actual correlation id when doing request/reply over JMS and when the * option useMessageIDAsCorrelationID is enabled. */ - private Integer waitForProvisionCorrelationToBeUpdatedCounter; + private Integer waitForProvisionCorrelationToBeUpdatedCounter = 50; /** * Interval in millis to sleep each time while waiting for provisional * correlation id to be updated. */ - private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime; + private Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = 100L; + /** + * To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter + * header to and from Camel message. + */ + @NestedConfigurationProperty + private HeaderFilterStrategy headerFilterStrategy; public JmsConfiguration getConfiguration() { return configuration; @@ -1126,15 +1133,6 @@ public class AMQPComponentConfiguration { this.queueBrowseStrategy = queueBrowseStrategy; } - public HeaderFilterStrategy getHeaderFilterStrategy() { - return headerFilterStrategy; - } - - public void setHeaderFilterStrategy( - HeaderFilterStrategy headerFilterStrategy) { - this.headerFilterStrategy = headerFilterStrategy; - } - public MessageCreatedStrategy getMessageCreatedStrategy() { return messageCreatedStrategy; } @@ -1161,4 +1159,13 @@ public class AMQPComponentConfiguration { Long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime) { this.waitForProvisionCorrelationToBeUpdatedThreadSleepingTime = waitForProvisionCorrelationToBeUpdatedThreadSleepingTime; } + + public HeaderFilterStrategy getHeaderFilterStrategy() { + return headerFilterStrategy; + } + + public void setHeaderFilterStrategy( + HeaderFilterStrategy headerFilterStrategy) { + this.headerFilterStrategy = headerFilterStrategy; + } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java ---------------------------------------------------------------------- diff --git a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java index fad5811..caa722f 100644 --- a/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java +++ b/components-starter/camel-jms-starter/src/main/java/org/apache/camel/component/jms/springboot/JmsComponentConfiguration.java @@ -101,7 +101,7 @@ public class JmsComponentConfiguration { * Sets the cache level by ID for the underlying JMS resources. See * cacheLevelName option for more details. */ - private Integer cacheLevel = true; + private Integer cacheLevel; /** * Sets the cache level by name for the underlying JMS resources. Possible * values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc index 5768333..9b3ff5c 100644 --- a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc +++ b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc @@ -52,15 +52,15 @@ The AHC Websocket component supports 6 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| client | AsyncHttpClient | To use a custom AsyncHttpClient -| binding | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. -| clientConfig | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. -| sslContextParameters | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. -| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. +| Name | Group | Default | Java Type | Description +| client | | | AsyncHttpClient | To use a custom AsyncHttpClient +| binding | | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. +| clientConfig | | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. +| sslContextParameters | | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. +| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. +| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/1fd504a1/components/camel-ahc/src/main/docs/ahc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ahc/src/main/docs/ahc-component.adoc b/components/camel-ahc/src/main/docs/ahc-component.adoc index 17bbe52..411d9b5 100644 --- a/components/camel-ahc/src/main/docs/ahc-component.adoc +++ b/components/camel-ahc/src/main/docs/ahc-component.adoc @@ -99,15 +99,15 @@ The AHC component supports 6 options which are listed below. {% raw %} -[width="100%",cols="2,1m,7",options="header"] +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -| Name | Java Type | Description -| client | AsyncHttpClient | To use a custom AsyncHttpClient -| binding | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. -| clientConfig | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. -| sslContextParameters | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. -| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. +| Name | Group | Default | Java Type | Description +| client | | | AsyncHttpClient | To use a custom AsyncHttpClient +| binding | | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. +| clientConfig | | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. +| sslContextParameters | | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. +| allowJavaSerializedObject | | | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. +| headerFilterStrategy | | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. |======================================================================= {% endraw %} // component options: END
