CAMEL-11786: Regen docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4f4f2e45 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4f4f2e45 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4f4f2e45 Branch: refs/heads/master Commit: 4f4f2e4508d5bfabc38bb91909ec15f841673a1f Parents: 0e575a4 Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Sep 19 10:41:03 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Sep 19 10:41:03 2017 +0200 ---------------------------------------------------------------------- camel-core/readme-eip.adoc | 4 +- camel-core/readme.adoc | 12 +- camel-core/src/main/docs/bean-component.adoc | 30 +- camel-core/src/main/docs/bean-language.adoc | 6 +- camel-core/src/main/docs/binding-component.adoc | 30 +- camel-core/src/main/docs/browse-component.adoc | 28 +- camel-core/src/main/docs/class-component.adoc | 30 +- camel-core/src/main/docs/constant-language.adoc | 6 +- .../src/main/docs/controlbus-component.adoc | 32 +- .../src/main/docs/dataformat-component.adoc | 24 +- camel-core/src/main/docs/dataset-component.adoc | 58 +-- camel-core/src/main/docs/direct-component.adoc | 44 +-- .../src/main/docs/direct-vm-component.adoc | 52 +-- .../main/docs/exchangeProperty-language.adoc | 6 +- camel-core/src/main/docs/file-component.adoc | 180 +++++----- camel-core/src/main/docs/file-language.adoc | 6 +- camel-core/src/main/docs/gzip-dataformat.adoc | 6 +- camel-core/src/main/docs/header-language.adoc | 6 +- .../src/main/docs/language-component.adoc | 34 +- camel-core/src/main/docs/log-component.adoc | 80 +++-- camel-core/src/main/docs/mock-component.adoc | 40 ++- .../src/main/docs/properties-component.adoc | 70 ++-- camel-core/src/main/docs/ref-component.adoc | 28 +- camel-core/src/main/docs/ref-language.adoc | 6 +- .../src/main/docs/rest-api-component.adoc | 34 +- camel-core/src/main/docs/rest-component.adoc | 66 ++-- .../src/main/docs/scheduler-component.adoc | 68 ++-- camel-core/src/main/docs/seda-component.adoc | 64 ++-- .../src/main/docs/serialization-dataformat.adoc | 6 +- camel-core/src/main/docs/simple-language.adoc | 6 +- camel-core/src/main/docs/string-dataformat.adoc | 6 +- camel-core/src/main/docs/stub-component.adoc | 64 ++-- camel-core/src/main/docs/test-component.adoc | 48 +-- camel-core/src/main/docs/timer-component.adoc | 44 +-- camel-core/src/main/docs/tokenize-language.adoc | 6 +- .../src/main/docs/validator-component.adoc | 50 +-- camel-core/src/main/docs/vm-component.adoc | 64 ++-- camel-core/src/main/docs/xpath-language.adoc | 6 +- camel-core/src/main/docs/xslt-component.adoc | 76 ++-- .../src/main/docs/xtokenize-language.adoc | 6 +- camel-core/src/main/docs/zip-dataformat.adoc | 6 +- .../src/main/docs/ahc-ws-component.adoc | 76 ++-- .../camel-ahc/src/main/docs/ahc-component.adoc | 66 ++-- .../src/main/docs/amqp-component.adoc | 360 ++++++++++--------- .../src/main/docs/apns-component.adoc | 68 ++-- .../src/main/docs/asn1-dataformat.adoc | 6 +- .../src/main/docs/asterisk-component.adoc | 36 +- .../src/main/docs/atmos-component.adoc | 46 +-- .../docs/atmosphere-websocket-component.adoc | 114 +++--- .../src/main/docs/atom-component.adoc | 74 ++-- .../src/main/docs/atomix-map-component.adoc | 70 ++-- .../main/docs/atomix-messaging-component.adoc | 72 ++-- .../main/docs/atomix-multimap-component.adoc | 70 ++-- .../src/main/docs/atomix-queue-component.adoc | 66 ++-- .../src/main/docs/atomix-set-component.adoc | 68 ++-- .../src/main/docs/atomix-value-component.adoc | 68 ++-- .../src/main/docs/avro-component.adoc | 54 +-- .../src/main/docs/avro-dataformat.adoc | 6 +- .../src/main/docs/aws-cw-component.adoc | 44 +-- .../src/main/docs/aws-ddb-component.adoc | 48 +-- .../src/main/docs/aws-ddbstream-component.adoc | 66 ++-- .../src/main/docs/aws-ec2-component.adoc | 38 +- .../src/main/docs/aws-kinesis-component.adoc | 68 ++-- .../docs/aws-kinesis-firehose-component.adoc | 24 +- .../src/main/docs/aws-s3-component.adoc | 106 +++--- .../src/main/docs/aws-sdb-component.adoc | 42 +-- .../src/main/docs/aws-ses-component.adoc | 44 +-- .../src/main/docs/aws-sns-component.adoc | 44 +-- .../src/main/docs/aws-sqs-component.adoc | 110 +++--- .../src/main/docs/aws-swf-component.adoc | 78 ++-- .../src/main/docs/azure-blob-component.adoc | 58 +-- .../src/main/docs/azure-queue-component.adoc | 40 ++- .../src/main/docs/barcode-dataformat.adoc | 6 +- .../src/main/docs/base64-dataformat.adoc | 6 +- .../src/main/docs/bean-validator-component.adoc | 32 +- .../src/main/docs/beanio-dataformat.adoc | 6 +- .../src/main/docs/beanstalk-component.adoc | 80 +++-- .../src/main/docs/bindy-dataformat.adoc | 6 +- .../src/main/docs/bonita-component.adoc | 38 +- .../src/main/docs/boon-dataformat.adoc | 6 +- .../src/main/docs/box-component.adoc | 70 ++-- .../src/main/docs/braintree-component.adoc | 56 +-- .../src/main/docs/cache-component.adoc | 70 ++-- .../src/main/docs/caffeine-cache-component.adoc | 66 ++-- .../main/docs/caffeine-loadcache-component.adoc | 66 ++-- .../src/main/docs/cql-component.adoc | 84 ++--- .../src/main/docs/castor-dataformat.adoc | 6 +- .../main/docs/chronicle-engine-component.adoc | 46 +-- .../src/main/docs/chunk-component.adoc | 34 +- .../src/main/docs/cm-sms-component.adoc | 30 +- .../src/main/docs/cmis-component.adoc | 54 +-- .../src/main/docs/coap-component.adoc | 30 +- .../src/main/docs/cometd-component.adoc | 76 ++-- .../src/main/docs/consul-component.adoc | 50 +-- .../src/main/docs/context-component.adoc | 30 +- .../src/main/docs/couchbase-component.adoc | 118 +++--- .../src/main/docs/couchdb-component.adoc | 50 +-- .../src/main/docs/crypto-cms-component.adoc | 62 ++-- .../src/main/docs/crypto-component.adoc | 68 ++-- .../src/main/docs/crypto-dataformat.adoc | 6 +- .../src/main/docs/pgp-dataformat.adoc | 6 +- .../camel-csv/src/main/docs/csv-dataformat.adoc | 6 +- .../camel-cxf/src/main/docs/cxf-component.adoc | 102 +++--- .../src/main/docs/cxfrs-component.adoc | 90 ++--- .../src/main/docs/digitalocean-component.adoc | 42 +-- .../src/main/docs/disruptor-component.adoc | 64 ++-- .../camel-dns/src/main/docs/dns-component.adoc | 22 +- .../src/main/docs/docker-component.adoc | 68 ++-- .../src/main/docs/dozer-component.adoc | 34 +- .../src/main/docs/drill-component.adoc | 30 +- .../src/main/docs/dropbox-component.adoc | 44 +-- .../src/main/docs/ehcache-component.adoc | 72 ++-- .../camel-ejb/src/main/docs/ejb-component.adoc | 40 ++- .../src/main/docs/elasticsearch-component.adoc | 50 +-- .../src/main/docs/elasticsearch5-component.adoc | 60 ++-- .../src/main/docs/elsql-component.adoc | 130 +++---- .../src/main/docs/etcd-component.adoc | 98 ++--- .../src/main/docs/eventadmin-component.adoc | 38 +- .../src/main/docs/exec-component.adoc | 36 +- .../src/main/docs/facebook-component.adoc | 232 ++++++------ .../src/main/docs/json-fastjson-dataformat.adoc | 6 +- .../src/main/docs/flatpack-component.adoc | 72 ++-- .../src/main/docs/flatpack-dataformat.adoc | 6 +- .../src/main/docs/flink-component.adoc | 46 +-- .../camel-fop/src/main/docs/fop-component.adoc | 26 +- .../src/main/docs/freemarker-component.adoc | 38 +- .../camel-ftp/src/main/docs/ftp-component.adoc | 228 ++++++------ .../camel-ftp/src/main/docs/ftps-component.adoc | 252 ++++++------- .../camel-ftp/src/main/docs/sftp-component.adoc | 242 ++++++------- .../src/main/docs/ganglia-component.adoc | 56 +-- .../src/main/docs/geocoder-component.adoc | 50 +-- .../camel-git/src/main/docs/git-component.adoc | 46 +-- .../src/main/docs/github-component.adoc | 46 +-- .../main/docs/google-bigquery-component.adoc | 45 ++- .../main/docs/google-calendar-component.adoc | 60 ++-- .../src/main/docs/google-drive-component.adoc | 56 +-- .../src/main/docs/google-mail-component.adoc | 54 +-- .../src/main/docs/google-pubsub-component.adoc | 48 +-- .../src/main/docs/gora-component.adoc | 62 ++-- .../src/main/docs/grape-component.adoc | 24 +- .../src/main/docs/groovy-language.adoc | 6 +- .../src/main/docs/grpc-component.adoc | 73 ++-- .../src/main/docs/json-gson-dataformat.adoc | 6 +- .../src/main/docs/guava-eventbus-component.adoc | 42 +-- .../docs/hazelcast-atomicvalue-component.adoc | 50 +-- .../main/docs/hazelcast-instance-component.adoc | 62 ++-- .../src/main/docs/hazelcast-list-component.adoc | 62 ++-- .../src/main/docs/hazelcast-map-component.adoc | 62 ++-- .../main/docs/hazelcast-multimap-component.adoc | 62 ++-- .../main/docs/hazelcast-queue-component.adoc | 62 ++-- .../docs/hazelcast-replicatedmap-component.adoc | 63 ++-- .../docs/hazelcast-ringbuffer-component.adoc | 50 +-- .../src/main/docs/hazelcast-seda-component.adoc | 62 ++-- .../src/main/docs/hazelcast-set-component.adoc | 62 ++-- .../main/docs/hazelcast-topic-component.adoc | 62 ++-- .../src/main/docs/hbase-component.adoc | 62 ++-- .../src/main/docs/hdfs-component.adoc | 108 +++--- .../src/main/docs/hdfs2-component.adoc | 108 +++--- .../src/main/docs/hessian-dataformat.adoc | 8 +- .../src/main/docs/hipchat-component.adoc | 66 ++-- .../camel-hl7/src/main/docs/hl7-dataformat.adoc | 6 +- .../src/main/docs/terser-language.adoc | 6 +- .../src/main/docs/http-component.adoc | 116 +++--- .../src/main/docs/http4-component.adoc | 150 ++++---- .../src/main/docs/ibatis-component.adoc | 86 ++--- .../src/main/docs/ical-dataformat.adoc | 6 +- .../main/docs/iec60870-client-component.adoc | 64 ++-- .../main/docs/iec60870-server-component.adoc | 66 ++-- .../src/main/docs/ignite-cache-component.adoc | 65 ++-- .../src/main/docs/ignite-compute-component.adoc | 49 +-- .../src/main/docs/ignite-events-component.adoc | 48 +-- .../src/main/docs/ignite-idgen-component.adoc | 44 +-- .../main/docs/ignite-messaging-component.adoc | 50 +-- .../src/main/docs/ignite-queue-component.adoc | 47 +-- .../src/main/docs/ignite-set-component.adoc | 43 +-- .../src/main/docs/infinispan-component.adoc | 66 ++-- .../src/main/docs/influxdb-component.adoc | 32 +- .../camel-irc/src/main/docs/irc-component.adoc | 78 ++-- .../src/main/docs/ironmq-component.adoc | 80 +++-- .../src/main/docs/json-jackson-dataformat.adoc | 6 +- .../src/main/docs/jacksonxml-dataformat.adoc | 6 +- .../src/main/docs/javaspace-component.adoc | 40 ++- .../src/main/docs/jaxb-dataformat.adoc | 6 +- .../src/main/docs/jbpm-component.adoc | 70 ++-- .../src/main/docs/jcache-component.adoc | 78 ++-- .../src/main/docs/jclouds-component.adoc | 62 ++-- .../camel-jcr/src/main/docs/jcr-component.adoc | 50 +-- .../src/main/docs/jdbc-component.adoc | 54 +-- .../src/main/docs/jetty-component.adoc | 198 +++++----- .../src/main/docs/jgroups-component.adoc | 44 +-- .../src/main/docs/jibx-dataformat.adoc | 6 +- .../src/main/docs/jing-component.adoc | 24 +- .../src/main/docs/jira-component.adoc | 38 +- .../camel-jms/src/main/docs/jms-component.adoc | 360 ++++++++++--------- .../camel-jmx/src/main/docs/jmx-component.adoc | 78 ++-- .../src/main/docs/json-johnzon-dataformat.adoc | 6 +- .../src/main/docs/jolt-component.adoc | 38 +- .../camel-josql/src/main/docs/sql-language.adoc | 8 +- .../camel-jpa/src/main/docs/jpa-component.adoc | 118 +++--- .../camel-jsch/src/main/docs/scp-component.adoc | 70 ++-- .../src/main/docs/jsonpath-language.adoc | 6 +- .../src/main/docs/jt400-component.adoc | 94 ++--- .../camel-juel/src/main/docs/el-language.adoc | 8 +- .../src/main/docs/jxpath-language.adoc | 8 +- .../src/main/docs/kafka-component.adoc | 208 +++++------ .../src/main/docs/kestrel-component.adoc | 42 +-- .../src/main/docs/krati-component.adoc | 80 +++-- .../kubernetes-build-configs-component.adoc | 58 +-- .../main/docs/kubernetes-builds-component.adoc | 59 +-- .../src/main/docs/kubernetes-component.adoc | 76 ++-- .../docs/kubernetes-config-maps-component.adoc | 58 +-- .../docs/kubernetes-deployments-component.adoc | 74 ++-- .../docs/kubernetes-namespaces-component.adoc | 74 ++-- .../main/docs/kubernetes-nodes-component.adoc | 74 ++-- ...tes-persistent-volumes-claims-component.adoc | 58 +-- ...kubernetes-persistent-volumes-component.adoc | 58 +-- .../main/docs/kubernetes-pods-component.adoc | 74 ++-- ...netes-replication-controllers-component.adoc | 74 ++-- .../kubernetes-resources-quota-component.adoc | 58 +-- .../main/docs/kubernetes-secrets-component.adoc | 58 +-- .../kubernetes-service-accounts-component.adoc | 58 +-- .../docs/kubernetes-services-component.adoc | 74 ++-- .../src/main/docs/ldap-component.adoc | 30 +- .../src/main/docs/linkedin-component.adoc | 58 +-- .../src/main/docs/lucene-component.adoc | 40 ++- .../src/main/docs/lumberjack-component.adoc | 42 +-- .../camel-lzf/src/main/docs/lzf-dataformat.adoc | 6 +- .../src/main/docs/mail-component.adoc | 156 ++++---- .../main/docs/mime-multipart-dataformat.adoc | 6 +- .../src/main/docs/metrics-component.adoc | 44 +-- .../src/main/docs/milo-client-component.adoc | 82 ++--- .../src/main/docs/milo-server-component.adoc | 72 ++-- .../src/main/docs/mina-component.adoc | 74 ++-- .../src/main/docs/mina2-component.adoc | 88 ++--- .../src/main/docs/mllp-component.adoc | 66 ++-- .../src/main/docs/mongodb-gridfs-component.adoc | 54 +-- .../src/main/docs/mongodb-component.adoc | 66 ++-- .../src/main/docs/mongodb3-component.adoc | 58 +-- .../src/main/docs/mqtt-component.adoc | 110 +++--- .../camel-msv/src/main/docs/msv-component.adoc | 52 +-- .../src/main/docs/mustache-component.adoc | 38 +- .../src/main/docs/mvel-component.adoc | 26 +- .../camel-mvel/src/main/docs/mvel-language.adoc | 6 +- .../src/main/docs/mybatis-component.adoc | 88 ++--- .../src/main/docs/nagios-component.adoc | 44 +-- .../src/main/docs/nats-component.adoc | 72 ++-- .../src/main/docs/netty-http-component.adoc | 200 ++++++----- .../src/main/docs/netty-component.adoc | 170 ++++----- .../src/main/docs/netty4-http-component.adoc | 204 +++++------ .../src/main/docs/netty4-component.adoc | 180 +++++----- .../camel-ognl/src/main/docs/ognl-language.adoc | 6 +- .../src/main/docs/olingo2-component.adoc | 60 ++-- .../src/main/docs/olingo4-component.adoc | 60 ++-- .../src/main/docs/openshift-component.adoc | 86 ++--- .../main/docs/openstack-cinder-component.adoc | 38 +- .../main/docs/openstack-glance-component.adoc | 36 +- .../main/docs/openstack-keystone-component.adoc | 36 +- .../main/docs/openstack-neutron-component.adoc | 38 +- .../src/main/docs/openstack-nova-component.adoc | 38 +- .../main/docs/openstack-swift-component.adoc | 38 +- .../src/main/docs/optaplanner-component.adoc | 34 +- .../src/main/docs/paho-component.adoc | 60 ++-- .../src/main/docs/paxlogging-component.adoc | 36 +- .../camel-pdf/src/main/docs/pdf-component.adoc | 38 +- .../src/main/docs/pgevent-component.adoc | 40 ++- .../src/main/docs/lpr-component.adoc | 46 +-- .../src/main/docs/protobuf-dataformat.adoc | 6 +- .../src/main/docs/pubnub-component.adoc | 48 +-- .../src/main/docs/quartz-component.adoc | 68 ++-- .../src/main/docs/quartz2-component.adoc | 86 ++--- .../src/main/docs/quickfix-component.adoc | 48 +-- .../src/main/docs/rabbitmq-component.adoc | 140 ++++---- .../main/docs/reactive-streams-component.adoc | 52 +-- .../src/main/docs/rest-swagger-component.adoc | 52 +-- .../src/main/docs/restlet-component.adoc | 110 +++--- .../camel-rmi/src/main/docs/rmi-component.adoc | 36 +- .../src/main/docs/routebox-component.adoc | 54 +-- .../camel-rss/src/main/docs/rss-component.adoc | 74 ++-- .../camel-rss/src/main/docs/rss-dataformat.adoc | 6 +- .../src/main/docs/salesforce-component.adoc | 168 ++++----- .../src/main/docs/sap-netweaver-component.adoc | 32 +- .../src/main/docs/xquery-component.adoc | 94 ++--- .../src/main/docs/xquery-language.adoc | 6 +- .../src/main/docs/schematron-component.adoc | 28 +- .../src/main/docs/javaScript-language.adoc | 6 +- .../src/main/docs/php-language.adoc | 8 +- .../src/main/docs/python-language.adoc | 8 +- .../src/main/docs/ruby-language.adoc | 8 +- .../src/main/docs/servicenow-component.adoc | 132 +++---- .../src/main/docs/servlet-component.adoc | 82 ++--- .../camel-sip/src/main/docs/sip-component.adoc | 108 +++--- .../src/main/docs/sjms-batch-component.adoc | 80 +++-- .../src/main/docs/sjms-component.adoc | 124 +++---- .../src/main/docs/sjms2-component.adoc | 130 +++---- .../src/main/docs/slack-component.adoc | 38 +- .../src/main/docs/smpp-component.adoc | 106 +++--- .../main/docs/yaml-snakeyaml-dataformat.adoc | 6 +- .../src/main/docs/snmp-component.adoc | 90 ++--- .../src/main/docs/soapjaxb-dataformat.adoc | 6 +- .../src/main/docs/solr-component.adoc | 46 +-- .../src/main/docs/spark-rest-component.adoc | 72 ++-- .../src/main/docs/spark-component.adoc | 42 +-- .../src/main/docs/splunk-component.adoc | 112 +++--- .../src/main/docs/spring-batch-component.adoc | 38 +- .../main/docs/spring-integration-component.adoc | 34 +- .../src/main/docs/spring-ldap-component.adoc | 26 +- .../src/main/docs/spring-redis-component.adoc | 42 +-- .../src/main/docs/spring-ws-component.adoc | 76 ++-- .../src/main/docs/spel-language.adoc | 6 +- .../src/main/docs/spring-event-component.adoc | 28 +- .../camel-sql/src/main/docs/sql-component.adoc | 120 ++++--- .../src/main/docs/sql-stored-component.adoc | 42 +-- .../camel-ssh/src/main/docs/ssh-component.adoc | 106 +++--- .../src/main/docs/stax-component.adoc | 22 +- .../src/main/docs/stomp-component.adoc | 60 ++-- .../src/main/docs/stream-component.adoc | 56 +-- .../main/docs/string-template-component.adoc | 28 +- .../src/main/docs/syslog-dataformat.adoc | 6 +- .../src/main/docs/tidyMarkup-dataformat.adoc | 6 +- .../src/main/docs/tarfile-dataformat.adoc | 6 +- .../src/main/docs/telegram-component.adoc | 74 ++-- .../src/main/docs/thrift-component.adoc | 39 +- .../src/main/docs/thrift-dataformat.adoc | 6 +- .../src/main/docs/tika-component.adoc | 30 +- .../src/main/docs/twilio-component.adoc | 49 +-- .../src/main/docs/twitter-component.adoc | 128 +++---- .../docs/twitter-directmessage-component.adoc | 124 +++---- .../src/main/docs/twitter-search-component.adoc | 124 +++---- .../main/docs/twitter-streaming-component.adoc | 126 +++---- .../main/docs/twitter-timeline-component.adoc | 127 +++---- .../src/main/docs/undertow-component.adoc | 68 ++-- .../src/main/docs/univocity-csv-dataformat.adoc | 6 +- .../main/docs/univocity-fixed-dataformat.adoc | 6 +- .../src/main/docs/univocity-tsv-dataformat.adoc | 6 +- .../src/main/docs/velocity-component.adoc | 38 +- .../src/main/docs/vertx-component.adoc | 48 +-- .../src/main/docs/weather-component.adoc | 106 +++--- .../src/main/docs/websocket-component.adoc | 92 ++--- .../src/main/docs/xmlBeans-dataformat.adoc | 6 +- .../src/main/docs/xmljson-dataformat.adoc | 6 +- .../src/main/docs/xmlrpc-component.adoc | 56 +-- .../src/main/docs/xmlrpc-dataformat.adoc | 6 +- .../src/main/docs/secureXML-dataformat.adoc | 6 +- .../src/main/docs/xmlsecurity-component.adoc | 102 +++--- .../src/main/docs/xmpp-component.adoc | 60 ++-- .../src/main/docs/json-xstream-dataformat.adoc | 6 +- .../src/main/docs/xstream-dataformat.adoc | 6 +- .../src/main/docs/yammer-component.adoc | 90 ++--- .../src/main/docs/zendesk-component.adoc | 51 +-- .../src/main/docs/zipfile-dataformat.adoc | 6 +- .../main/docs/zookeeper-master-component.adoc | 48 +-- .../src/main/docs/zookeeper-component.adoc | 54 +-- components/readme.adoc | 16 +- 353 files changed, 10338 insertions(+), 9792 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/camel-core/readme-eip.adoc ---------------------------------------------------------------------- diff --git a/camel-core/readme-eip.adoc b/camel-core/readme-eip.adoc index 85ab11e..40290bf 100644 --- a/camel-core/readme-eip.adoc +++ b/camel-core/readme-eip.adoc @@ -7,7 +7,7 @@ Camel supports most of the link:http://www.eaipatterns.com/toc.html[Enterprise I Number of EIPs: 62 (2 deprecated) [width="100%",cols="4,6",options="header"] -|======================================================================= +|=== | EIP | Description | link:src/main/docs/eips/aggregate-eip.adoc[Aggregate] + @@ -196,5 +196,5 @@ Number of EIPs: 62 (2 deprecated) | link:src/main/docs/eips/wireTap-eip.adoc[Wire Tap] + `<wireTap>` | Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message. -|======================================================================= +|=== // eips: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/camel-core/readme.adoc ---------------------------------------------------------------------- diff --git a/camel-core/readme.adoc b/camel-core/readme.adoc index 3fbb300..22f95ec 100644 --- a/camel-core/readme.adoc +++ b/camel-core/readme.adoc @@ -9,7 +9,7 @@ Components Number of Components: 25 in 1 JAR artifacts (1 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Component | Available From | Description | link:src/main/docs/bean-component.adoc[Bean] (camel-core) + @@ -87,7 +87,7 @@ Number of Components: 25 in 1 JAR artifacts (1 deprecated) | link:src/main/docs/xslt-component.adoc[XSLT] (camel-core) + `xslt:resourceUri` | 1.3 | Transforms the message using a XSLT template. -|======================================================================= +|=== // components: END @@ -106,7 +106,7 @@ Data Formats Number of Data Formats: 4 in 39 JAR artifacts (0 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Data Format | Available From | Description | link:src/main/docs/gzip-dataformat.adoc[GZip] (camel-core) | 2.0 | GZip compression data format @@ -116,7 +116,7 @@ Number of Data Formats: 4 in 39 JAR artifacts (0 deprecated) | link:src/main/docs/string-dataformat.adoc[String Encoding] (camel-core) | 2.12 | String (text based) data format | link:src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip compression data format (not for zip files) -|======================================================================= +|=== // dataformats: END @@ -136,7 +136,7 @@ Expression Languages Number of Languages: 10 in 1 JAR artifacts (0 deprecated) [width="100%",cols="4,1,5",options="header"] -|======================================================================= +|=== | Language | Available From | Description | link:src/main/docs/bean-language.adoc[Bean method] (camel-core) | 1.3 | For expressions and predicates using a java bean (aka method call) @@ -158,7 +158,7 @@ Number of Languages: 10 in 1 JAR artifacts (0 deprecated) | link:src/main/docs/xtokenize-language.adoc[XML Tokenize] (camel-core) | 2.14 | For expressions and predicates using a body or header XML tokenizer | link:src/main/docs/xpath-language.adoc[XPath] (camel-core) | 1.1 | For XPath expressions and predicates -|======================================================================= +|=== // languages: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 8b97f90..cafda99 100644 --- a/camel-core/src/main/docs/bean-component.adoc +++ b/camel-core/src/main/docs/bean-component.adoc @@ -1,4 +1,4 @@ -## Bean Component +== Bean Component *Available as of Camel version 1.0* @@ -26,29 +26,31 @@ The Bean component has no options. // endpoint options: START The Bean endpoint is configured using URI syntax: - bean:beanName +---- +bean:beanName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **beanName** | *Required* Sets the name of the bean to invoke | | String -|======================================================================= +| *beanName* | *Required* Sets the name of the bean to invoke | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **method** (producer) | Sets the name of the method to invoke on the bean | | String -| **cache** (advanced) | 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. | false | boolean -| **multiParameterArray** (advanced) | *Deprecated* 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. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean -| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *method* (producer) | Sets the name of the method to invoke on the bean | | String +| *cache* (advanced) | 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. | false | boolean +| *multiParameterArray* (advanced) | *Deprecated* 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. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean +| *parameters* (advanced) | Used for configuring additional properties on the bean | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/camel-core/src/main/docs/bean-language.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/bean-language.adoc b/camel-core/src/main/docs/bean-language.adoc index d04f025..b3b4c7f 100644 --- a/camel-core/src/main/docs/bean-language.adoc +++ b/camel-core/src/main/docs/bean-language.adoc @@ -1,4 +1,4 @@ -## Bean method Language +== Bean method Language *Available as of Camel version 1.3* @@ -28,14 +28,14 @@ The Bean method language supports 5 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | bean | | String | *Deprecated* Either a reference or a class name of the bean to use | ref | | String | Reference to bean to lookup in the registry | method | | String | Name of method to call | beanType | | String | Class name of the bean to use | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 02ea78f..15c3e79 100644 --- a/camel-core/src/main/docs/binding-component.adoc +++ b/camel-core/src/main/docs/binding-component.adoc @@ -1,4 +1,4 @@ -## Binding Component (deprecated) +== Binding Component (deprecated) *Available as of Camel version 2.11* @@ -28,29 +28,31 @@ The Binding component has no options. // endpoint options: START The Binding endpoint is configured using URI syntax: - binding:bindingName:delegateUri +---- +binding:bindingName:delegateUri +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bindingName** | *Required* Name of the binding to lookup in the Camel registry. | | String -| **delegateUri** | *Required* Uri of the delegate endpoint. | | String -|======================================================================= +| *bindingName* | *Required* Name of the binding to lookup in the Camel registry. | | String +| *delegateUri* | *Required* Uri of the delegate endpoint. | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 6ab242e..c34ec49 100644 --- a/camel-core/src/main/docs/browse-component.adoc +++ b/camel-core/src/main/docs/browse-component.adoc @@ -1,4 +1,4 @@ -## Browse Component +== Browse Component *Available as of Camel version 1.3* @@ -29,28 +29,30 @@ The Browse component has no options. // endpoint options: START The Browse endpoint is configured using URI syntax: - browse:name +---- +browse:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* A name which can be any string to uniquely identify the endpoint | | String -|======================================================================= +| *name* | *Required* A name which can be any string to uniquely identify the endpoint | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 c52a1dc..4473548 100644 --- a/camel-core/src/main/docs/class-component.adoc +++ b/camel-core/src/main/docs/class-component.adoc @@ -1,4 +1,4 @@ -## Class Component +== Class Component *Available as of Camel version 2.4* @@ -29,29 +29,31 @@ The Class component has no options. // endpoint options: START The Class endpoint is configured using URI syntax: - class:beanName +---- +class:beanName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **beanName** | *Required* Sets the name of the bean to invoke | | String -|======================================================================= +| *beanName* | *Required* Sets the name of the bean to invoke | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **method** (producer) | Sets the name of the method to invoke on the bean | | String -| **cache** (advanced) | 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. | false | boolean -| **multiParameterArray** (advanced) | *Deprecated* 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. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean -| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *method* (producer) | Sets the name of the method to invoke on the bean | | String +| *cache* (advanced) | 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. | false | boolean +| *multiParameterArray* (advanced) | *Deprecated* 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. Deprecation note: This option is used internally by Camel, and is not intended for end users to use. | false | boolean +| *parameters* (advanced) | Used for configuring additional properties on the bean | | Map +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/camel-core/src/main/docs/constant-language.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/constant-language.adoc b/camel-core/src/main/docs/constant-language.adoc index 60d99cd..6c46d51 100644 --- a/camel-core/src/main/docs/constant-language.adoc +++ b/camel-core/src/main/docs/constant-language.adoc @@ -1,4 +1,4 @@ -## Constant Language +== Constant Language *Available as of Camel version 1.5* @@ -14,10 +14,10 @@ The Constant language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 c08e0ea..d6afd98 100644 --- a/camel-core/src/main/docs/controlbus-component.adoc +++ b/camel-core/src/main/docs/controlbus-component.adoc @@ -1,4 +1,4 @@ -## Control Bus Component +== Control Bus Component ### ControlBus *Available as of Camel version 2.11.0* @@ -70,30 +70,32 @@ The Control Bus component has no options. // endpoint options: START The Control Bus endpoint is configured using URI syntax: - controlbus:command:language +---- +controlbus:command:language +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **command** | *Required* Command can be either route or language | | String -| **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. | | Language -|======================================================================= +| *command* | *Required* Command can be either route or language | | String +| *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. | | Language +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **action** (producer) | 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. | | String -| **async** (producer) | 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. | false | boolean -| **loggingLevel** (producer) | Logging level used for logging when task is done or if any exceptions occurred during processing the task. | INFO | LoggingLevel -| **routeId** (producer) | To specify a route by its id. The special keyword current indicates the current route. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *action* (producer) | 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. | | String +| *async* (producer) | 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. | false | boolean +| *loggingLevel* (producer) | Logging level used for logging when task is done or if any exceptions occurred during processing the task. | INFO | LoggingLevel +| *routeId* (producer) | To specify a route by its id. The special keyword current indicates the current route. | | String +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 72c0c2b..d4dca06 100644 --- a/camel-core/src/main/docs/dataformat-component.adoc +++ b/camel-core/src/main/docs/dataformat-component.adoc @@ -1,4 +1,4 @@ -## Data Format Component +== Data Format Component *Available as of Camel version 2.12* @@ -30,26 +30,28 @@ The Data Format component has no options. // endpoint options: START The Data Format endpoint is configured using URI syntax: - dataformat:name:operation +---- +dataformat:name:operation +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* Name of data format | | String -| **operation** | *Required* Operation to use either marshal or unmarshal | | String -|======================================================================= +| *name* | *Required* Name of data format | | String +| *operation* | *Required* Operation to use either marshal or unmarshal | | String +|=== -#### Query Parameters (1 parameters): +==== Query Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 1a9acde..eb9cf78 100644 --- a/camel-core/src/main/docs/dataset-component.adoc +++ b/camel-core/src/main/docs/dataset-component.adoc @@ -1,4 +1,4 @@ -## Dataset Component +== Dataset Component *Available as of Camel version 1.3* @@ -52,43 +52,45 @@ The Dataset component has no options. // endpoint options: START The Dataset endpoint is configured using URI syntax: - dataset:name +---- +dataset:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* Name of DataSet to lookup in the registry | | DataSet -|======================================================================= +| *name* | *Required* Name of DataSet to lookup in the registry | | DataSet +|=== -#### Query Parameters (19 parameters): +==== Query Parameters (19 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **dataSetIndex** (common) | 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 | lenient | String -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean -| **initialDelay** (consumer) | Time period in millis to wait before starting sending messages. | 1000 | long -| **minRate** (consumer) | Wait until the DataSet contains at least this number of messages | 0 | int -| **preloadSize** (consumer) | Sets how many messages should be preloaded (sent) before the route completes its initialization | 0 | long -| **produceDelay** (consumer) | Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing) | 3 | long -| **exceptionHandler** (consumer) | 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. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern -| **assertPeriod** (producer) | 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. | 0 | long -| **consumeDelay** (producer) | Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing) | 0 | long -| **expectedCount** (producer) | 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. | -1 | int -| **reportGroup** (producer) | A number that is used to turn on throughput logging based on groups of the size. | | int -| **resultMinimumWaitTime** (producer) | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long -| **resultWaitTime** (producer) | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long -| **retainFirst** (producer) | Specifies to only retain the first n'th number of received Exchanges. This is used when testing with big data to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation then the link getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges and have configured to only retain the first 10 Exchanges then the link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int -| **retainLast** (producer) | Specifies to only retain the last n'th number of received Exchanges. This is used when testing with big data to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation then the link getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges and have configured to only retain the last 20 Exchanges then the link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int -| **sleepForEmptyTest** (producer) | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero | 0 | long -| **copyOnExchange** (producer) | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. | true | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *dataSetIndex* (common) | 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 | lenient | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean +| *initialDelay* (consumer) | Time period in millis to wait before starting sending messages. | 1000 | long +| *minRate* (consumer) | Wait until the DataSet contains at least this number of messages | 0 | int +| *preloadSize* (consumer) | Sets how many messages should be preloaded (sent) before the route completes its initialization | 0 | long +| *produceDelay* (consumer) | Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing) | 3 | long +| *exceptionHandler* (consumer) | 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. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| *assertPeriod* (producer) | 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. | 0 | long +| *consumeDelay* (producer) | Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing) | 0 | long +| *expectedCount* (producer) | 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. | -1 | int +| *reportGroup* (producer) | A number that is used to turn on throughput logging based on groups of the size. | | int +| *resultMinimumWaitTime* (producer) | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long +| *resultWaitTime* (producer) | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long +| *retainFirst* (producer) | Specifies to only retain the first n'th number of received Exchanges. This is used when testing with big data to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation then the link getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges and have configured to only retain the first 10 Exchanges then the link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int +| *retainLast* (producer) | Specifies to only retain the last n'th number of received Exchanges. This is used when testing with big data to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation then the link getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges and have configured to only retain the last 20 Exchanges then the link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int +| *sleepForEmptyTest* (producer) | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero | 0 | long +| *copyOnExchange* (producer) | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. | true | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 c1a6cda..96b544d 100644 --- a/camel-core/src/main/docs/direct-component.adoc +++ b/camel-core/src/main/docs/direct-component.adoc @@ -1,4 +1,4 @@ -## Direct Component +== Direct Component *Available as of Camel version 1.0* @@ -34,12 +34,12 @@ The Direct component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **block** (producer) | 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. | false | boolean -| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *block* (producer) | 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. | false | boolean +| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -48,31 +48,33 @@ The Direct component supports 3 options which are listed below. // endpoint options: START The Direct endpoint is configured using URI syntax: - direct:name +---- +direct:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* Name of direct endpoint | | String -|======================================================================= +| *name* | *Required* Name of direct endpoint | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern -| **block** (producer) | 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. | false | boolean -| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a DIRECT endpoint with no active consumers. | false | boolean -| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| *block* (producer) | 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. | false | boolean +| *failIfNoConsumers* (producer) | Whether the producer should fail by throwing an exception when sending to a DIRECT endpoint with no active consumers. | false | boolean +| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 b06f8e0..cf3a49e 100644 --- a/camel-core/src/main/docs/direct-vm-component.adoc +++ b/camel-core/src/main/docs/direct-vm-component.adoc @@ -1,4 +1,4 @@ -## Direct VM Component +== Direct VM Component *Available as of Camel version 2.10* @@ -45,14 +45,14 @@ The Direct VM component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **block** (producer) | 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. | false | boolean -| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long -| **headerFilterStrategy** (advanced) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy -| **propagateProperties** (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean -| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean -|======================================================================= +| *block* (producer) | 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. | false | boolean +| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long +| *headerFilterStrategy* (advanced) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy +| *propagateProperties* (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== // component options: END @@ -61,33 +61,35 @@ The Direct VM component supports 5 options which are listed below. // endpoint options: START The Direct VM endpoint is configured using URI syntax: - direct-vm:name +---- +direct-vm:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* Name of direct-vm endpoint | | String -|======================================================================= +| *name* | *Required* Name of direct-vm endpoint | | String +|=== -#### Query Parameters (9 parameters): +==== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean -| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler -| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern -| **block** (producer) | 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. | false | boolean -| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a Direct-VM endpoint with no active consumers. | false | boolean -| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long -| **headerFilterStrategy** (producer) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy -| **propagateProperties** (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| *block* (producer) | 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. | false | boolean +| *failIfNoConsumers* (producer) | Whether the producer should fail by throwing an exception when sending to a Direct-VM endpoint with no active consumers. | false | boolean +| *timeout* (producer) | The timeout value to use if block is enabled. | 30000 | long +| *headerFilterStrategy* (producer) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy +| *propagateProperties* (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/camel-core/src/main/docs/exchangeProperty-language.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/exchangeProperty-language.adoc b/camel-core/src/main/docs/exchangeProperty-language.adoc index 6525749..86130f5 100644 --- a/camel-core/src/main/docs/exchangeProperty-language.adoc +++ b/camel-core/src/main/docs/exchangeProperty-language.adoc @@ -1,4 +1,4 @@ -## ExchangeProperty Language +== ExchangeProperty Language *Available as of Camel version 2.0* @@ -13,10 +13,10 @@ The ExchangeProperty language supports 1 options which are listed below. [width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks -|======================================================================= +|=== // language options: END ### Example usage
