CAMEL-10940: Component docs - Separate path and query parameters
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/c776464d Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c776464d Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c776464d Branch: refs/heads/master Commit: c776464dafeca9a7a7ee7cafe628f4720c08b548 Parents: 01a0daa Author: Claus Ibsen <davscl...@apache.org> Authored: Sat Mar 4 16:56:51 2017 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Sat Mar 4 16:56:51 2017 +0100 ---------------------------------------------------------------------- camel-core/src/main/docs/bean-component.adoc | 19 ++++++++++++--- camel-core/src/main/docs/binding-component.adoc | 19 ++++++++++++--- camel-core/src/main/docs/browse-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/class-component.adoc | 17 +++++++++++-- .../src/main/docs/controlbus-component.adoc | 19 ++++++++++++--- .../src/main/docs/dataformat-component.adoc | 19 ++++++++++++--- camel-core/src/main/docs/dataset-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/direct-component.adoc | 17 +++++++++++-- .../src/main/docs/direct-vm-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/file-component.adoc | 17 +++++++++++-- .../src/main/docs/language-component.adoc | 19 ++++++++++++--- camel-core/src/main/docs/log-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/mock-component.adoc | 17 +++++++++++-- .../src/main/docs/properties-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/ref-component.adoc | 17 +++++++++++-- .../src/main/docs/rest-api-component.adoc | 19 ++++++++++++--- camel-core/src/main/docs/rest-component.adoc | 21 ++++++++++++---- .../src/main/docs/scheduler-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/seda-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/stub-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/test-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/timer-component.adoc | 17 +++++++++++-- .../src/main/docs/validator-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/vm-component.adoc | 17 +++++++++++-- camel-core/src/main/docs/xslt-component.adoc | 17 +++++++++++-- .../src/main/docs/ahc-ws-component.adoc | 17 +++++++++++-- .../camel-ahc/src/main/docs/ahc-component.adoc | 17 +++++++++++-- .../src/main/docs/amqp-component.adoc | 19 ++++++++++++--- .../src/main/docs/apns-component.adoc | 17 +++++++++++-- .../src/main/docs/asterisk-component.adoc | 17 +++++++++++-- .../src/main/docs/atmos-component.adoc | 19 ++++++++++++--- .../docs/atmosphere-websocket-component.adoc | 17 +++++++++++-- .../src/main/docs/atom-component.adoc | 17 +++++++++++-- .../src/main/docs/avro-component.adoc | 23 ++++++++++++++---- .../src/main/docs/aws-cw-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-ddb-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-ddbstream-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-ec2-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-kinesis-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-s3-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-sdb-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-ses-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-sns-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-sqs-component.adoc | 17 +++++++++++-- .../src/main/docs/aws-swf-component.adoc | 17 +++++++++++-- .../src/main/docs/azure-blob-component.adoc | 17 +++++++++++-- .../src/main/docs/azure-queue-component.adoc | 17 +++++++++++-- .../src/main/docs/bean-validator-component.adoc | 17 +++++++++++-- .../src/main/docs/beanstalk-component.adoc | 17 +++++++++++-- .../src/main/docs/bonita-component.adoc | 17 +++++++++++-- .../camel-box/src/main/docs/box-component.adoc | 19 ++++++++++++--- .../src/main/docs/braintree-component.adoc | 19 ++++++++++++--- .../src/main/docs/cache-component.adoc | 17 +++++++++++-- .../src/main/docs/cql-component.adoc | 23 ++++++++++++++---- .../main/docs/chronicle-engine-component.adoc | 19 ++++++++++++--- .../src/main/docs/chunk-component.adoc | 17 +++++++++++-- .../src/main/docs/cm-sms-component.adoc | 17 +++++++++++-- .../src/main/docs/cmis-component.adoc | 17 +++++++++++-- .../src/main/docs/coap-component.adoc | 17 +++++++++++-- .../src/main/docs/cometd-component.adoc | 21 ++++++++++++---- .../src/main/docs/consul-component.adoc | 17 +++++++++++-- .../src/main/docs/context-component.adoc | 19 ++++++++++++--- .../src/main/docs/couchbase-component.adoc | 19 ++++++++++++--- .../src/main/docs/couchdb-component.adoc | 23 ++++++++++++++---- .../src/main/docs/crypto-component.adoc | 19 ++++++++++++--- .../camel-cxf/src/main/docs/cxf-component.adoc | 19 ++++++++++++--- .../src/main/docs/cxfrs-component.adoc | 19 ++++++++++++--- .../src/main/docs/disruptor-component.adoc | 17 +++++++++++-- .../camel-dns/src/main/docs/dns-component.adoc | 17 +++++++++++-- .../src/main/docs/docker-component.adoc | 17 +++++++++++-- .../src/main/docs/dozer-component.adoc | 17 +++++++++++-- .../src/main/docs/drill-component.adoc | 17 +++++++++++-- .../src/main/docs/dropbox-component.adoc | 17 +++++++++++-- .../src/main/docs/ehcache-component.adoc | 17 +++++++++++-- .../camel-ejb/src/main/docs/ejb-component.adoc | 17 +++++++++++-- .../src/main/docs/elasticsearch-component.adoc | 17 +++++++++++-- .../src/main/docs/elasticsearch5-component.adoc | 17 +++++++++++-- .../src/main/docs/elsql-component.adoc | 19 ++++++++++++--- .../src/main/docs/etcd-component.adoc | 19 ++++++++++++--- .../src/main/docs/eventadmin-component.adoc | 17 +++++++++++-- .../src/main/docs/exec-component.adoc | 17 +++++++++++-- .../src/main/docs/facebook-component.adoc | 17 +++++++++++-- .../src/main/docs/flatpack-component.adoc | 19 ++++++++++++--- .../src/main/docs/flink-component.adoc | 17 +++++++++++-- .../camel-fop/src/main/docs/fop-component.adoc | 17 +++++++++++-- .../src/main/docs/freemarker-component.adoc | 17 +++++++++++-- .../camel-ftp/src/main/docs/ftp-component.adoc | 21 ++++++++++++---- .../camel-ftp/src/main/docs/ftps-component.adoc | 21 ++++++++++++---- .../camel-ftp/src/main/docs/sftp-component.adoc | 21 ++++++++++++---- .../src/main/docs/ganglia-component.adoc | 19 ++++++++++++--- .../src/main/docs/geocoder-component.adoc | 19 ++++++++++++--- .../camel-git/src/main/docs/git-component.adoc | 17 +++++++++++-- .../src/main/docs/github-component.adoc | 19 ++++++++++++--- .../main/docs/google-calendar-component.adoc | 19 ++++++++++++--- .../src/main/docs/google-drive-component.adoc | 19 ++++++++++++--- .../src/main/docs/google-mail-component.adoc | 19 ++++++++++++--- .../src/main/docs/google-pubsub-component.adoc | 19 ++++++++++++--- .../src/main/docs/gora-component.adoc | 17 +++++++++++-- .../src/main/docs/grape-component.adoc | 19 ++++++++++++--- .../src/main/docs/guava-eventbus-component.adoc | 17 +++++++++++-- .../src/main/docs/hazelcast-component.adoc | 19 ++++++++++++--- .../src/main/docs/hbase-component.adoc | 17 +++++++++++-- .../src/main/docs/hdfs-component.adoc | 21 ++++++++++++---- .../src/main/docs/hdfs2-component.adoc | 21 ++++++++++++---- .../src/main/docs/hipchat-component.adoc | 21 ++++++++++++---- .../src/main/docs/http-component.adoc | 17 +++++++++++-- .../src/main/docs/http4-component.adoc | 17 +++++++++++-- .../src/main/docs/ibatis-component.adoc | 17 +++++++++++-- .../src/main/docs/infinispan-component.adoc | 17 +++++++++++-- .../src/main/docs/influxdb-component.adoc | 17 +++++++++++-- .../camel-irc/src/main/docs/irc-component.adoc | 19 ++++++++++++--- .../src/main/docs/ironmq-component.adoc | 17 +++++++++++-- .../src/main/docs/javaspace-component.adoc | 17 +++++++++++-- .../src/main/docs/jbpm-component.adoc | 17 +++++++++++-- .../src/main/docs/jcache-component.adoc | 17 +++++++++++-- .../src/main/docs/jclouds-component.adoc | 19 ++++++++++++--- .../camel-jcr/src/main/docs/jcr-component.adoc | 19 ++++++++++++--- .../src/main/docs/jdbc-component.adoc | 17 +++++++++++-- .../src/main/docs/jetty-component.adoc | 17 +++++++++++-- .../src/main/docs/jgroups-component.adoc | 17 +++++++++++-- .../src/main/docs/jing-component.adoc | 17 +++++++++++-- .../src/main/docs/jira-component.adoc | 17 +++++++++++-- .../camel-jms/src/main/docs/jms-component.adoc | 19 ++++++++++++--- .../camel-jmx/src/main/docs/jmx-component.adoc | 17 +++++++++++-- .../src/main/docs/jolt-component.adoc | 17 +++++++++++-- .../camel-jpa/src/main/docs/jpa-component.adoc | 17 +++++++++++-- .../camel-jsch/src/main/docs/scp-component.adoc | 21 ++++++++++++---- .../src/main/docs/jt400-component.adoc | 25 +++++++++++++++----- .../src/main/docs/kafka-component.adoc | 17 +++++++++++-- .../src/main/docs/kestrel-component.adoc | 19 ++++++++++++--- .../src/main/docs/krati-component.adoc | 17 +++++++++++-- .../src/main/docs/kubernetes-component.adoc | 17 +++++++++++-- .../src/main/docs/ldap-component.adoc | 17 +++++++++++-- .../src/main/docs/linkedin-component.adoc | 19 ++++++++++++--- .../src/main/docs/lucene-component.adoc | 19 ++++++++++++--- .../src/main/docs/lumberjack-component.adoc | 19 ++++++++++++--- .../src/main/docs/mail-component.adoc | 19 ++++++++++++--- .../src/main/docs/metrics-component.adoc | 19 ++++++++++++--- .../src/main/docs/mina-component.adoc | 21 ++++++++++++---- .../src/main/docs/mina2-component.adoc | 21 ++++++++++++---- .../src/main/docs/mllp-component.adoc | 19 ++++++++++++--- .../src/main/docs/mongodb-gridfs-component.adoc | 17 +++++++++++-- .../src/main/docs/mongodb-component.adoc | 17 +++++++++++-- .../src/main/docs/mongodb3-component.adoc | 17 +++++++++++-- .../src/main/docs/mqtt-component.adoc | 17 +++++++++++-- .../camel-msv/src/main/docs/msv-component.adoc | 17 +++++++++++-- .../src/main/docs/mustache-component.adoc | 17 +++++++++++-- .../src/main/docs/mvel-component.adoc | 17 +++++++++++-- .../src/main/docs/mybatis-component.adoc | 17 +++++++++++-- .../src/main/docs/nagios-component.adoc | 19 ++++++++++++--- .../src/main/docs/nats-component.adoc | 17 +++++++++++-- .../src/main/docs/netty-http-component.adoc | 23 ++++++++++++++---- .../src/main/docs/netty-component.adoc | 21 ++++++++++++---- .../src/main/docs/netty4-http-component.adoc | 23 ++++++++++++++---- .../src/main/docs/netty4-component.adoc | 21 ++++++++++++---- .../src/main/docs/olingo2-component.adoc | 19 ++++++++++++--- .../src/main/docs/openshift-component.adoc | 17 +++++++++++-- .../main/docs/openstack-cinder-component.adoc | 17 +++++++++++-- .../main/docs/openstack-glance-component.adoc | 17 +++++++++++-- .../main/docs/openstack-keystone-component.adoc | 17 +++++++++++-- .../main/docs/openstack-neutron-component.adoc | 17 +++++++++++-- .../src/main/docs/openstack-nova-component.adoc | 17 +++++++++++-- .../main/docs/openstack-swift-component.adoc | 17 +++++++++++-- .../src/main/docs/optaplanner-component.adoc | 17 +++++++++++-- .../src/main/docs/paho-component.adoc | 17 +++++++++++-- .../src/main/docs/paxlogging-component.adoc | 17 +++++++++++-- .../camel-pdf/src/main/docs/pdf-component.adoc | 17 +++++++++++-- .../src/main/docs/pgevent-component.adoc | 23 ++++++++++++++---- .../src/main/docs/lpr-component.adoc | 21 ++++++++++++---- .../src/main/docs/quartz-component.adoc | 19 ++++++++++++--- .../src/main/docs/quartz2-component.adoc | 19 ++++++++++++--- .../src/main/docs/quickfix-component.adoc | 17 +++++++++++-- .../src/main/docs/rabbitmq-component.adoc | 21 ++++++++++++---- .../main/docs/reactive-streams-component.adoc | 17 +++++++++++-- .../src/main/docs/restlet-component.adoc | 23 ++++++++++++++---- .../camel-rmi/src/main/docs/rmi-component.adoc | 21 ++++++++++++---- .../src/main/docs/routebox-component.adoc | 17 +++++++++++-- .../camel-rss/src/main/docs/rss-component.adoc | 17 +++++++++++-- .../src/main/docs/salesforce-component.adoc | 19 ++++++++++++--- .../src/main/docs/sap-netweaver-component.adoc | 17 +++++++++++-- .../src/main/docs/xquery-component.adoc | 17 +++++++++++-- .../src/main/docs/schematron-component.adoc | 17 +++++++++++-- .../src/main/docs/servicenow-component.adoc | 17 +++++++++++-- .../src/main/docs/servlet-component.adoc | 17 +++++++++++-- .../camel-sip/src/main/docs/sip-component.adoc | 17 +++++++++++-- .../src/main/docs/sjms-batch-component.adoc | 17 +++++++++++-- .../src/main/docs/sjms-component.adoc | 19 ++++++++++++--- .../src/main/docs/slack-component.adoc | 17 +++++++++++-- .../src/main/docs/smpp-component.adoc | 19 ++++++++++++--- .../src/main/docs/snmp-component.adoc | 19 ++++++++++++--- .../src/main/docs/solr-component.adoc | 19 ++++++++++++--- .../src/main/docs/spark-rest-component.adoc | 19 ++++++++++++--- .../src/main/docs/spark-component.adoc | 17 +++++++++++-- .../src/main/docs/splunk-component.adoc | 17 +++++++++++-- .../src/main/docs/spring-batch-component.adoc | 17 +++++++++++-- .../main/docs/spring-integration-component.adoc | 17 +++++++++++-- .../src/main/docs/spring-ldap-component.adoc | 17 +++++++++++-- .../src/main/docs/spring-redis-component.adoc | 19 ++++++++++++--- .../src/main/docs/spring-ws-component.adoc | 21 ++++++++++++---- .../src/main/docs/spring-event-component.adoc | 17 +++++++++++-- .../camel-sql/src/main/docs/sql-component.adoc | 17 +++++++++++-- .../src/main/docs/sql-stored-component.adoc | 17 +++++++++++-- .../camel-ssh/src/main/docs/ssh-component.adoc | 19 ++++++++++++--- .../src/main/docs/stax-component.adoc | 17 +++++++++++-- .../src/main/docs/stomp-component.adoc | 17 +++++++++++-- .../src/main/docs/stream-component.adoc | 17 +++++++++++-- .../main/docs/string-template-component.adoc | 17 +++++++++++-- .../src/main/docs/telegram-component.adoc | 19 ++++++++++++--- .../src/main/docs/tika-component.adoc | 17 +++++++++++-- .../src/main/docs/twitter-component.adoc | 17 +++++++++++-- .../src/main/docs/undertow-component.adoc | 17 +++++++++++-- .../src/main/docs/velocity-component.adoc | 17 +++++++++++-- .../src/main/docs/vertx-component.adoc | 17 +++++++++++-- .../src/main/docs/weather-component.adoc | 17 +++++++++++-- .../src/main/docs/websocket-component.adoc | 21 ++++++++++++---- .../src/main/docs/xmlrpc-component.adoc | 17 +++++++++++-- .../src/main/docs/xmlsecurity-component.adoc | 19 ++++++++++++--- .../src/main/docs/xmpp-component.adoc | 21 ++++++++++++---- .../src/main/docs/yammer-component.adoc | 17 +++++++++++-- .../src/main/docs/zookeeper-component.adoc | 19 ++++++++++++--- .../camel/maven/packaging/UpdateReadmeMojo.java | 7 +++++- .../maven/packaging/model/ComponentModel.java | 9 +++++++ .../src/main/resources/endpoint-options.mvel | 16 ++++++++++++- 223 files changed, 3447 insertions(+), 559 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/bean-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/bean-component.adoc b/camel-core/src/main/docs/bean-component.adoc index 48cbd84..86337d5 100644 --- a/camel-core/src/main/docs/bean-component.adoc +++ b/camel-core/src/main/docs/bean-component.adoc @@ -8,7 +8,7 @@ The *bean:* component binds beans to Camel message exchanges. [source,java] --------------------- -bean:beanID[?options] +bean:beanName[?options] --------------------- Where *beanID* can be any string which is used to look up the bean in @@ -24,13 +24,26 @@ The Bean component has no options. // endpoint options: START -The Bean component supports 6 endpoint options which are listed below: +The Bean component is configured using the URI syntax with the following path and query parameters: + + bean:beanName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanName | | String | *Required* Sets the name of the bean to invoke +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanName | producer | | String | *Required* Sets the name of the bean to invoke | method | producer | | String | Sets the name of the method to invoke on the bean | cache | advanced | false | boolean | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | multiParameterArray | advanced | false | boolean | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/binding-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/binding-component.adoc b/camel-core/src/main/docs/binding-component.adoc index 809d3d0..bfa790c 100644 --- a/camel-core/src/main/docs/binding-component.adoc +++ b/camel-core/src/main/docs/binding-component.adoc @@ -26,14 +26,27 @@ The Binding component has no options. // endpoint options: START -The Binding component supports 6 endpoint options which are listed below: +The Binding component is configured using the URI syntax with the following path and query parameters: + + binding:bindingName:delegateUri + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| bindingName | | String | *Required* Name of the binding to lookup in the Camel registry. +| delegateUri | | String | *Required* Uri of the delegate endpoint. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| bindingName | common | | String | *Required* Name of the binding to lookup in the Camel registry. -| delegateUri | common | | String | *Required* Uri of the delegate endpoint. | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/browse-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/browse-component.adoc b/camel-core/src/main/docs/browse-component.adoc index a2197d4..1bf45a5 100644 --- a/camel-core/src/main/docs/browse-component.adoc +++ b/camel-core/src/main/docs/browse-component.adoc @@ -27,13 +27,26 @@ The Browse component has no options. // endpoint options: START -The Browse component supports 5 endpoint options which are listed below: +The Browse component is configured using the URI syntax with the following path and query parameters: + + browse:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* A name which can be any string to uniquely identify the endpoint +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* A name which can be any string to uniquely identify the endpoint | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/class-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/class-component.adoc b/camel-core/src/main/docs/class-component.adoc index 4163df9..0a22705 100644 --- a/camel-core/src/main/docs/class-component.adoc +++ b/camel-core/src/main/docs/class-component.adoc @@ -27,13 +27,26 @@ The Class component has no options. // endpoint options: START -The Class component supports 6 endpoint options which are listed below: +The Class component is configured using the URI syntax with the following path and query parameters: + + class:beanName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| beanName | | String | *Required* Sets the name of the bean to invoke +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| beanName | producer | | String | *Required* Sets the name of the bean to invoke | method | producer | | String | Sets the name of the method to invoke on the bean | cache | advanced | false | boolean | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | multiParameterArray | advanced | false | boolean | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/controlbus-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/controlbus-component.adoc b/camel-core/src/main/docs/controlbus-component.adoc index fb8e87b..183749d 100644 --- a/camel-core/src/main/docs/controlbus-component.adoc +++ b/camel-core/src/main/docs/controlbus-component.adoc @@ -68,14 +68,27 @@ The Control Bus component has no options. // endpoint options: START -The Control Bus component supports 7 endpoint options which are listed below: +The Control Bus component is configured using the URI syntax with the following path and query parameters: + + controlbus:command:language + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| command | | String | *Required* Command can be either route or language +| language | | Language | Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation then the result is put in the message body. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| command | producer | | String | *Required* Command can be either route or language -| language | producer | | Language | Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation then the result is put in the message body. | action | producer | | String | To denote an action that can be either: start stop or status. To either start or stop a route or to get the status of the route as output in the message body. You can use suspend and resume from Camel 2.11.1 onwards to either suspend or resume a route. And from Camel 2.11.1 onwards you can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for if routeId is not defined then you get statistics for the entire CamelContext. | async | producer | false | boolean | Whether to execute the control bus task asynchronously. Important: If this option is enabled then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously. | loggingLevel | producer | INFO | LoggingLevel | Logging level used for logging when task is done or if any exceptions occurred during processing the task. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/dataformat-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/dataformat-component.adoc b/camel-core/src/main/docs/dataformat-component.adoc index 2fa8780..31815cf 100644 --- a/camel-core/src/main/docs/dataformat-component.adoc +++ b/camel-core/src/main/docs/dataformat-component.adoc @@ -28,14 +28,27 @@ The Data Format component has no options. // endpoint options: START -The Data Format component supports 3 endpoint options which are listed below: +The Data Format component is configured using the URI syntax with the following path and query parameters: + + dataformat:name:operation + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of data format +| operation | | String | *Required* Operation to use either marshal or unmarshal +|======================================================================= +{% endraw %} + +#### 1 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | producer | | String | *Required* Name of data format -| operation | producer | | String | *Required* Operation to use either marshal or unmarshal | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= {% endraw %} http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/dataset-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/dataset-component.adoc b/camel-core/src/main/docs/dataset-component.adoc index b4f8245..d920684 100644 --- a/camel-core/src/main/docs/dataset-component.adoc +++ b/camel-core/src/main/docs/dataset-component.adoc @@ -50,13 +50,26 @@ The Dataset component has no options. // endpoint options: START -The Dataset component supports 20 endpoint options which are listed below: +The Dataset component is configured using the URI syntax with the following path and query parameters: + + dataset:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | DataSet | *Required* Name of DataSet to lookup in the registry +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | DataSet | *Required* Name of DataSet to lookup in the registry | dataSetIndex | common | lenient | String | Controls the behaviour of the CamelDataSetIndex header. For Consumers: - off = the header will not be set - strict/lenient = the header will be set For Producers: - off = the header value will not be verified and will not be set if it is not present = strict = the header value must be present and will be verified = lenient = the header value will be verified if it is present and will be set if it is not present | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | initialDelay | consumer | 1000 | long | Time period in millis to wait before starting sending messages. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 8bf62c6..48cd986 100644 --- a/camel-core/src/main/docs/direct-component.adoc +++ b/camel-core/src/main/docs/direct-component.adoc @@ -48,13 +48,26 @@ The Direct component supports 3 options which are listed below. // endpoint options: START -The Direct component supports 8 endpoint options which are listed below: +The Direct component is configured using the URI syntax with the following path and query parameters: + + direct:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of direct endpoint +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of direct endpoint | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 3e8b226..fed6179 100644 --- a/camel-core/src/main/docs/direct-vm-component.adoc +++ b/camel-core/src/main/docs/direct-vm-component.adoc @@ -61,13 +61,26 @@ The Direct VM component supports 5 options which are listed below. // endpoint options: START -The Direct VM component supports 10 endpoint options which are listed below: +The Direct VM component is configured using the URI syntax with the following path and query parameters: + + direct-vm:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of direct-vm endpoint +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of direct-vm endpoint | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/file-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc index 651a102..d548fe2 100644 --- a/camel-core/src/main/docs/file-component.adoc +++ b/camel-core/src/main/docs/file-component.adoc @@ -60,13 +60,26 @@ The File component has no options. // endpoint options: START -The File component supports 81 endpoint options which are listed below: +The File component is configured using the URI syntax with the following path and query parameters: + + file:directoryName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| directoryName | | File | *Required* The starting directory +|======================================================================= +{% endraw %} + +#### 80 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| directoryName | common | | File | *Required* The starting directory | charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. | doneFileName | common | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. | fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/language-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/language-component.adoc b/camel-core/src/main/docs/language-component.adoc index 9504b98..08d376c 100644 --- a/camel-core/src/main/docs/language-component.adoc +++ b/camel-core/src/main/docs/language-component.adoc @@ -42,14 +42,27 @@ The Language component has no options. // endpoint options: START -The Language component supports 8 endpoint options which are listed below: +The Language component is configured using the URI syntax with the following path and query parameters: + + language:languageName:resourceUri + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| languageName | | String | *Required* Sets the name of the language to use +| resourceUri | | String | Path to the resource or a reference to lookup a bean in the Registry to use as the resource +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| languageName | producer | | String | *Required* Sets the name of the language to use -| resourceUri | producer | | String | Path to the resource or a reference to lookup a bean in the Registry to use as the resource | binary | producer | false | boolean | Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String) | cacheScript | producer | false | boolean | Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel org.apache.camel.Exchange to the next org.apache.camel.Exchange. | contentCache | producer | false | boolean | Sets whether to use resource content cache or not. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 d7ec4c6..079465a 100644 --- a/camel-core/src/main/docs/log-component.adoc +++ b/camel-core/src/main/docs/log-component.adoc @@ -74,13 +74,26 @@ The Log component supports 2 options which are listed below. // endpoint options: START -The Log component supports 26 endpoint options which are listed below: +The Log component is configured using the URI syntax with the following path and query parameters: + + log:loggerName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| loggerName | | String | *Required* The logger name to use +|======================================================================= +{% endraw %} + +#### 25 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| loggerName | producer | | String | *Required* The logger name to use | groupActiveOnly | producer | true | Boolean | If true will hide stats when no new messages have been received for a time interval if false show stats regardless of message traffic. | groupDelay | producer | | Long | Set the initial delay for stats (in millis) | groupInterval | producer | | Long | If specified will group message stats by this time interval (in millis) http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/mock-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/mock-component.adoc b/camel-core/src/main/docs/mock-component.adoc index 47b8e39..109feaf 100644 --- a/camel-core/src/main/docs/mock-component.adoc +++ b/camel-core/src/main/docs/mock-component.adoc @@ -93,13 +93,26 @@ The Mock component has no options. // endpoint options: START -The Mock component supports 11 endpoint options which are listed below: +The Mock component is configured using the URI syntax with the following path and query parameters: + + mock:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of mock endpoint +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | producer | | String | *Required* Name of mock endpoint | assertPeriod | producer | 0 | long | Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used for example to assert that exactly a number of messages arrives. For example if link expectedMessageCount(int) was set to 5 then the assertion is satisfied when 5 or more message arrives. To ensure that exactly 5 messages arrives then you would need to wait a little period to ensure no further message arrives. This is what you can use this link setAssertPeriod(long) method for. By default this period is disabled. | expectedCount | producer | 1 | int | Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages then take extra care as 0 matches when the tests starts so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use link setAssertPeriod(long). An alternative is to use NotifyBuilder and use the notifier to know when Camel is done routing some messages before you call the link assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period to speedup testing times. If you want to assert that exactly n'th message arrives to this mock endpoint then see also the link setAssertPeriod(long) method for further details. | reportGroup | producer | | int | A number that is used to turn on throughput logging based on groups of the size. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 3798534..84ba4cb 100644 --- a/camel-core/src/main/docs/properties-component.adoc +++ b/camel-core/src/main/docs/properties-component.adoc @@ -45,13 +45,26 @@ The Properties component supports 17 options which are listed below. // endpoint options: START -The Properties component supports 7 endpoint options which are listed below: +The Properties component is configured using the URI syntax with the following path and query parameters: + + properties:key + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| key | | String | *Required* Property key to use as placeholder +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| key | common | | String | *Required* Property key to use as placeholder | ignoreMissingLocation | common | false | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found. | locations | common | | 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. | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/ref-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/ref-component.adoc b/camel-core/src/main/docs/ref-component.adoc index 06578c7..7b39040 100644 --- a/camel-core/src/main/docs/ref-component.adoc +++ b/camel-core/src/main/docs/ref-component.adoc @@ -25,13 +25,26 @@ The Ref component has no options. // endpoint options: START -The Ref component supports 5 endpoint options which are listed below: +The Ref component is configured using the URI syntax with the following path and query parameters: + + ref:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of endpoint to lookup in the registry. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of endpoint to lookup in the registry. | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/rest-api-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/rest-api-component.adoc b/camel-core/src/main/docs/rest-api-component.adoc index d5b0264..1aa2651 100644 --- a/camel-core/src/main/docs/rest-api-component.adoc +++ b/camel-core/src/main/docs/rest-api-component.adoc @@ -471,14 +471,27 @@ The REST API component has no options. // endpoint options: START -The REST API component supports 8 endpoint options which are listed below: +The REST API component is configured using the URI syntax with the following path and query parameters: + + rest-api:path/contextIdPattern + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| path | | String | *Required* The base path +| contextIdPattern | | String | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| path | consumer | | String | *Required* The base path -| contextIdPattern | consumer | | String | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. | apiComponentName | consumer | | String | The Camel Rest API component to use for generating the API of the REST services such as swagger. | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | componentName | consumer | | 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 is registered in the registry. If either one is found then that is being used. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 5cf0a63..db84922 100644 --- a/camel-core/src/main/docs/rest-component.adoc +++ b/camel-core/src/main/docs/rest-component.adoc @@ -35,15 +35,28 @@ The REST component supports 4 options which are listed below. // component options: END // endpoint options: START -The REST component supports 17 endpoint options which are listed below: +The REST component is configured using the URI syntax with the following path and query parameters: + + rest:method:path:uriTemplate + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| method | | String | *Required* HTTP method to use. +| path | | String | *Required* The base path +| uriTemplate | | String | The uri template +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| method | common | | String | *Required* HTTP method to use. -| path | common | | String | *Required* The base path -| uriTemplate | common | | String | The uri template | componentName | common | | 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 is registered in the registry. If either one is found then that is being used. | consumes | common | | String | Media type such as: 'text/xml' or 'application/json' this REST service accepts. By default we accept all kinds of types. | inType | common | | String | To declare the incoming POJO binding type as a FQN class name http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 f34a65b..0d4c5c5 100644 --- a/camel-core/src/main/docs/scheduler-component.adoc +++ b/camel-core/src/main/docs/scheduler-component.adoc @@ -47,13 +47,26 @@ The Scheduler component supports 2 options which are listed below. // endpoint options: START -The Scheduler component supports 21 endpoint options which are listed below: +The Scheduler component is configured using the URI syntax with the following path and query parameters: + + scheduler:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* The name of the scheduler +|======================================================================= +{% endraw %} + +#### 20 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | consumer | | String | *Required* The name of the scheduler | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 12c47a2..718d68a 100644 --- a/camel-core/src/main/docs/seda-component.adoc +++ b/camel-core/src/main/docs/seda-component.adoc @@ -56,13 +56,26 @@ The SEDA component supports 4 options which are listed below. // endpoint options: START -The SEDA component supports 17 endpoint options which are listed below: +The SEDA component is configured using the URI syntax with the following path and query parameters: + + seda:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of queue +|======================================================================= +{% endraw %} + +#### 16 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of queue | size | common | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 fa7b190..e9eb053 100644 --- a/camel-core/src/main/docs/stub-component.adoc +++ b/camel-core/src/main/docs/stub-component.adoc @@ -46,13 +46,26 @@ The Stub component supports 4 options which are listed below. // endpoint options: START -The Stub component supports 17 endpoint options which are listed below: +The Stub component is configured using the URI syntax with the following path and query parameters: + + stub:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of queue +|======================================================================= +{% endraw %} + +#### 16 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of queue | size | common | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/test-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/test-component.adoc b/camel-core/src/main/docs/test-component.adoc index de3a5f1..fa96ff3 100644 --- a/camel-core/src/main/docs/test-component.adoc +++ b/camel-core/src/main/docs/test-component.adoc @@ -58,13 +58,26 @@ The Test component has no options. // endpoint options: START -The Test component supports 15 endpoint options which are listed below: +The Test component is configured using the URI syntax with the following path and query parameters: + + test:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of endpoint to lookup in the registry to use for polling messages used for testing +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | producer | | String | *Required* Name of endpoint to lookup in the registry to use for polling messages used for testing | anyOrder | producer | false | boolean | Whether the expected messages should arrive in the same order or can be in any order. | assertPeriod | producer | 0 | long | Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used for example to assert that exactly a number of messages arrives. For example if link expectedMessageCount(int) was set to 5 then the assertion is satisfied when 5 or more message arrives. To ensure that exactly 5 messages arrives then you would need to wait a little period to ensure no further message arrives. This is what you can use this link setAssertPeriod(long) method for. By default this period is disabled. | delimiter | producer | | String | The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/camel-core/src/main/docs/timer-component.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/timer-component.adoc b/camel-core/src/main/docs/timer-component.adoc index 455ce9c..ce9d688 100644 --- a/camel-core/src/main/docs/timer-component.adoc +++ b/camel-core/src/main/docs/timer-component.adoc @@ -40,13 +40,26 @@ The Timer component has no options. // endpoint options: START -The Timer component supports 13 endpoint options which are listed below: +The Timer component is configured using the URI syntax with the following path and query parameters: + + timer:timerName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| timerName | | String | *Required* The name of the timer +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| timerName | consumer | | String | *Required* The name of the timer | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | delay | consumer | 1000 | long | The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | fixedRate | consumer | false | boolean | Events take place at approximately regular intervals separated by the specified period. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 eb8750b..2c654f0 100644 --- a/camel-core/src/main/docs/validator-component.adoc +++ b/camel-core/src/main/docs/validator-component.adoc @@ -68,13 +68,26 @@ The Validator component supports 2 options which are listed below. // endpoint options: START -The Validator component supports 12 endpoint options which are listed below: +The Validator component is configured using the URI syntax with the following path and query parameters: + + validator:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* URL to a local resource on the classpathor a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* URL to a local resource on the classpathor a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. | failOnNullBody | producer | true | boolean | Whether to fail if no body exists. | failOnNullHeader | producer | true | boolean | Whether to fail if no header exists when validating against a header. | headerName | producer | | String | To validate against a header instead of the message body. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 bd12801..c8f46b3 100644 --- a/camel-core/src/main/docs/vm-component.adoc +++ b/camel-core/src/main/docs/vm-component.adoc @@ -79,13 +79,26 @@ The VM component supports 4 options which are listed below. // endpoint options: START -The VM component supports 17 endpoint options which are listed below: +The VM component is configured using the URI syntax with the following path and query parameters: + + vm:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name of queue +|======================================================================= +{% endraw %} + +#### 16 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name of queue | size | common | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | concurrentConsumers | consumer | 1 | int | Number of concurrent threads processing exchanges. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 8836cf4..fcd2171 100644 --- a/camel-core/src/main/docs/xslt-component.adoc +++ b/camel-core/src/main/docs/xslt-component.adoc @@ -90,13 +90,26 @@ The XSLT component supports 9 options which are listed below. // endpoint options: START -The XSLT component supports 18 endpoint options which are listed below: +The XSLT component is configured using the URI syntax with the following path and query parameters: + + xslt:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* The name of the template to load from classpath or file system +|======================================================================= +{% endraw %} + +#### 17 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | String | *Required* The name of the template to load from classpath or file system | allowStAX | producer | true | boolean | Whether to allow using StAX as the javax.xml.transform.Source. | contentCache | producer | 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. | deleteOutputFile | producer | false | boolean | If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file then it can be a good idea to delete it after use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 9882633..9dce09b 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 @@ -64,13 +64,26 @@ The AHC Websocket component supports 7 options which are listed below. // endpoint options: START -The AHC Websocket component supports 19 endpoint options which are listed below: +The AHC Websocket component is configured using the URI syntax with the following path and query parameters: + + ahc-ws:httpUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| httpUri | | URI | *Required* The URI to use such as http://hostname:port/path +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpUri | common | | URI | *Required* The URI to use such as http://hostname:port/path | bridgeEndpoint | common | false | boolean | If the option is true then the Exchange.HTTP_URI header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. | bufferSize | common | 4096 | int | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 e436da9..30fb59b 100644 --- a/components/camel-ahc/src/main/docs/ahc-component.adoc +++ b/components/camel-ahc/src/main/docs/ahc-component.adoc @@ -44,13 +44,26 @@ You can append query options to the URI in the following format, // endpoint options: START -The AHC component supports 14 endpoint options which are listed below: +The AHC component is configured using the URI syntax with the following path and query parameters: + + ahc:httpUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| httpUri | | URI | *Required* The URI to use such as http://hostname:port/path +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpUri | producer | | URI | *Required* The URI to use such as http://hostname:port/path | bridgeEndpoint | producer | false | boolean | If the option is true then the Exchange.HTTP_URI header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. | bufferSize | producer | 4096 | int | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | connectionClose | producer | false | boolean | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-amqp/src/main/docs/amqp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc index b94bfeb..c3fe4c0 100644 --- a/components/camel-amqp/src/main/docs/amqp-component.adoc +++ b/components/camel-amqp/src/main/docs/amqp-component.adoc @@ -133,14 +133,27 @@ The AMQP component supports 76 options which are listed below. // endpoint options: START -The AMQP component supports 87 endpoint options which are listed below: +The AMQP component is configured using the URI syntax with the following path and query parameters: + + amqp:destinationType:destinationName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| destinationType | queue | String | The kind of destination to use +| destinationName | | String | *Required* Name of the queue or topic to use as destination +|======================================================================= +{% endraw %} + +#### 85 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| destinationType | common | queue | String | The kind of destination to use -| destinationName | common | | String | *Required* Name of the queue or topic to use as destination | clientId | common | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. | connectionFactory | common | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint. | disableReplyTo | common | false | boolean | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-apns/src/main/docs/apns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index f1586db..911fb19 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -69,13 +69,26 @@ The APNS component supports 2 options which are listed below. // endpoint options: START -The APNS component supports 21 endpoint options which are listed below: +The APNS component is configured using the URI syntax with the following path and query parameters: + + apns:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | Name of the endpoint +|======================================================================= +{% endraw %} + +#### 20 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | Name of the endpoint | tokens | common | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. | bridgeErrorHandler | consumer | false | boolean | 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. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-asterisk/src/main/docs/asterisk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-asterisk/src/main/docs/asterisk-component.adoc b/components/camel-asterisk/src/main/docs/asterisk-component.adoc index 0610669..8edc5e4 100644 --- a/components/camel-asterisk/src/main/docs/asterisk-component.adoc +++ b/components/camel-asterisk/src/main/docs/asterisk-component.adoc @@ -33,13 +33,26 @@ The Asterisk component has no options. // component options: END // endpoint options: START -The Asterisk component supports 9 endpoint options which are listed below: +The Asterisk component is configured using the URI syntax with the following path and query parameters: + + asterisk:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Logical name +|======================================================================= +{% endraw %} + +#### 8 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Logical name | hostname | common | | String | The hostname of the asterix server | password | common | | String | Login password | username | common | | String | Login username http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-atmos/src/main/docs/atmos-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atmos/src/main/docs/atmos-component.adoc b/components/camel-atmos/src/main/docs/atmos-component.adoc index d657a35..659781b 100644 --- a/components/camel-atmos/src/main/docs/atmos-component.adoc +++ b/components/camel-atmos/src/main/docs/atmos-component.adoc @@ -21,14 +21,27 @@ The Atmos component has no options. // endpoint options: START -The Atmos component supports 14 endpoint options which are listed below: +The Atmos component is configured using the URI syntax with the following path and query parameters: + + atmos:name/operation + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | Atmos name +| operation | | AtmosOperation | *Required* Operation to perform +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | Atmos name -| operation | common | | AtmosOperation | *Required* Operation to perform | enableSslValidation | common | false | boolean | Atmos SSL validation | fullTokenId | common | | String | Atmos client fullTokenId | localPath | common | | String | Local path to put files http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc index 54df736..a73788b 100644 --- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc +++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc @@ -58,13 +58,26 @@ The Atmosphere Websocket component supports 8 options which are listed below. // endpoint options: START -The Atmosphere Websocket component supports 38 endpoint options which are listed below: +The Atmosphere Websocket component is configured using the URI syntax with the following path and query parameters: + + atmosphere-websocket:servicePath + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| servicePath | | String | *Required* Name of websocket endpoint +|======================================================================= +{% endraw %} + +#### 37 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| servicePath | common | | String | *Required* Name of websocket endpoint | chunked | common | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca che the response body stream but use the response stream as-is as the message body. | headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
