Use single line header for adoc files
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/28429681 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/28429681 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/28429681 Branch: refs/heads/master Commit: 2842968134a3885958c97405629e02fc87d69dc1 Parents: 11dfcc0 Author: Claus Ibsen <davscl...@apache.org> Authored: Wed Jan 11 19:26:34 2017 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Wed Jan 11 19:26:34 2017 +0100 ---------------------------------------------------------------------- camel-core/readme-eip.adoc | 3 - camel-core/src/main/docs/bean-component.adoc | 33 +--- camel-core/src/main/docs/bean-language.adoc | 28 +-- camel-core/src/main/docs/binding-component.adoc | 27 +-- camel-core/src/main/docs/browse-component.adoc | 21 +-- camel-core/src/main/docs/class-component.adoc | 25 +-- camel-core/src/main/docs/constant-language.adoc | 16 +- .../src/main/docs/controlbus-component.adoc | 40 ++--- .../src/main/docs/dataformat-component.adoc | 21 +-- camel-core/src/main/docs/dataset-component.adoc | 57 ++---- camel-core/src/main/docs/direct-component.adoc | 21 +-- .../src/main/docs/direct-vm-component.adoc | 21 +-- .../main/docs/exchangeProperty-language.adoc | 16 +- camel-core/src/main/docs/file-component.adoc | 169 +++++------------- camel-core/src/main/docs/file-language.adoc | 36 ++-- camel-core/src/main/docs/gzip-dataformat.adoc | 20 +-- camel-core/src/main/docs/header-language.adoc | 16 +- .../src/main/docs/language-component.adoc | 29 +-- camel-core/src/main/docs/log-component.adoc | 41 ++--- camel-core/src/main/docs/mock-component.adoc | 60 ++----- .../src/main/docs/properties-component.adoc | 124 ++++--------- camel-core/src/main/docs/ref-component.adoc | 25 +-- camel-core/src/main/docs/ref-language.adoc | 16 +- .../src/main/docs/rest-api-component.adoc | 81 +++------ camel-core/src/main/docs/rest-component.adoc | 37 ++-- .../src/main/docs/scheduler-component.adoc | 37 ++-- camel-core/src/main/docs/seda-component.adoc | 45 ++--- .../src/main/docs/serialization-dataformat.adoc | 12 +- camel-core/src/main/docs/simple-language.adoc | 60 ++----- camel-core/src/main/docs/string-dataformat.adoc | 20 +-- camel-core/src/main/docs/stub-component.adoc | 21 +-- camel-core/src/main/docs/test-component.adoc | 21 +-- camel-core/src/main/docs/timer-component.adoc | 37 ++-- camel-core/src/main/docs/tokenize-language.adoc | 8 +- .../src/main/docs/validator-component.adoc | 25 +-- camel-core/src/main/docs/vm-component.adoc | 21 +-- camel-core/src/main/docs/xpath-language.adoc | 84 +++------ camel-core/src/main/docs/xslt-component.adoc | 53 ++---- .../src/main/docs/xtokenize-language.adoc | 8 +- camel-core/src/main/docs/zip-dataformat.adoc | 20 +-- .../src/main/docs/ahc-ws-component.adoc | 25 +-- .../camel-ahc/src/main/docs/ahc-component.adoc | 77 +++----- .../src/main/docs/amqp-component.adoc | 29 +-- .../src/main/docs/apns-component.adoc | 45 ++--- .../src/main/docs/asterisk-component.adoc | 16 +- .../src/main/docs/atmos-component.adoc | 23 +-- .../docs/atmosphere-websocket-component.adoc | 25 +-- .../src/main/docs/atom-component.adoc | 29 +-- .../src/main/docs/avro-component.adoc | 28 +-- .../src/main/docs/avro-dataformat.adoc | 17 +- .../src/main/docs/aws-cw-component.adoc | 33 +--- .../src/main/docs/aws-ddb-component.adoc | 69 ++------ .../src/main/docs/aws-ddbstream-component.adoc | 53 ++---- .../src/main/docs/aws-ec2-component.adoc | 25 +-- .../src/main/docs/aws-kinesis-component.adoc | 48 ++--- .../src/main/docs/aws-s3-component.adoc | 45 ++--- .../src/main/docs/aws-sdb-component.adoc | 49 ++---- .../src/main/docs/aws-ses-component.adoc | 37 ++-- .../src/main/docs/aws-sns-component.adoc | 37 ++-- .../src/main/docs/aws-sqs-component.adoc | 45 ++--- .../src/main/docs/aws-swf-component.adoc | 48 ++--- .../src/main/docs/barcode-dataformat.adoc | 24 +-- .../src/main/docs/base64-dataformat.adoc | 20 +-- .../src/main/docs/bean-validator-component.adoc | 25 +-- .../src/main/docs/beanio-dataformat.adoc | 24 +-- .../src/main/docs/beanstalk-component.adoc | 29 +-- .../src/main/docs/bindy-dataformat.adoc | 80 +++------ .../src/main/docs/bonita-component.adoc | 24 +-- .../src/main/docs/boon-dataformat.adoc | 20 +-- .../camel-box/src/main/docs/box-component.adoc | 76 +++----- .../src/main/docs/braintree-component.adoc | 96 +++------- .../src/main/docs/cache-component.adoc | 89 +++------- .../src/main/docs/cql-component.adoc | 36 ++-- .../src/main/docs/castor-dataformat.adoc | 20 +-- .../main/docs/chronicle-engine-component.adoc | 5 +- .../src/main/docs/chunk-component.adoc | 33 +--- .../src/main/docs/cm-sms-component.adoc | 12 +- .../src/main/docs/cmis-component.adoc | 33 +--- .../src/main/docs/coap-component.adoc | 10 +- .../src/main/docs/cometd-component.adoc | 33 +--- .../src/main/docs/consul-component.adoc | 16 +- .../src/main/docs/context-component.adoc | 24 +-- .../src/main/docs/couchdb-component.adoc | 24 +-- .../src/main/docs/crypto-component.adoc | 80 +++------ .../src/main/docs/crypto-dataformat.adoc | 33 ++-- .../src/main/docs/pgp-dataformat.adoc | 52 ++---- .../camel-csv/src/main/docs/csv-dataformat.adoc | 43 ++--- .../camel-cxf/src/main/docs/cxf-component.adoc | 89 +++------- .../src/main/docs/cxfrs-component.adoc | 44 ++--- .../src/main/docs/disruptor-component.adoc | 40 ++--- .../camel-dns/src/main/docs/dns-component.adoc | 37 ++-- .../src/main/docs/docker-component.adoc | 24 +-- .../src/main/docs/dozer-component.adoc | 37 ++-- .../src/main/docs/drill-component.adoc | 21 +-- .../src/main/docs/dropbox-component.adoc | 96 +++------- .../src/main/docs/ehcache-component.adoc | 24 +-- .../camel-ejb/src/main/docs/ejb-component.adoc | 33 +--- .../src/main/docs/elasticsearch-component.adoc | 29 +-- .../src/main/docs/elsql-component.adoc | 25 +-- .../src/main/docs/etcd-component.adoc | 6 +- .../src/main/docs/eventadmin-component.adoc | 28 +-- .../src/main/docs/exec-component.adoc | 49 ++---- .../src/main/docs/facebook-component.adoc | 36 ++-- .../src/main/docs/flatpack-component.adoc | 53 ++---- .../src/main/docs/flatpack-dataformat.adoc | 16 +- .../src/main/docs/flink-component.adoc | 25 +-- .../camel-fop/src/main/docs/fop-component.adoc | 29 +-- .../src/main/docs/freemarker-component.adoc | 41 ++--- .../camel-ftp/src/main/docs/ftp-component.adoc | 93 +++------- .../camel-ftp/src/main/docs/ftps-component.adoc | 9 +- .../camel-ftp/src/main/docs/sftp-component.adoc | 8 +- .../src/main/docs/ganglia-component.adoc | 36 ++-- .../src/main/docs/geocoder-component.adoc | 24 +-- .../camel-git/src/main/docs/git-component.adoc | 20 +-- .../src/main/docs/github-component.adoc | 20 +-- .../main/docs/google-calendar-component.adoc | 32 +--- .../src/main/docs/google-drive-component.adoc | 28 +-- .../src/main/docs/google-mail-component.adoc | 32 +--- .../src/main/docs/google-pubsub-component.adoc | 36 ++-- .../src/main/docs/gora-component.adoc | 36 ++-- .../src/main/docs/grape-component.adoc | 49 ++---- .../src/main/docs/groovy-language.adoc | 40 ++--- .../src/main/docs/json-gson-dataformat.adoc | 12 +- .../src/main/docs/guava-eventbus-component.adoc | 24 +-- .../src/main/docs/hazelcast-component.adoc | 148 ++++------------ .../src/main/docs/hbase-component.adoc | 65 ++----- .../src/main/docs/hdfs-component.adoc | 36 ++-- .../src/main/docs/hdfs2-component.adoc | 44 ++--- .../src/main/docs/hessian-dataformat.adoc | 16 +- .../src/main/docs/hipchat-component.adoc | 36 ++-- .../camel-hl7/src/main/docs/hl7-dataformat.adoc | 65 ++----- .../src/main/docs/terser-language.adoc | 13 +- .../src/main/docs/http-component.adoc | 101 +++-------- .../src/main/docs/http4-component.adoc | 96 +++------- .../src/main/docs/ibatis-component.adoc | 41 ++--- .../src/main/docs/ical-dataformat.adoc | 17 +- .../src/main/docs/infinispan-component.adoc | 29 +-- .../src/main/docs/influxdb-component.adoc | 25 +-- .../camel-irc/src/main/docs/irc-component.adoc | 36 ++-- .../src/main/docs/ironmq-component.adoc | 33 ++-- .../src/main/docs/json-jackson-dataformat.adoc | 12 +- .../src/main/docs/jacksonxml-dataformat.adoc | 52 ++---- .../src/main/docs/javaspace-component.adoc | 33 +--- .../src/main/docs/jaxb-dataformat.adoc | 56 ++---- .../src/main/docs/jbpm-component.adoc | 24 +-- .../src/main/docs/jcache-component.adoc | 6 +- .../src/main/docs/jclouds-component.adoc | 56 ++---- .../camel-jcr/src/main/docs/jcr-component.adoc | 25 +-- .../src/main/docs/jdbc-component.adoc | 45 ++--- .../src/main/docs/jetty-component.adoc | 81 +++------ .../src/main/docs/jgroups-component.adoc | 44 ++--- .../src/main/docs/jibx-dataformat.adoc | 16 +- .../src/main/docs/jing-component.adoc | 21 +-- .../src/main/docs/jira-component.adoc | 16 +- .../camel-jms/src/main/docs/jms-component.adoc | 176 +++++-------------- .../camel-jmx/src/main/docs/jmx-component.adoc | 144 ++++----------- .../src/main/docs/json-johnzon-dataformat.adoc | 12 +- .../src/main/docs/jolt-component.adoc | 21 +-- .../camel-josql/src/main/docs/sql-language.adoc | 12 +- .../camel-jpa/src/main/docs/jpa-component.adoc | 57 ++---- .../camel-jsch/src/main/docs/scp-component.adoc | 21 +-- .../src/main/docs/jsonpath-language.adoc | 40 ++--- .../src/main/docs/jt400-component.adoc | 45 ++--- .../camel-juel/src/main/docs/el-language.adoc | 20 +-- .../src/main/docs/jxpath-language.adoc | 36 ++-- .../src/main/docs/kafka-component.adoc | 41 ++--- .../src/main/docs/kestrel-component.adoc | 45 ++--- .../src/main/docs/krati-component.adoc | 40 ++--- .../src/main/docs/kubernetes-component.adoc | 16 +- .../src/main/docs/ldap-component.adoc | 37 ++-- .../src/main/docs/linkedin-component.adoc | 60 ++----- .../src/main/docs/lucene-component.adoc | 48 ++--- .../src/main/docs/lumberjack-component.adoc | 25 +-- .../camel-lzf/src/main/docs/lzf-dataformat.adoc | 20 +-- .../src/main/docs/mail-component.adoc | 87 +++------ .../main/docs/mime-multipart-dataformat.adoc | 24 +-- .../src/main/docs/metrics-component.adoc | 104 +++-------- .../src/main/docs/mina-component.adoc | 49 ++---- .../src/main/docs/mina2-component.adoc | 45 ++--- .../src/main/docs/mllp-component.adoc | 35 +--- .../src/main/docs/gridfs-component.adoc | 49 ++---- .../src/main/docs/mongodb-component.adoc | 128 ++++---------- .../src/main/docs/mongodb3-component.adoc | 124 ++++--------- .../src/main/docs/mqtt-component.adoc | 25 +-- .../camel-msv/src/main/docs/msv-component.adoc | 21 +-- .../src/main/docs/mustache-component.adoc | 33 +--- .../src/main/docs/mvel-component.adoc | 37 ++-- .../camel-mvel/src/main/docs/mvel-language.adoc | 24 +-- .../src/main/docs/mybatis-component.adoc | 61 ++----- .../src/main/docs/nagios-component.adoc | 25 +-- .../src/main/docs/nats-component.adoc | 16 +- .../src/main/docs/netty-http-component.adoc | 53 ++---- .../src/main/docs/netty-component.adoc | 73 ++------ .../src/main/docs/netty4-http-component.adoc | 53 ++---- .../src/main/docs/netty4-component.adoc | 67 ++----- .../camel-ognl/src/main/docs/ognl-language.adoc | 24 +-- .../src/main/docs/olingo2-component.adoc | 37 ++-- .../src/main/docs/openshift-component.adoc | 29 +-- .../main/docs/openstack-cinder-component.adoc | 47 ++--- .../main/docs/openstack-glance-component.adoc | 29 +-- .../main/docs/openstack-keystone-component.adoc | 80 +++------ .../main/docs/openstack-neutron-component.adoc | 69 ++------ .../src/main/docs/openstack-nova-component.adoc | 58 ++---- .../main/docs/openstack-swift-component.adoc | 47 ++--- .../src/main/docs/optaplanner-component.adoc | 33 +--- .../src/main/docs/paho-component.adoc | 29 +-- .../src/main/docs/paxlogging-component.adoc | 24 +-- .../camel-pdf/src/main/docs/pdf-component.adoc | 20 +-- .../src/main/docs/pgevent-component.adoc | 13 +- .../src/main/docs/lpr-component.adoc | 36 ++-- .../src/main/docs/protobuf-dataformat.adoc | 32 +--- .../src/main/docs/quartz-component.adoc | 45 ++--- .../src/main/docs/quartz2-component.adoc | 49 ++---- .../src/main/docs/quickfix-component.adoc | 112 +++--------- .../src/main/docs/rabbitmq-component.adoc | 29 +-- .../src/main/docs/restlet-component.adoc | 49 ++---- .../camel-rmi/src/main/docs/rmi-component.adoc | 21 +-- .../src/main/docs/routebox-component.adoc | 36 ++-- .../camel-rss/src/main/docs/rss-component.adoc | 33 +--- .../camel-rss/src/main/docs/rss-dataformat.adoc | 10 +- .../src/main/docs/salesforce-component.adoc | 68 ++----- .../src/main/docs/sap-netweaver-component.adoc | 29 +-- .../src/main/docs/xquery-component.adoc | 44 ++--- .../src/main/docs/xquery-language.adoc | 44 ++--- .../src/main/docs/schematron-component.adoc | 25 +-- .../src/main/docs/javaScript-language.adoc | 36 ++-- .../src/main/docs/php-language.adoc | 32 +--- .../src/main/docs/python-language.adoc | 36 ++-- .../src/main/docs/ruby-language.adoc | 36 ++-- .../src/main/docs/servicenow-component.adoc | 20 +-- .../src/main/docs/servlet-component.adoc | 49 ++---- .../camel-sip/src/main/docs/sip-component.adoc | 24 +-- .../src/main/docs/sjms-batch-component.adoc | 16 +- .../src/main/docs/sjms-component.adoc | 88 +++------- .../src/main/docs/slack-component.adoc | 25 +-- .../src/main/docs/smpp-component.adoc | 49 ++---- .../main/docs/yaml-snakeyaml-dataformat.adoc | 20 +-- .../src/main/docs/snmp-component.adoc | 29 +-- .../src/main/docs/soapjaxb-dataformat.adoc | 52 ++---- .../src/main/docs/solr-component.adoc | 29 +-- .../src/main/docs/spark-rest-component.adoc | 33 +--- .../src/main/docs/spark-component.adoc | 49 ++---- .../src/main/docs/splunk-component.adoc | 37 ++-- .../src/main/docs/spring-batch-component.adoc | 40 ++--- .../main/docs/spring-integration-component.adoc | 33 +--- .../src/main/docs/spring-ldap-component.adoc | 41 ++--- .../src/main/docs/spring-redis-component.adoc | 29 +-- .../src/main/docs/spring-ws-component.adoc | 65 ++----- .../src/main/docs/spel-language.adoc | 36 ++-- .../src/main/docs/spring-event-component.adoc | 17 +- .../camel-sql/src/main/docs/sql-component.adoc | 60 ++----- .../src/main/docs/sql-stored-component.adoc | 21 +-- .../camel-ssh/src/main/docs/ssh-component.adoc | 29 +-- .../src/main/docs/stax-component.adoc | 29 +-- .../src/main/docs/stomp-component.adoc | 25 +-- .../src/main/docs/stream-component.adoc | 25 +-- .../main/docs/string-template-component.adoc | 37 ++-- .../src/main/docs/syslog-dataformat.adoc | 29 +-- .../src/main/docs/tidyMarkup-dataformat.adoc | 20 +-- .../src/main/docs/tarfile-dataformat.adoc | 24 +-- .../src/main/docs/telegram-component.adoc | 36 ++-- .../src/main/docs/twitter-component.adoc | 68 ++----- .../src/main/docs/undertow-component.adoc | 29 +-- .../src/main/docs/univocity-csv-dataformat.adoc | 41 ++--- .../main/docs/univocity-fixed-dataformat.adoc | 41 ++--- .../src/main/docs/univocity-tsv-dataformat.adoc | 41 ++--- .../src/main/docs/velocity-component.adoc | 41 ++--- .../src/main/docs/vertx-component.adoc | 21 +-- .../src/main/docs/weather-component.adoc | 28 +-- .../src/main/docs/websocket-component.adoc | 33 +--- .../src/main/docs/xmlBeans-dataformat.adoc | 12 +- .../src/main/docs/xmljson-dataformat.adoc | 40 ++--- .../src/main/docs/xmlrpc-component.adoc | 32 +--- .../src/main/docs/xmlrpc-dataformat.adoc | 10 +- .../src/main/docs/secureXML-dataformat.adoc | 56 ++---- .../src/main/docs/xmlsecurity-component.adoc | 48 ++--- .../src/main/docs/xmpp-component.adoc | 25 +-- .../src/main/docs/json-xstream-dataformat.adoc | 24 +-- .../src/main/docs/xstream-dataformat.adoc | 24 +-- .../src/main/docs/yammer-component.adoc | 44 ++--- .../src/main/docs/zipfile-dataformat.adoc | 24 +-- .../src/main/docs/zookeeper-component.adoc | 36 ++-- 282 files changed, 3002 insertions(+), 8010 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/camel-core/readme-eip.adoc ---------------------------------------------------------------------- diff --git a/camel-core/readme-eip.adoc b/camel-core/readme-eip.adoc index 1e7285e..a31e5b1 100644 --- a/camel-core/readme-eip.adoc +++ b/camel-core/readme-eip.adoc @@ -126,9 +126,6 @@ Enterprise Integration Patterns | link:src/main/docs/eips/serviceCall-eip.adoc[Service Call] + `<serviceCall>` | Remote service call definition -| link:src/main/docs/eips/serviceCallConfiguration-eip.adoc[Service Call Configuration] + -`<serviceCallConfiguration>` | Remote service call configuration - | link:src/main/docs/eips/setBody-eip.adoc[Set Body] + `<setBody>` | Sets the contents of the message body http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 b35606b..aef918a 100644 --- a/camel-core/src/main/docs/bean-component.adoc +++ b/camel-core/src/main/docs/bean-component.adoc @@ -1,10 +1,8 @@ -# Bean Component +## Bean Component The *bean:* component binds beans to Camel message exchanges. -[[Bean-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------- @@ -14,9 +12,7 @@ bean:beanID[?options] Where *beanID* can be any string which is used to look up the bean in the link:registry.html[Registry] -[[Bean-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -46,9 +42,7 @@ The Bean component supports 6 endpoint options which are listed below: You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Bean-Using]] -Using -^^^^^ +### Using The object instance that is used to consume messages must be explicitly registered with the link:registry.html[Registry]. For example, if you @@ -82,9 +76,7 @@ And the same route using Spring DSL: </route> ---------------------------- -[[Bean-Beanasendpoint]] -Bean as endpoint -^^^^^^^^^^^^^^^^ +### Bean as endpoint Camel also supports invoking link:bean.html[Bean] as an Endpoint. In the route below: @@ -97,9 +89,7 @@ Camel will use link:bean-binding.html[Bean Binding] to invoke the `sayHello` method, by converting the Exchange's In body to the `String` type and storing the output of the method on the Exchange Out body. -[[Bean-JavaDSLbeansyntax]] -Java DSL bean syntax -^^^^^^^^^^^^^^^^^^^^ +### Java DSL bean syntax Java DSL comes with syntactic sugar for the link:bean.html[Bean] component. Instead of specifying the bean explicitly as the endpoint @@ -131,9 +121,7 @@ from("direct:start").bean(new ExampleBean(), "methodName"); from("direct:start").bean(ExampleBean.class); --------------------------------------------------------------- -[[Bean-BeanBinding]] -Bean Binding -^^^^^^^^^^^^ +### Bean Binding How bean methods to be invoked are chosen (if they are not specified explicitly through the *method* parameter) and how parameter values are @@ -142,9 +130,7 @@ link:bean-binding.html[Bean Binding] mechanism which is used throughout all of the various link:bean-integration.html[Bean Integration] mechanisms in Camel. -[[Bean-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -153,5 +139,4 @@ See Also * link:class.html[Class] component * link:bean-binding.html[Bean Binding] -* link:bean-integration.html[Bean Integration] - +* link:bean-integration.html[Bean Integration] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 5f8d514..f89399a 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 The purpose of the Bean Language is to be able to implement an link:expression.html[Expression] or link:predicate.html[Predicate] using @@ -18,9 +18,7 @@ link:message.html[Message] Exchange to the method parameters; so you can annotate the bean to extract headers or other expressions such as link:xpath.html[XPath] or link:xquery.html[XQuery] from the message. -[[Bean-Options]] -Bean Options -^^^^^^^^^^^^ +### Bean Options // language options: START The Bean method language supports 5 options which are listed below. @@ -41,9 +39,7 @@ The Bean method language supports 5 options which are listed below. // language options: END -[[BeanLanguage-UsingBeanExpressionsfromtheJavaDSL]] -Using Bean Expressions from the Java DSL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using Bean Expressions from the Java DSL [source,java] ---------------------------------------------- @@ -52,9 +48,7 @@ from("activemq:topic:OrdersTopic"). to("activemq:BigSpendersQueue"); ---------------------------------------------- -[[BeanLanguage-UsingBeanExpressionsfromXML]] -Using Bean Expressions from XML -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using Bean Expressions from XML [source,xml] -------------------------------------------------- @@ -72,9 +66,7 @@ Using Bean Expressions from XML Note, the `bean` attribute of the method expression element is now deprecated. You should now make use of `ref` attribute instead. -[[BeanLanguage-Writingtheexpressionbean]] -Writing the expression bean -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Writing the expression bean The bean in the above examples is just any old Java Bean with a method called isGoldCustomer() that returns some object that is easily @@ -110,9 +102,7 @@ So you can bind parameters of the method to the Exchange, the link:message.html[Message] or individual headers, properties, the body or other expressions. -[[BeanLanguage-Nonregistrybeans]] -Non registry beans -^^^^^^^^^^^^^^^^^^ +### Non registry beans The link:bean-language.html[Bean Language] also supports invoking beans that isn't registered in the link:registry.html[Registry]. This is @@ -170,8 +160,6 @@ Which also can be done in a bit shorter and nice way: to("activemq:BigSpendersQueue"); ------------------------------------------------------ -[[BeanLanguage-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies -The Bean language is part of *camel-core*. +The Bean language is part of *camel-core*. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 14533d5..61cc1e2 100644 --- a/camel-core/src/main/docs/binding-component.adoc +++ b/camel-core/src/main/docs/binding-component.adoc @@ -1,7 +1,4 @@ -# Binding Component -[[Binding-Binding]] -Binding -------- +## Binding Component In Camel terms a _binding_ is a way of wrapping an link:endpoint.html[Endpoint] in a contract; such as a @@ -17,9 +14,7 @@ provide a way of wrapping Camel endpoints with contracts inside the Camel framework itself; so you can use them easily inside any Camel route. -[[Binding-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -46,9 +41,7 @@ The Binding component supports 6 endpoint options which are listed below: // endpoint options: END -[[Binding-UsingBindings]] -Using Bindings -~~~~~~~~~~~~~~ +### Using Bindings A Binding is currently a bean which defines the contract (though we'll hopefully add bindings to the Camel DSL). @@ -56,9 +49,7 @@ hopefully add bindings to the Camel DSL). There are a few approaches to defining a bound endpoint (i.e. an endpoint bound with a Binding). -[[Binding-UsingthebindingURI]] -Using the binding URI -^^^^^^^^^^^^^^^^^^^^^ +### Using the binding URI You can prefix any endpoint URI with *binding:nameOfBinding:* where _nameOfBinding_ is the name of the Binding bean in your registry. @@ -72,9 +63,7 @@ Here we are using the "jaxb" binding which may, for example, use the JAXB link:data-format.html[Data Format] to marshal and unmarshal messages. -[[Binding-UsingaBindingComponent]] -Using a BindingComponent -^^^^^^^^^^^^^^^^^^^^^^^^ +### Using a BindingComponent There is a link:component.html[Component] called BindingComponent which can be configured in your link:registry.html[Registry] by dependency @@ -101,9 +90,7 @@ which would be using the queueus "foo.myQueue" and "foo.anotherQueue" and would use the given Jackson link:data-format.html[Data Format] to marshal on and off the queue. -[[Binding-WhentouseBindings]] -When to use Bindings -~~~~~~~~~~~~~~~~~~~~ +### When to use Bindings If you only use an endpoint once in a single route; a binding may actually be more complex and more work than just using the 'raw' @@ -122,4 +109,4 @@ BindingComponent to wrap the endpoints in the binding of your choice. So bindings are a composition tool really; only use them when they make sense - the extra complexity may not be worth it unless you have lots of -routes or endpoints. +routes or endpoints. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 925246f..c26fd95 100644 --- a/camel-core/src/main/docs/browse-component.adoc +++ b/camel-core/src/main/docs/browse-component.adoc @@ -1,13 +1,11 @@ -# Browse Component +## Browse Component The Browse component provides a simple link:browsableendpoint.html[BrowsableEndpoint] which can be useful for testing, visualisation tools or debugging. The exchanges sent to the endpoint are all available to be browsed. -[[Browse-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------- @@ -17,9 +15,7 @@ browse:someName[?options] Where *someName* can be any string to uniquely identify the endpoint. -[[Gora-Options]] -Options -~~~~~~~ +### Options // component options: START @@ -45,9 +41,7 @@ The Browse component supports 5 endpoint options which are listed below: // endpoint options: END -[[Browse-Sample]] -Sample -^^^^^^ +### Sample In the route below, we insert a `browse:` component to be able to browse the Exchanges that are passing through: @@ -75,12 +69,9 @@ We can now inspect the received exchanges from within the Java code: } -------------------------------------------------------------------------------------------------------- -[[Browse-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 5b0a96d..c1a904a 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 2.4* @@ -7,9 +7,7 @@ in the same way as the link:bean.html[Bean] component but instead of looking up beans from a link:registry.html[Registry] it creates the bean based on the class name. -[[Class-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------- @@ -19,9 +17,7 @@ class:className[?options] Where *className* is the fully qualified class name to create and use as bean. -[[Class-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -48,9 +44,7 @@ The Class component supports 6 endpoint options which are listed below: // endpoint options: END -[[Class-Using]] -Using -^^^^^ +### Using You simply use the *class* component just as the link:bean.html[Bean] component but by specifying the fully qualified classname instead. + @@ -69,9 +63,7 @@ example `hello`: from("direct:start").to("class:org.apache.camel.component.bean.MyFooBean?method=hello").to("mock:result"); -------------------------------------------------------------------------------------------------------------- -[[Class-Settingpropertiesonthecreatedinstance]] -Setting properties on the created instance -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Setting properties on the created instance In the endpoint uri you can specify properties to set on the created instance, for example if it has a `setPrefix` method: @@ -112,9 +104,7 @@ id `foo` and invoke the `setCool` method on the created instance of the TIP:See more details at the link:bean.html[Bean] component as the *class* component works in much the same way. -[[Class-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -123,5 +113,4 @@ See Also * link:bean.html[Bean] * link:bean-binding.html[Bean Binding] -* link:bean-integration.html[Bean Integration] - +* link:bean-integration.html[Bean Integration] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 c045e1f..29f7795 100644 --- a/camel-core/src/main/docs/constant-language.adoc +++ b/camel-core/src/main/docs/constant-language.adoc @@ -1,11 +1,9 @@ -# Constant Language +## Constant Language The Constant Expression Language is really just a way to specify constant strings as a type of expression. -[[Constant-Options]] -Constant Options -^^^^^^^^^^^^^^^^ +### Constant Options // language options: START @@ -23,9 +21,7 @@ The Constant language supports 1 options which are listed below. // language options: END -[[Constant-Exampleusage]] -Example usage -^^^^^^^^^^^^^ +### Example usage The setHeader element of the Spring DSL can utilize a constant expression like: @@ -52,8 +48,6 @@ And the same example using Java DSL: from("seda:a").setHeader("theHeader", constant("the value")).to("mock:b"); -------------------------------------------------------------------------- -[[Constant-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies -The Constant language is part of *camel-core*. +The Constant language is part of *camel-core*. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 24eca34..5780e04 100644 --- a/camel-core/src/main/docs/controlbus-component.adoc +++ b/camel-core/src/main/docs/controlbus-component.adoc @@ -1,7 +1,5 @@ -# Control Bus Component -[[ControlBus-ControlBus]] -ControlBus -^^^^^^^^^^ +## Control Bus Component +### ControlBus The http://www.eaipatterns.com/ControlBus.html[Control Bus] from the link:enterprise-integration-patterns.html[EIP patterns] allows for the @@ -26,9 +24,7 @@ link:controlbus-component.html[ControlBus Component] that allows you to send messages to a control bus link:endpoint.html[Endpoint] that reacts accordingly. -[[ControlBus-ControlBusComponent]] -ControlBus Component -~~~~~~~~~~~~~~~~~~~~ +### ControlBus Component *Available as of Camel 2.11* @@ -47,9 +43,7 @@ controlbus:command[?options] Where *command* can be any string to identify which type of command to use. -[[ControlBus-Commands]] -Commands -^^^^^^^^ +### Commands [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -62,9 +56,7 @@ evaluating the message body. If there is any result from the evaluation, then the result is put in the message body. |======================================================================= -[[ControlBus-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -95,13 +87,9 @@ The Control Bus component supports 7 endpoint options which are listed below: You can append query options to the URI in the following format, `?option=value&option=value&...` -[[ControlBus-Samples]] -Samples -^^^^^^^ +### Samples -[[ControlBus-Usingroutecommand]] -Using route command -+++++++++++++++++++ +#### Using route command The route command allows you to do common tasks on a given route very easily, for example to start a route, you can send an empty message to @@ -146,9 +134,7 @@ just omit the routeId parameter as shown below: String xml = template.requestBody("controlbus:route?action=stats", null, String.class); --------------------------------------------------------------------------------------- -[[ControlBus-Usinglanguage]] -Using link:simple.html[Simple] language -+++++++++++++++++++++++++++++++++++++++ +#### Using link:simple.html[Simple] language You can use the link:simple.html[Simple] language with the control bus, for example to stop a specific route, you can send a message to the @@ -186,9 +172,7 @@ message we sent to the control bus component. TIP:You can also use other languages such as link:groovy.html[Groovy], etc. -[[ControlBus-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -199,13 +183,11 @@ See Also * link:jmx.html[JMX] Component * Using link:camel-jmx.html[JMX] with Camel -[[ControlBus-UsingThisPattern]] -Using This Pattern -++++++++++++++++++ +#### Using This Pattern If you would like to use this EIP Pattern then please read the link:getting-started.html[Getting Started], you may also find the link:architecture.html[Architecture] useful particularly the description of link:endpoint.html[Endpoint] and link:uris.html[URIs]. Then you could try out some of the link:examples.html[Examples] first before trying -this pattern out. +this pattern out. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 73738a3..d1bd85d 100644 --- a/camel-core/src/main/docs/dataformat-component.adoc +++ b/camel-core/src/main/docs/dataformat-component.adoc @@ -1,13 +1,11 @@ -# Data Format Component +## Data Format Component *Available as of Camel 2.12* The *dataformat:* component allows to use link:data-format.html[Data Format] as a Camel link:component.html[Component]. -[[DataFormatComponent-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------- @@ -20,9 +18,7 @@ then followed by the operation which must either be `marshal` or Format] in use. See the link:data-format.html[Data Format] documentation for which options it support. -[[DataFormatComponent-Options]] -DataFormat Options -^^^^^^^^^^^^^^^^^^ +### DataFormat Options // component options: START @@ -46,9 +42,7 @@ The Data Format component supports 3 endpoint options which are listed below: // endpoint options: END -[[DataFormatComponent-Samples]] -Samples -^^^^^^^ +### Samples For example to use the link:jaxb.html[JAXB] link:data-format.html[Data Format] we can do as follows: @@ -73,13 +67,10 @@ And in XML DSL you do: </camelContext> ----------------------------------------------------------------------- -[[DataFormatComponent-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:data-format.html[Data Format] - +* link:data-format.html[Data Format] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 62c5585..3f2fc135 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 link:testing.html[Testing] of distributed and asynchronous processing is notoriously difficult. The link:mock.html[Mock], link:test.html[Test] @@ -18,9 +18,7 @@ data set is received. Camel will use the link:log.html[throughput logger] when sending dataset's. -[[DataSet-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------- @@ -40,9 +38,7 @@ some implementations that can be used for testing: and `org.apache.camel.component.dataset.FileDataSet`, all of which extend `DataSetSupport`. -[[DataSet-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -86,9 +82,7 @@ The Dataset component supports 20 endpoint options which are listed below: You can append query options to the URI in the following format, `?option=value&option=value&...` -[[DataSet-ConfiguringDataSet]] -Configuring DataSet -^^^^^^^^^^^^^^^^^^^ +### Configuring DataSet Camel will lookup in the link:registry.html[Registry] for a bean implementing the DataSet interface. So you can register your own DataSet @@ -101,9 +95,7 @@ as: </bean> -------------------------------------------------------- -[[DataSet-Example]] -Example -^^^^^^^ +### Example For example, to test that a set of messages are sent to a queue and then consumed from the queue without losing any messages: @@ -126,16 +118,12 @@ data set is and what the messages look like etc.   -[[DataSet-DataSetSupport(abstractclass)]] -`DataSetSupport` (abstract class) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### `DataSetSupport` (abstract class) The DataSetSupport abstract class is a nice starting point for new DataSets, and provides some useful features to derived classes. -[[DataSet-PropertiesonDataSetSupport]] -Properties on DataSetSupport -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Properties on DataSetSupport [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= |Property |Type |Default |Description @@ -153,15 +141,11 @@ progress. Useful for showing progress of a large load test. If < 0, then `size` / 5, if is 0 then `size`, else set to `reportCount` value. |======================================================================= -[[DataSet-SimpleDataSet]] -`SimpleDataSet` -^^^^^^^^^^^^^^^ +### `SimpleDataSet` The `SimpleDataSet` extends `DataSetSupport`, and adds a default body. -[[DataSet-AdditionalPropertiesonSimpleDataSet]] -Additional Properties on SimpleDataSet -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional Properties on SimpleDataSet [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -174,16 +158,12 @@ configure the `SimpleDataSet` to use it by setting the `outputTransformer` property. |======================================================================= -[[DataSet-ListDataSet(Camel2.17)]] -`ListDataSet (Camel 2.17)` -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### `ListDataSet (Camel 2.17)` The List`DataSet` extends `DataSetSupport`, and adds a list of default bodies. -[[DataSet-AdditionalPropertiesonListDataSet]] -Additional Properties on ListDataSet -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional Properties on ListDataSet [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -204,16 +184,12 @@ the payload for the exchange will be selected using the modulus of the `CamelDataSetIndex % defaultBodies.size()` ) |======================================================================= -[[DataSet-FileDataSetCamel2.17]] -FileDataSet (Camel 2.17) -^^^^^^^^^^^^^^^^^^^^^^^^ +### FileDataSet (Camel 2.17) The `SimpleDataSet` extends `ListDataSet`, and adds support for loading the bodies from a file. -[[DataSet-AdditionalPropertiesonFileDataSet]] -Additional Properties on FileDataSet -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Additional Properties on FileDataSet [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -225,13 +201,10 @@ Additional Properties on FileDataSet the file into multiple payloads. |======================================================================= -[[DataSet-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:spring-testing.html[Spring Testing] - +* link:spring-testing.html[Spring Testing] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 6afdb46..05f3055 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 The *direct:* component provides direct, synchronous invocation of any consumers when a producer sends a message exchange. + @@ -13,9 +13,7 @@ TIP:*Connection to other camel contexts* The link:vm.html[VM] component provides connections between Camel contexts as long they run in the same *JVM*. -[[Direct-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,text] ------------------------- @@ -24,9 +22,7 @@ direct:someName[?options] Where *someName* can be any string to uniquely identify the endpoint -[[Direct-Options]] -Options -^^^^^^^ +### Options @@ -68,9 +64,7 @@ The Direct component supports 8 endpoint options which are listed below: // endpoint options: END -[[Direct-Samples]] -Samples -^^^^^^^ +### Samples In the route below we use the direct component to link the two routes together: @@ -106,14 +100,11 @@ And the sample using spring DSL: See also samples from the link:seda.html[SEDA] component, how they can be used together. -[[Direct-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] * link:seda.html[SEDA] -* link:vm.html[VM] - +* link:vm.html[VM] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 82629b3..9ff9692 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 2.10* @@ -26,9 +26,7 @@ Transactions - Tx. image:direct-vm.data/camel-direct-vm.png[image] -[[Direct-VM-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------ @@ -37,9 +35,7 @@ direct-vm:someName Where *someName* can be any string to uniquely identify the endpoint -[[Direct-VM-Options]] -Options -^^^^^^^ +### Options @@ -85,9 +81,7 @@ The Direct VM component supports 10 endpoint options which are listed below: // endpoint options: END -[[Direct-VM-Samples]] -Samples -^^^^^^^ +### Samples In the route below we use the direct component to link the two routes together: @@ -125,9 +119,7 @@ And the sample using spring DSL: </route> -------------------------------------------------- -[[Direct-VM-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -136,5 +128,4 @@ See Also * link:direct.html[Direct] * link:seda.html[SEDA] -* link:vm.html[VM] - +* link:vm.html[VM] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 ecb7e86..fd3c1f0 100644 --- a/camel-core/src/main/docs/exchangeProperty-language.adoc +++ b/camel-core/src/main/docs/exchangeProperty-language.adoc @@ -1,11 +1,9 @@ -# ExchangeProperty Language +## ExchangeProperty Language The ExchangeProperty Expression Language allows you to extract values of named exchange properties. -[[ExchangeProperty-Options]] -Exchange Property Options -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Exchange Property Options // language options: START The ExchangeProperty language supports 1 options which are listed below. @@ -21,9 +19,7 @@ The ExchangeProperty language supports 1 options which are listed below. {% endraw %} // language options: END -[[ExchangeProperty-Exampleusage]] -Example usage -^^^^^^^^^^^^^ +### Example usage The recipientList element of the Spring DSL can utilize a exchangeProperty expression like: @@ -62,8 +58,6 @@ call) from("direct:a").recipientList().exchangeProperty("myProperty"); ------------------------------------------------------------------ -[[ExchangeProperty-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies -The ExchangeProperty language is part of *camel-core*. +The ExchangeProperty language is part of *camel-core*. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 df80d2e..5b9f760 100644 --- a/camel-core/src/main/docs/file-component.adoc +++ b/camel-core/src/main/docs/file-component.adoc @@ -1,12 +1,10 @@ -# File Component +## File Component The File component provides access to file systems, allowing files to be processed by any other Camel link:components.html[Components] or messages from other components to be saved to disk. -[[File2-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------- @@ -47,13 +45,9 @@ your environment. To help with this Camel provides different `readLock` options and `doneFileName` option that you can use. See also the section _Consuming files from folders where others drop files directly_. -[[File2-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options -[[File2-Options]] -File2 Options -+++++++++++++ +#### File2 Options // component options: START @@ -157,16 +151,12 @@ The File component supports 81 endpoint options which are listed below: -[[File2-Defaultbehaviorforfileproducer]] -Default behavior for file producer -++++++++++++++++++++++++++++++++++ +#### Default behavior for file producer * By default it will override any existing file, if one exist with the same name. -[[File2-MoveandDeleteoperations]] -Move and Delete operations -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Move and Delete operations Any move or delete operations is executed after (post command) the routing has completed; so during processing of the `Exchange` the file @@ -230,9 +220,7 @@ You can combine the *pre* move and the regular move: So in this situation, the file is in the `inprogress` folder when being processed and after it's processed, it's moved to the `.done` folder. -[[File2-FinegrainedcontroloverMoveandPreMoveoption]] -Fine grained control over Move and PreMove option -+++++++++++++++++++++++++++++++++++++++++++++++++ +#### Fine grained control over Move and PreMove option The *move* and *preMove* options are link:expression.html[Expression]-based, so we have the full power of @@ -254,9 +242,7 @@ the pattern, we can do: move=backup/${date:now:yyyyMMdd}/${file:name} --------------------------------------------- -[[File2-AboutmoveFailed]] -About moveFailed -++++++++++++++++ +#### About moveFailed The `moveFailed` option allows you to move files that *could not* be processed succesfully to another location such as a error folder of your @@ -266,15 +252,11 @@ timestamp you can use See more examples at link:file-language.html[File Language] -[[File2-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following headers are supported by this component: -[[File2-Fileproduceronly]] -File producer only -++++++++++++++++++ +#### File producer only [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -298,9 +280,7 @@ if the option `fileName` has been configured, then this is still being evaluated. |======================================================================= -[[File2-Fileconsumeronly]] -File consumer only -++++++++++++++++++ +#### File consumer only [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -333,15 +313,11 @@ relative filename. For absolute files this is the absolute path. *Camel 2.10.3 and older* the type is `Date`. |======================================================================= -[[File2-BatchConsumer]] -Batch Consumer -^^^^^^^^^^^^^^ +### Batch Consumer This component implements the link:batch-consumer.html[Batch Consumer]. -[[File2-ExchangeProperties,fileconsumeronly]] -Exchange Properties, file consumer only -+++++++++++++++++++++++++++++++++++++++ +#### Exchange Properties, file consumer only As the file consumer implements the `BatchConsumer` it supports batching the files it polls. By batching we mean that Camel will add the @@ -365,9 +341,7 @@ This allows you for instance to know how many files exist in this batch and for instance let the link:aggregator2.html[Aggregator2] aggregate this number of files. -[[File2-Usingcharset]] -Using charset -^^^^^^^^^^^^^ +### Using charset *Available as of Camel 2.9.3* + The charset option allows for configuring an encoding of the files on @@ -455,9 +429,7 @@ DEBUG GenericFileConverter - Read file /Users/davsclaus/workspace/came DEBUG FileOperations - Using Reader to write file: target/charset/output.txt with charset: iso-8859-1 ---------------------------------------------------------------------------------------------------------------------------------------------- -[[File2-Commongotchaswithfolderandfilenames]] -Common gotchas with folder and filenames -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Common gotchas with folder and filenames When Camel is producing files (writing files) there are a few gotchas affecting how to set a filename of your choice. By default, Camel will @@ -497,18 +469,14 @@ And a syntax where we set the filename on the endpoint with the from("direct:report").to("file:target/reports/?fileName=report.txt"); --------------------------------------------------------------------- -[[File2-FilenameExpression]] -Filename Expression -^^^^^^^^^^^^^^^^^^^ +### Filename Expression Filename can be set either using the *expression* option or as a string-based link:file-language.html[File Language] expression in the `CamelFileName` header. See the link:file-language.html[File Language] for syntax and samples. -[[File2-Consumingfilesfromfolderswhereothersdropfilesdirectly]] -Consuming files from folders where others drop files directly -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Consuming files from folders where others drop files directly Beware if you consume files from a folder where other applications write files to directly. Take a look at the different readLock options to see @@ -523,9 +491,7 @@ good at detecting this. You may also want to look at the doneFileName option, which uses a marker file (done file) to signal when a file is done and ready to be consumed. -[[File2-Usingdonefiles]] -Using done files -^^^^^^^^^^^^^^^^ +### Using done files *Available as of Camel 2.6* @@ -573,9 +539,7 @@ from("file:bar?doneFileName=ready-${file:name}"); * `hello.txt` - is the file to be consumed * `ready-hello.txt` - is the associated done file -[[File2-Writingdonefiles]] -Writing done files -^^^^^^^^^^^^^^^^^^ +### Writing done files *Available as of Camel 2.6* @@ -622,22 +586,16 @@ was `foo.txt` in the same directory as the target file. Will for example create a file named `foo.done` if the target file was `foo.txt` in the same directory as the target file. -[[File2-Samples]] -Samples -^^^^^^^ +### Samples -[[File2-Readfromadirectoryandwritetoanotherdirectory]] -Read from a directory and write to another directory -++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Read from a directory and write to another directory [source,java] ----------------------------------------------------------- from("file://inputdir/?delete=true").to("file://outputdir") ----------------------------------------------------------- -[[File2-Readfromadirectoryandwritetoanotherdirectoryusingaoverruledynamicname]] -Read from a directory and write to another directory using a overrule dynamic name -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Read from a directory and write to another directory using a overrule dynamic name [source,java] --------------------------------------------------------------------------------------------- @@ -648,9 +606,7 @@ Listen on a directory and create a message for each file dropped there. Copy the contents to the `outputdir` and delete the file in the `inputdir`. -[[File2-Readingrecursivelyfromadirectoryandwritingtoanother]] -Reading recursively from a directory and writing to another -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reading recursively from a directory and writing to another [source,java] -------------------------------------------------------------------------- @@ -698,9 +654,7 @@ outputdir/foo.txt outputdir/bar.txt ----------------- -[[File2-Readingfromadirectoryandthedefaultmoveoperation]] -Reading from a directory and the default move operation -+++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reading from a directory and the default move operation Camel will by default move any processed file into a `.camel` subdirectory in the directory the file was consumed from. @@ -729,9 +683,7 @@ outputdir/foo.txt outputdir/sub/bar.txt --------------------------- -[[File2-Readfromadirectoryandprocessthemessageinjava]] -Read from a directory and process the message in java -+++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Read from a directory and process the message in java [source,java] ----------------------------------------------------------- @@ -746,17 +698,13 @@ from("file://inputdir/").process(new Processor() { The body will be a `File` object that points to the file that was just dropped into the `inputdir` directory. -[[File2-Writingtofiles]] -Writing to files -++++++++++++++++ +#### Writing to files Camel is of course also able to write files, i.e. produce files. In the sample below we receive some reports on the SEDA queue that we process before they are being written to a directory. -[[File2-WritetosubdirectoryusingExchange.FILE_NAME]] -Write to subdirectory using `Exchange.FILE_NAME` -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Write to subdirectory using `Exchange.FILE_NAME` Using a single route, it is possible to write a file to any number of subdirectories. If you have a route setup as such: @@ -781,9 +729,7 @@ Exchange.FILE_NAME = foo/bye.txt => /rootDirectory/foo/bye.txt This allows you to have a single route to write files to multiple destinations. -[[File2-Writingfilethroughthetemporarydirectoryrelativetothefinaldestination]] -Writing file through the temporary directory relative to the final destination -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Writing file through the temporary directory relative to the final destination Sometime you need to temporarily write the files to some directory relative to the destination directory. Such situation usually happens @@ -799,9 +745,7 @@ from("direct:start"). to("file:///var/myapp/finalDirectory?tempPrefix=/../filesInProgress/"); ------------------------------------------------------------------------- -[[File2-Usingexpressionforfilenames]] -Using expression for filenames -++++++++++++++++++++++++++++++ +#### Using expression for filenames In this sample we want to move consumed files to a backup folder using today's date as a sub-folder name: @@ -813,9 +757,7 @@ from("file://inbox?move=backup/${date:now:yyyyMMdd}/${file:name}").to("..."); See link:file-language.html[File Language] for more samples. -[[File2-Avoidingreadingthesamefilemorethanonceidempotentconsumer]] -Avoiding reading the same file more than once (idempotent consumer) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Avoiding reading the same file more than once (idempotent consumer) Camel supports link:idempotent-consumer.html[Idempotent Consumer] directly within the component so it will skip already processed files. @@ -865,9 +807,7 @@ consumed before: DEBUG FileConsumer is idempotent and the file has been consumed before. Will skip this file: target\idempotent\report.txt ------------------------------------------------------------------------------------------------------------------------- -[[File2-Usingafilebasedidempotentrepository]] -Using a file based idempotent repository -++++++++++++++++++++++++++++++++++++++++ +#### Using a file based idempotent repository In this section we will use the file based idempotent repository `org.apache.camel.processor.idempotent.FileIdempotentRepository` instead @@ -887,9 +827,7 @@ idempotent repository and define our file consumer to use our repository with the `idempotentRepository` using `#` sign to indicate link:registry.html[Registry] lookup: -[[File2-UsingaJPAbasedidempotentrepository]] -Using a JPA based idempotent repository -+++++++++++++++++++++++++++++++++++++++ +#### Using a JPA based idempotent repository In this section we will use the JPA based idempotent repository instead of the in-memory based that is used as default. @@ -940,9 +878,7 @@ option: </route> --------------------------------------------------------------------------------- -[[File2-Filterusingorg.apache.camel.component.file.GenericFileFilter]] -Filter using org.apache.camel.component.file.GenericFileFilter -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Filter using org.apache.camel.component.file.GenericFileFilter Camel supports pluggable filtering strategies. You can then configure the endpoint with such a filter to skip certain files being processed. @@ -965,9 +901,7 @@ spring XML file: </route> ---------------------------------------------------------- -[[File2-FilteringusingANTpathmatcher]] -Filtering using ANT path matcher -++++++++++++++++++++++++++++++++ +#### Filtering using ANT path matcher TIP:*New options from Camel 2.10 onwards* There are now `antInclude` and `antExclude` options to make it easy to @@ -988,9 +922,7 @@ The file paths is matched with the following rules: The sample below demonstrates how to use it: -[[File2-SortingusingComparator]] -Sorting using Comparator -^^^^^^^^^^^^^^^^^^^^^^^^ +### Sorting using Comparator Camel supports pluggable sorting strategies. This strategy it to use the build in `java.util.Comparator` in Java. You can then configure the @@ -1021,9 +953,7 @@ link:registry.html[Registry] by prefixing the id with `#`. So writing `sorter=#mySorter`, will instruct Camel to go look in the link:registry.html[Registry] for a bean with the ID, `mySorter`. -[[File2-SortingusingsortBy]] -Sorting using sortBy -^^^^^^^^^^^^^^^^^^^^ +### Sorting using sortBy Camel supports pluggable sorting strategies. This strategy it to use the link:file-language.html[File Language] to configure the sorting. The @@ -1111,9 +1041,7 @@ per group, so we could reverse the file names: sortBy=date:file:yyyyMMdd;reverse:file:name ------------------------------------------- -[[File2-UsingGenericFileProcessStrategy]] -Using GenericFileProcessStrategy -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using GenericFileProcessStrategy The option `processStrategy` can be used to use a custom `GenericFileProcessStrategy` that allows you to implement your own @@ -1134,9 +1062,7 @@ resources etc. * in the `commit()` method we can move the actual file and also delete the _ready_ file. -[[File2-Usingfilter]] -Using filter -^^^^^^^^^^^^ +### Using filter The `filter` option allows you to implement a custom filter in Java code by implementing the `org.apache.camel.component.file.GenericFileFilter` @@ -1149,9 +1075,7 @@ directories, to avoid traversing down unwanted directories. For example to skip any directories which starts with `"skip"` in the name, can be implemented as follows: -[[File2-HowtousetheCamelerrorhandlertodealwithexceptionstriggeredoutsidetheroutingengine]] -How to use the Camel error handler to deal with exceptions triggered outside the routing engine -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to use the Camel error handler to deal with exceptions triggered outside the routing engine The file and ftp consumers, will by default try to pickup files. Only if that is successful then a Camel link:exchange.html[Exchange] can be @@ -1203,9 +1127,7 @@ class="com.foo.MyExceptionHandler"/>: The source code for this example can be seen https://svn.apache.org/repos/asf/camel/trunk/camel-core/src/test/java/org/apache/camel/component/file/FileConsumerCustomExceptionHandlerTest.java[here] -[[File2-Usingconsumer.bridgeErrorHandler]] -Using consumer.bridgeErrorHandler -+++++++++++++++++++++++++++++++++ +#### Using consumer.bridgeErrorHandler *Available as of Camel 2.10* @@ -1227,16 +1149,12 @@ does *not* apply. The link:exchange.html[Exchange] is processed directly by the Camel link:error-handler.html[Error Handler], and does not allow prior actions such as interceptors, onCompletion to take action. -[[File2-Debuglogging]] -Debug logging -^^^^^^^^^^^^^ +### Debug logging This component has log level *TRACE* that can be helpful if you have problems. -[[File2-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -1245,5 +1163,4 @@ See Also * link:file-language.html[File Language] * link:ftp2.html[FTP] -* link:polling-consumer.html[Polling Consumer] - +* link:polling-consumer.html[Polling Consumer] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/camel-core/src/main/docs/file-language.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/file-language.adoc b/camel-core/src/main/docs/file-language.adoc index 7a8628f..580c297 100644 --- a/camel-core/src/main/docs/file-language.adoc +++ b/camel-core/src/main/docs/file-language.adoc @@ -1,4 +1,4 @@ -# File Language +## File Language INFO:*File language is now merged with Simple language* From Camel 2.2 onwards, the file language is now merged with @@ -12,9 +12,7 @@ path and names. The goal is to allow expressions to be used with the link:file2.html[File] and link:ftp.html[FTP] components for setting dynamic file patterns for both consumer and producer. -[[FileLanguage-Options]] -File Language options -^^^^^^^^^^^^^^^^^^^^^ +### File Language options // language options: START The File language supports 2 options which are listed below. @@ -31,9 +29,7 @@ The File language supports 2 options which are listed below. {% endraw %} // language options: END -[[FileLanguage-Syntax]] -Syntax -^^^^^^ +### Syntax This language is an *extension* to the link:simple.html[Simple] language so the link:simple.html[Simple] syntax applies also. So the table below @@ -104,13 +100,9 @@ the file. Notice: all the commands from the link:simple.html[Simple] language can also be used. |======================================================================= -[[FileLanguage-Filetokenexample]] -File token example -^^^^^^^^^^^^^^^^^^ +### File token example -[[FileLanguage-Relativepaths]] -Relative paths -++++++++++++++ +#### Relative paths We have a `java.io.File` handle for the file `hello.txt` in the following *relative* directory: `.\filelanguage\test`. And we configure @@ -142,9 +134,7 @@ tokens will return as: |file:absolute.path |\workspace\camel\camel-core\target\filelanguage\test\hello.txt |======================================================================= -[[FileLanguage-Absolutepaths]] -Absolute paths -++++++++++++++ +#### Absolute paths We have a `java.io.File` handle for the file `hello.txt` in the following *absolute* directory: @@ -178,9 +168,7 @@ return as: |file:absolute.path |\workspace\camel\camel-core\target\filelanguage\test\hello.txt |======================================================================= -[[FileLanguage-Samples]] -Samples -^^^^^^^ +### Samples You can enter a fixed link:constant.html[Constant] expression such as `myfile.txt`: @@ -238,9 +226,7 @@ use the link:file-language.html[File Language], link:simple.html[Simple] and the link:bean.html[Bean] language in one combined expression. This is pretty powerful for those common file path patterns. -[[FileLanguage-UsingSpringPropertyPlaceholderConfigurertogetherwiththeFilecomponent]] -Using Spring PropertyPlaceholderConfigurer together with the link:file2.html[File] component -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using Spring PropertyPlaceholderConfigurer together with the link:file2.html[File] component In Camel you can use the link:file-language.html[File Language] directly from the link:simple.html[Simple] language which makes a @@ -304,8 +290,6 @@ Invalid bean definition with name 'sampleRoute' defined in class path resource [ Could not resolve placeholder 'date:now:yyyyMMdd' ---------------------------------------------------------------------------------------------------- -[[FileLanguage-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies -The File language is part of *camel-core*. +The File language is part of *camel-core*. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/camel-core/src/main/docs/gzip-dataformat.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/gzip-dataformat.adoc b/camel-core/src/main/docs/gzip-dataformat.adoc index 7a0b708..5417db1 100644 --- a/camel-core/src/main/docs/gzip-dataformat.adoc +++ b/camel-core/src/main/docs/gzip-dataformat.adoc @@ -1,4 +1,4 @@ -# GZip DataFormat +## GZip DataFormat The GZip link:data-format.html[Data Format] is a message compression and de-compression format. It uses the same deflate algorithm that is used @@ -10,9 +10,7 @@ The compression capability is quite useful when you deal with large XML and Text based payloads or when you read messages previously comressed using `gzip` tool. -[[GZipdataformat-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The GZip dataformat supports 1 options which are listed below. @@ -28,9 +26,7 @@ The GZip dataformat supports 1 options which are listed below. {% endraw %} // dataformat options: END -[[GZipdataformat-Marshal]] -Marshal -^^^^^^^ +### Marshal In this example we marshal a regular text/XML payload to a compressed payload employing gzip compression format and send it an ActiveMQ queue @@ -41,9 +37,7 @@ called MY_QUEUE. from("direct:start").marshal().gzip().to("activemq:queue:MY_QUEUE"); -------------------------------------------------------------------- -[[GZipdataformat-Unmarshal]] -Unmarshal -^^^^^^^^^ +### Unmarshal In this example we unmarshal a gzipped payload from an ActiveMQ queue called MY_QUEUE to its original format, and forward it for processing to @@ -54,9 +48,7 @@ the `UnGZippedMessageProcessor`. from("activemq:queue:MY_QUEUE").unmarshal().gzip().process(new UnGZippedMessageProcessor()); --------------------------------------------------------------------------------------------- -[[GZipdataformat-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies This data format is provided in *camel-core* so no additional -dependencies is needed. +dependencies is needed. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/camel-core/src/main/docs/header-language.adoc ---------------------------------------------------------------------- diff --git a/camel-core/src/main/docs/header-language.adoc b/camel-core/src/main/docs/header-language.adoc index 94d09b4..1b9c9c2 100644 --- a/camel-core/src/main/docs/header-language.adoc +++ b/camel-core/src/main/docs/header-language.adoc @@ -1,11 +1,9 @@ -# Header Language +## Header Language The Header Expression Language allows you to extract values of named headers. -[[Header-Options]] -Header Options -^^^^^^^^^^^^^^ +### Header Options // language options: START The Header language supports 1 options which are listed below. @@ -21,9 +19,7 @@ The Header language supports 1 options which are listed below. {% endraw %} // language options: END -[[Header-Exampleusage]] -Example usage -^^^^^^^^^^^^^ +### Example usage The recipientList element of the Spring DSL can utilize a header expression like: @@ -42,8 +38,6 @@ notice that header is not a parameter but a stacked method call) from("direct:a").recipientList().header("myHeader"); ------------------------------------------------------ -[[Header-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies -The Header language is part of *camel-core*. +The Header language is part of *camel-core*. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 88a3c38..7f62527 100644 --- a/camel-core/src/main/docs/language-component.adoc +++ b/camel-core/src/main/docs/language-component.adoc @@ -1,4 +1,4 @@ -# Language Component +## Language Component *Available as of Camel 2.5* @@ -16,9 +16,7 @@ additional JARs is needed. You only have to include additional Camel components if the language of choice mandates it, such as using link:groovy.html[Groovy] or link:javascript.html[JavaScript] languages. -[[Language-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------------ @@ -34,9 +32,7 @@ link:language.html[Language]s in Camel language://languageName:resource:scheme:location][?options] ----------------------------------------------------------- -[[Language-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START @@ -65,9 +61,7 @@ The Language component supports 8 endpoint options which are listed below: // endpoint options: END -[[Language-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following message headers can be used to affect the behavior of the component @@ -80,9 +74,7 @@ component script configured on the endpoint. |======================================================================= -[[Language-Examples]] -Examples -^^^^^^^^ +### Examples For example you can use the link:simple.html[Simple] language to link:message-translator.html[Message Translator] a message: @@ -103,9 +95,7 @@ Object out = producer.requestBodyAndHeader("language:xpath", "<foo>Hello World</ assertEquals("Hello World", out); -------------------------------------------------------------------------------------------------------------------------------- -[[Language-Loadingscriptsfromresources]] -Loading scripts from resources -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading scripts from resources *Available as of Camel 2.9* @@ -126,9 +116,7 @@ From *Camel 2.11* onwards you can refer to the resource similar to the other link:language.html[Language]s in Camel by prefixing with `"resource:"` as shown below: -[[Language-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -137,5 +125,4 @@ See Also * link:languages.html[Languages] * link:routing-slip.html[Routing Slip] * link:dynamic-router.html[Dynamic Router] -* link:script.html[Script] - +* link:script.html[Script] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 be6598b..e365f86 100644 --- a/camel-core/src/main/docs/log-component.adoc +++ b/camel-core/src/main/docs/log-component.adoc @@ -1,4 +1,4 @@ -# Log Component +## Log Component The *log:* component logs message exchanges to the underlying logging mechanism. @@ -12,9 +12,7 @@ logging via, among others: http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/package-summary.html[JDK Util Logging logging] -[[Log-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -51,9 +49,7 @@ There is also a `log` directly in the DSL, but it has a different purpose. Its meant for lightweight and human logs. See more details at link:logeip.html[LogEIP]. -[[Log-Options]] -Options -^^^^^^^ +### Options @@ -112,9 +108,7 @@ The Log component supports 26 endpoint options which are listed below: // endpoint options: END -[[Log-Regularloggersample]] -Regular logger sample -^^^^^^^^^^^^^^^^^^^^^ +### Regular logger sample In the route below we log the incoming orders at `DEBUG` level before the order is processed: @@ -135,9 +129,7 @@ Or using Spring XML to define the route: </route> --------------------------------------------------- -[[Log-Regularloggerwithformattersample]] -Regular logger with formatter sample -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Regular logger with formatter sample In the route below we log the incoming orders at `INFO` level before the order is processed. @@ -148,9 +140,7 @@ from("activemq:orders"). to("log:com.mycompany.order?showAll=true&multiline=true").to("bean:processOrder"); -------------------------------------------------------------------------------------- -[[Log-ThroughputloggerwithgroupSizesample]] -Throughput logger with groupSize sample -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Throughput logger with groupSize sample In the route below we log the throughput of the incoming orders at `DEBUG` level grouped by 10 messages. @@ -161,9 +151,7 @@ from("activemq:orders"). to("log:com.mycompany.order?level=DEBUG&groupSize=10").to("bean:processOrder"); ----------------------------------------------------------------------------------- -[[Log-ThroughputloggerwithgroupIntervalsample]] -Throughput logger with groupInterval sample -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Throughput logger with groupInterval sample This route will result in message stats logged every 10s, with an initial 60s delay and stats should be displayed even if there isn't any @@ -182,9 +170,7 @@ The following will be logged: "Received: 1000 new messages, with total 2000 so far. Last group took: 10000 millis which is: 100 messages per second. average: 100" ------------------------------------------------------------------------------------------------------------------------------------ -[[Log-Fullcustomizationoftheloggingoutput]] -Full customization of the logging output -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Full customization of the logging output *Available as of Camel 2.11* @@ -266,9 +252,7 @@ options: <to uri="log:bar?param1=bar&param2=200"/> --------------------------------------------- -[[Log-UsingLogcomponentinOSGi]] -Using Log component in OSGi -+++++++++++++++++++++++++++ +#### Using Log component in OSGi *Improvement as of Camel 2.12.4/2.13.1* @@ -284,9 +268,7 @@ should be the bundle which contains route definition. To do this, either register single instance of `org.slf4j.Logger` in the Registry or reference it using `logger` URI parameter. -[[Log-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -297,5 +279,4 @@ See Also * link:how-do-i-use-log4j.html[How do I use log4j] * link:how-do-i-use-java-14-logging.html[How do I use Java 1.4 logging] * link:logeip.html[LogEIP] for using `log` directly in the DSL for human -logs. - +logs. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/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 dff920f..58e70cd 100644 --- a/camel-core/src/main/docs/mock-component.adoc +++ b/camel-core/src/main/docs/mock-component.adoc @@ -1,4 +1,4 @@ -# Mock Component +## Mock Component ifdef::env-github[] :caution-caption: :boom: :important-caption: :exclamation: @@ -7,9 +7,7 @@ ifdef::env-github[] :warning-caption: :warning: endif::[] -[[Mock-MockComponent]] -Mock Component -~~~~~~~~~~~~~~ +### Mock Component link:testing.html[Testing] of distributed and asynchronous processing is notoriously difficult. The link:mock.html[Mock], link:test.html[Test] @@ -65,9 +63,7 @@ From Camel 2.10 onwards there are two new options `retainFirst`, and endpoints keep in memory. -[[Mock-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source] ---- @@ -80,9 +76,7 @@ endpoint. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Mock-Options]] -Options -^^^^^^^ +### Options @@ -120,9 +114,7 @@ The Mock component supports 11 endpoint options which are listed below: -[[Mock-SimpleExample]] -Simple Example -^^^^^^^^^^^^^^ +### Simple Example Here's a simple example of Mock endpoint in use. First, the endpoint is resolved on the context. Then we set an expectation, and then, after the @@ -149,9 +141,7 @@ Camel will by default wait 10 seconds when the `assertIsSatisfied()` is invoked. This can be configured by setting the `setResultWaitTime(millis)` method. -[[Mock-UsingassertPeriod]] -Using `assertPeriod` -++++++++++++++++++++ +#### Using `assertPeriod` *Available as of Camel 2.7* + When the assertion is satisfied then Camel will stop waiting and @@ -174,9 +164,7 @@ resultEndpoint.expectedMessageCount(2); resultEndpoint.assertIsSatisfied(); ---- -[[Mock-Settingexpectations]] -Setting expectations -^^^^^^^^^^^^^^^^^^^^ +### Setting expectations You can see from the Javadoc of http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html[MockEndpoint] @@ -220,9 +208,7 @@ Here's another example: resultEndpoint.expectedBodiesReceived("firstMessageBody", "secondMessageBody", "thirdMessageBody"); ---- -[[Mock-Addingexpectationstospecificmessages]] -Adding expectations to specific messages -++++++++++++++++++++++++++++++++++++++++ +#### Adding expectations to specific messages In addition, you can use the http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/component/mock/MockEndpoint.html#message(int)[`message(int @@ -242,9 +228,7 @@ There are some examples of the Mock endpoint in use in the http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/[`camel-core` processor tests]. -[[Mock-Mockingexistingendpoints]] -Mocking existing endpoints -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Mocking existing endpoints *Available as of Camel 2.7* @@ -313,9 +297,7 @@ That means Camel will use more memory. This may not be suitable when you send in a lot of messages. -[[Mock-Mockingexistingendpointsusingthecamel-testcomponent]] -Mocking existing endpoints using the `camel-test` component -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Mocking existing endpoints using the `camel-test` component Instead of using the `adviceWith` to instruct Camel to mock endpoints, you can easily enable this behavior when using the `camel-test` Test @@ -335,9 +317,7 @@ include::../../../../components/camel-test/src/test/java/org/apache/camel/test/p ---- -[[Mock-MockingexistingendpointswithXMLDSL]] -Mocking existing endpoints with XML DSL -+++++++++++++++++++++++++++++++++++++++ +#### Mocking existing endpoints with XML DSL If you do not use the `camel-test` component for unit testing (as shown above) you can use a different approach when using XML files for @@ -377,9 +357,7 @@ in the constructor for the bean: </bean> ---- -[[Mock-Mockingendpointsandskipsendingtooriginalendpoint]] -Mocking endpoints and skip sending to original endpoint -+++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Mocking endpoints and skip sending to original endpoint *Available as of Camel 2.10* @@ -405,9 +383,7 @@ The same example using the link:testing.html[Test Kit] include::../../../../components/camel-test/src/test/java/org/apache/camel/test/patterns/IsMockEndpointsAndSkipJUnit4Test.java[tags=e1] ---- -[[Mock-Limitingthenumberofmessagestokeep]] -Limiting the number of messages to keep -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Limiting the number of messages to keep *Available as of Camel 2.10* @@ -444,9 +420,7 @@ methods that work on message bodies, headers, etc. will only operate on the retained messages. In the example above they can test only the expectations on the 10 retained messages. -[[Mock-Testingwitharrivaltimes]] -Testing with arrival times -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Testing with arrival times *Available as of Camel 2.7* @@ -502,9 +476,7 @@ In the example above we use `seconds` as the time unit, but Camel offers `milliseconds`, and `minutes` as well. -[[Mock-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -512,4 +484,4 @@ See Also * link:getting-started.html[Getting Started] * link:spring-testing.html[Spring Testing] -* link:testing.html[Testing] +* link:testing.html[Testing] \ No newline at end of file
