http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-cxf/src/main/docs/cxfrs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc index d3b9e7d..d3ffe40 100644 --- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc +++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc @@ -1,4 +1,4 @@ -# CXF-RS Component +## CXF-RS Component [Note] ==== @@ -29,9 +29,7 @@ for this component: </dependency> ------------------------------------------------------------------------------------- -[[CXFRS-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------- @@ -55,9 +53,7 @@ For either style above, you can append options to the URI as follows: cxfrs:bean:cxfEndpoint?resourceClasses=org.apache.camel.rs.Example ------------------------------------------------------------------ -[[CXFRS-Options]] -Options -^^^^^^^ +### Options @@ -129,9 +125,7 @@ http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resour file] and https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAX-RS documentation] for more information. -[[CXFRS-HowtoconfiguretheRESTendpointinCamel]] -How to configure the REST endpoint in Camel -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to configure the REST endpoint in Camel In http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd[camel-cxf @@ -139,9 +133,7 @@ schema file], there are two elements for the REST endpoint definition. *cxf:rsServer* for REST consumer, *cxf:rsClient* for REST producer. + You can find a Camel REST service route configuration example here. -[[CXFRS-HowtooverridetheCXFproduceraddressfrommessageheader]] -How to override the CXF producer address from message header -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to override the CXF producer address from message header The `camel-cxfrs` producer supports to override the services address by setting the message with the key of "CamelDestinationOverrideUrl". @@ -152,9 +144,7 @@ setting the message with the key of "CamelDestinationOverrideUrl". exchange.getIn().setHeader(Exchange.DESTINATION_OVERRIDE_URL, constant(getServiceAddress())); ---------------------------------------------------------------------------------------------- -[[CXFRS-ConsumingaRESTRequest-SimpleBindingStyle]] -Consuming a REST Request - Simple Binding Style -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Consuming a REST Request - Simple Binding Style *Available as of Camel 2.11* @@ -192,9 +182,7 @@ respected and it becomes the final response. * In all cases, Camel headers permitted by custom or default `HeaderFilterStrategy` are added to the HTTP response. -[[CXFRS-EnablingtheSimpleBindingStyle]] -Enabling the Simple Binding Style -+++++++++++++++++++++++++++++++++ +#### Enabling the Simple Binding Style This binding style can be activated by setting the `bindingStyle` parameter in the consumer endpoint to value `SimpleConsumer`: @@ -205,9 +193,7 @@ parameter in the consumer endpoint to value `SimpleConsumer`: .to("log:TEST?showAll=true"); --------------------------------------------------------- -[[CXFRS-Examplesofrequestbindingwithdifferentmethodsignatures]] -Examples of request binding with different method signatures -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Examples of request binding with different method signatures Below is a list of method signatures along with the expected result from the Simple binding. @@ -239,9 +225,7 @@ as the IN message body. The DataHandler is unwrapped from the MessageContentsList and preserved as the IN message body. -[[CXFRS-MoreexamplesoftheSimpleBindingStyle]] -More examples of the Simple Binding Style -+++++++++++++++++++++++++++++++++++++++++ +#### More examples of the Simple Binding Style Given a JAX-RS resource class with this method: @@ -290,9 +274,7 @@ For more examples on how to process requests and write responses can be found https://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/jaxrs/simplebinding/[here]. -[[CXFRS-ConsumingaRESTRequest-DefaultBindingStyle]] -Consuming a REST Request - Default Binding Style -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Consuming a REST Request - Default Binding Style The https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAXRS front end] implements the https://jsr311.java.net/[JAX-RS (JSR-311) API], so we can @@ -327,9 +309,7 @@ set on the Camel exchange and the route execution will continue as usual. This can be useful for integrating the existing JAX-RS implementations into Camel routes and for post-processing JAX-RS Responses in custom processors. -[[CXFRS-HowtoinvoketheRESTservicethroughcamel-cxfrsproducer]] -How to invoke the REST service through camel-cxfrs producer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to invoke the REST service through camel-cxfrs producer The https://cwiki.apache.org/CXF20DOC/JAX-RS[CXF JAXRS front end] implements @@ -367,4 +347,4 @@ Index: 20, Size: 20 To support the Dynamical routing, you can override the URI's query parameters by using the CxfConstants.CAMEL_CXF_RS_QUERY_MAP header to -set the parameter map for it. +set the parameter map for it. \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-disruptor/src/main/docs/disruptor-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc index f3d7bce..7d67f52 100644 --- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc +++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc @@ -1,4 +1,4 @@ -# Disruptor Component +## Disruptor Component *Available as of Camel 2.12* @@ -61,9 +61,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Disruptor-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -88,9 +86,7 @@ across contexts in case of + ?option=value&option=value&⦠------------------------------ -[[Disruptor-Options]] -Options -^^^^^^^ +### Options All the following options are valid for both the **disruptor:** and **disruptor-vm:** components. @@ -145,9 +141,7 @@ The Disruptor component supports 13 endpoint options which are listed below: // endpoint options: END -[[Disruptor-Waitstrategies]] -Wait strategies -^^^^^^^^^^^^^^^ +### Wait strategies The wait strategy effects the type of waiting performed by the consumer threads that are currently waiting for the next exchange to be @@ -176,9 +170,7 @@ barrier after an initially spinning. |This strategy is a good compromise between without incurring significant latency spikes. |======================================================================= -[[Disruptor-UseofRequestReply]] -Use of Request Reply -^^^^^^^^^^^^^^^^^^^^ +### Use of Request Reply The Disruptor component supports using link:request-reply.html[Request Reply], where the caller will wait for the Async route to complete. For @@ -196,9 +188,7 @@ buffer. As it is a link:request-reply.html[Request Reply] message, we wait for the response. When the consumer on the _disruptor:input_ buffer is complete, it copies the response to the original message response. -[[Disruptor-Concurrentconsumers]] -Concurrent consumers -^^^^^^^^^^^^^^^^^^^^ +### Concurrent consumers By default, the Disruptor endpoint uses a single consumer thread, but you can configure it to use concurrent consumer threads. So instead of @@ -214,9 +204,7 @@ increase/shrink dynamically at runtime depending on load, whereas the number of concurrent consumers is always fixed and supported by the Disruptor internally so performance will be higher. -[[Disruptor-Threadpools]] -Thread pools -^^^^^^^^^^^^ +### Thread pools Be aware that adding a thread pool to a Disruptor endpoint by doing something like: @@ -233,9 +221,7 @@ of the performance gains achieved by using the Disruptor. Instead, it is advices to directly configure number of threads that process messages on a Disruptor endpoint using the concurrentConsumers option. -[[Disruptor-Sample]] -Sample -^^^^^^ +### Sample In the route below we use the Disruptor to send the request to this async queue to be able to send a fire-and-forget message for further @@ -268,9 +254,7 @@ another thread for further processing. Since this is from a unit test, it will be sent to a mock endpoint where we can do assertions in the unit test. -[[Disruptor-UsingmultipleConsumers]] -Using multipleConsumers -^^^^^^^^^^^^^^^^^^^^^^^ +### Using multipleConsumers In this example we have defined two consumers and registered them as spring beans. @@ -309,9 +293,7 @@ public class FooEventConsumer { } ------------------------------------------- -[[Disruptor-Extractingdisruptorinformation]] -Extracting disruptor information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Extracting disruptor information If needed, information such as buffer size, etc. can be obtained without using JMX in this fashion: @@ -320,4 +302,4 @@ using JMX in this fashion: -------------------------------------------------------------------- DisruptorEndpoint disruptor = context.getEndpoint("disruptor:xxxx"); int size = disruptor.getBufferSize(); --------------------------------------------------------------------- +-------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-dns/src/main/docs/dns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc index 1a0a1ec..1b232d9 100644 --- a/components/camel-dns/src/main/docs/dns-component.adoc +++ b/components/camel-dns/src/main/docs/dns-component.adoc @@ -1,4 +1,4 @@ -# DNS Component +## DNS Component *Available as of Camel 2.7* @@ -31,9 +31,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[DNS-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a DNS component is as follows @@ -44,9 +42,7 @@ dns://operation[?options] This component only supports producers. -[[DNS-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -69,9 +65,7 @@ The DNS component supports 2 endpoint options which are listed below: // endpoint options: END -[[DNS-Headers]] -Headers -^^^^^^^ +### Headers [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -93,13 +87,9 @@ Optional. one specified by the OS will be used. Optional. |======================================================================= -[[DNS-Examples]] -Examples -^^^^^^^^ +### Examples -[[DNS-IPlookup]] -IP lookup -+++++++++ +#### IP lookup [source,xml] -------------------------------------- @@ -114,9 +104,7 @@ This looks up a domain's IP. For example, www.example.com resolves to The IP address to lookup must be provided in the header with key `"dns.domain"`. -[[DNS-DNSlookup]] -DNS lookup -++++++++++ +#### DNS lookup [source,xml] -------------------------------------- @@ -130,9 +118,7 @@ This returns a set of DNS records associated with a domain. + The name to lookup must be provided in the header with key `"dns.name"`. -[[DNS-DNSDig]] -DNS Dig -+++++++ +#### DNS Dig Dig is a Unix command-line utility to run DNS queries. @@ -146,12 +132,9 @@ Dig is a Unix command-line utility to run DNS queries. The query must be provided in the header with key `"dns.query"`. -[[DNS-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/components/camel-docker/src/main/docs/docker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index 41d634d..d0ab1f1 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -1,4 +1,4 @@ -# Docker Component +## Docker Component *Available as of Camel 2.15* @@ -10,9 +10,7 @@ https://docs.docker.com/reference/api/docker_remote_api[Docker Remote API]. -[[Docker-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------ @@ -21,9 +19,7 @@ docker://[operation]?[options] Where *operation* is the specific action to perform on Docker. -[[Docker-Options]] -General Options -^^^^^^^^^^^^^^^ +### General Options // component options: START The Docker component supports 1 options which are listed below. @@ -71,9 +67,7 @@ The Docker component supports 20 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Docker-HeaderStrategy]] -Header Strategy -^^^^^^^^^^^^^^^ +### Header Strategy All URI option can be passed as Header properties. Values found in a message header take precedence over URI parameters. A header property @@ -88,9 +82,7 @@ below |======================================================================= -[[Docker-Examples]] -Examples -^^^^^^^^ +### Examples The following example consumes events from Docker: @@ -107,9 +99,7 @@ from("docker://info?host=192.168.59.103&port=2375").to("log:info"); ------------------------------------------------------------------- -[[Docker-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Docker in your Camel routes you need to add a dependency on *camel-docker*, which implements the component. @@ -125,4 +115,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-docker</artifactId> <version>x.x.x</version> </dependency> -------------------------------------- +------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-dozer/src/main/docs/dozer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc index f29de89..f891716 100644 --- a/components/camel-dozer/src/main/docs/dozer-component.adoc +++ b/components/camel-dozer/src/main/docs/dozer-component.adoc @@ -1,4 +1,4 @@ -# Dozer Component +## Dozer Component The *dozer:* component provides the ability to map between Java beans using the http://camel.apache.org/dozer-type-conversion.html[Dozer] @@ -30,9 +30,7 @@ following dependency to their `pom.xml`: </dependency> ------------------------------------------------------------ -[[Dozer-URIformat]] -URI format -^^^^^^^^^^ +### URI format The Dozer component only supports producer endpoints. @@ -53,9 +51,7 @@ from("direct:orderInput"). to("direct:orderOutput"); --------------------------------------------------------------------------------------- -[[Dozer-Options]] -Options -^^^^^^^ +### Options // component options: START The Dozer component has no options. @@ -80,9 +76,7 @@ The Dozer component supports 8 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Dozer-UsingDataFormatswithDozer]] -Using Data Formats with Dozer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using Data Formats with Dozer Dozer does not support non-Java sources and targets for mappings, so it cannot, for example, map an XML document to a Java object on its own. @@ -116,9 +110,7 @@ using a JAXB data format and marshal the mapping output using Jackson. <endpoint uri="dozer:xml2json?marshalId=myjson&unmarshalId=myjaxb&targetModel=org.example.Order"/> ---------------------------------------------------------------------------------------------------------- -[[Dozer-ConfiguringDozer]] -Configuring Dozer -^^^^^^^^^^^^^^^^^ +### Configuring Dozer All Dozer endpoints require a Dozer mapping configuration file which defines mappings between source and target objects.  The component will @@ -141,17 +133,13 @@ of `org.apache.camel.converter.dozer.DozerBeanMapperConfiguration`. </bean> ------------------------------------------------------------------------------------------ -[[Dozer-MappingExtensions]] -Mapping Extensions -^^^^^^^^^^^^^^^^^^ +### Mapping Extensions The Dozer component implements a number of extensions to the Dozer mapping framework as custom converters.  These converters implement mapping functions that are not supported directly by Dozer itself. -[[Dozer-VariableMappings]] -Variable Mappings -+++++++++++++++++ +#### Variable Mappings Variable mappings allow you to map the value of a variable definition within a Dozer configuration into a target field instead of using the @@ -182,9 +170,7 @@ class into your target field of choice: </mappings> -------------------------------------------------------------------------------------------------------- -[[Dozer-CustomMappings]] -Custom Mappings -+++++++++++++++ +#### Custom Mappings Custom mappings allow you to define your own logic for how a source field is mapped to a target field.  They are similar in function to @@ -235,9 +221,7 @@ public class CustomMapper { </mappings> -------------------------------------------------------------------------------------------------------- -[[Dozer-ExpressionMappings]] -Expression Mappings -+++++++++++++++++++ +#### Expression Mappings Expression mappings allow you to use the powerful http://camel.apache.org/languages.html[language] capabilities of Camel @@ -273,5 +257,4 @@ An example of mapping a message header into a target field: Note that any properties within your expression must be escaped with "\" to prevent an error when Dozer attempts to resolve variable values -defined using the EL. - +defined using the EL. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-drill/src/main/docs/drill-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc index 4577c31..375aeb6 100644 --- a/components/camel-drill/src/main/docs/drill-component.adoc +++ b/components/camel-drill/src/main/docs/drill-component.adoc @@ -1,4 +1,4 @@ -# Drill Component +## Drill Component *Available as of Camel 2.18* @@ -19,9 +19,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Drill-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] -------------------------------- @@ -31,15 +29,11 @@ drill://host[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Drill-Producer]] -Drill Producer -^^^^^^^^^^^^^ +### Drill Producer The producer execute query using *CamelDrillQuery* header and put results into body. -[[Drill-Options]] -Options -^^^^^^^ +### Options // component options: START The Drill component has no options. @@ -64,12 +58,9 @@ The Drill component supports 6 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Drill-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/components/camel-dropbox/src/main/docs/dropbox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 5774154..950890e 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -1,4 +1,4 @@ -# Dropbox Component +## Dropbox Component *Available as of Camel 2.14* @@ -26,9 +26,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Dropbox-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------- @@ -38,9 +36,7 @@ dropbox://[operation]?[options] Where *operation* is the specific action (typically is a CRUD action) to perform on Dropbox remote folder. -[[Dropbox-Operations]] -Operations -^^^^^^^^^^ +### Operations [width="100%",cols="40%,60%",options="header",] |======================================================================= @@ -60,9 +56,7 @@ Operations *Operations* require additional options to work, some are mandatory for the specific operation. -[[Dropbox-Options]] -Options -^^^^^^^ +### Options In order to work with Dropbox API you need to obtain an *accessToken* and a *clientIdentifier.* + @@ -98,9 +92,7 @@ The Dropbox component supports 13 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Dropbox-Deloperation]] -Del operation -^^^^^^^^^^^^^ +### Del operation Delete files on Dropbox. @@ -115,9 +107,7 @@ Below are listed the options for this operation: |`remotePath` |`true` |Folder or file to delete on Dropbox |======================================================================= -[[Dropbox-Samples]] -Samples -+++++++ +#### Samples [source,java] ------------------------------- @@ -126,9 +116,7 @@ from("direct:start").to("dropbox://del?accessToken=XXX&clientIdentifier=XXX&remo from("direct:start").to("dropbox://del?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1/file1.tar.gz").to("mock:result"); ------------------------------- -[[Dropbox-ResultMessageHeaders]] -Result Message Headers -++++++++++++++++++++++ +#### Result Message Headers The following headers are set on message result: @@ -139,9 +127,7 @@ The following headers are set on message result: |`DELETED_PATH` |name of the path deleted on dropbox |======================================================================= -[[Dropbox-ResultMessageBody]] -Result Message Body -+++++++++++++++++++ +#### Result Message Body The following objects are set on message body result: @@ -152,9 +138,7 @@ The following objects are set on message body result: |`String` |name of the path deleted on dropbox |======================================================================= -[[Dropbox-Getoperation]] -Get (download) operation -^^^^^^^^^^^^^^^^^^^^^^^^ +### Get (download) operation Download files from Dropbox. @@ -169,9 +153,7 @@ Below are listed the options for this operation: |`remotePath` |`true` |Folder or file to download from Dropbox |======================================================================= -[[Dropbox-Samples.1]] -Samples -+++++++ +#### Samples [source,java] ------------------------------- @@ -182,9 +164,7 @@ from("direct:start").to("dropbox://get?accessToken=XXX&clientIdentifier=XXX&remo from("dropbox://get?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1").to("file:///home/kermit/"); ------------------------------- -[[Dropbox-ResultMessageHeaders.1]] -Result Message Headers -++++++++++++++++++++++ +#### Result Message Headers The following headers are set on message result: @@ -197,9 +177,7 @@ The following headers are set on message result: |`DOWNLOADED_FILES` |in case of multiple files download, path of the remote files downloaded |======================================================================= -[[Dropbox-ResultMessageBody.1]] -Result Message Body -+++++++++++++++++++ +#### Result Message Body The following objects are set on message body result: @@ -214,9 +192,7 @@ remote file downloaded and as value the stream representing the file downloaded |======================================================================= -[[Dropbox-Moveoperation]] -Move operation -^^^^^^^^^^^^^^ +### Move operation Move files on Dropbox between one folder to another. @@ -233,18 +209,14 @@ Below are listed the options for this operation: |`newRemotePath` |`true` |Destination file or folder |======================================================================= -[[Dropbox-Samples.2]] -Samples -+++++++ +#### Samples [source,java] ------------------------------- from("direct:start").to("dropbox://move?accessToken=XXX&clientIdentifier=XXX&remotePath=/root/folder1&newRemotePath=/root/folder2").to("mock:result"); ------------------------------- -[[Dropbox-ResultMessageHeaders.2]] -Result Message Headers -++++++++++++++++++++++ +#### Result Message Headers The following headers are set on message result: @@ -255,9 +227,7 @@ The following headers are set on message result: |`MOVED_PATH` |name of the path moved on dropbox |======================================================================= -[[Dropbox-ResultMessageBody.2]] -Result Message Body -+++++++++++++++++++ +#### Result Message Body The following objects are set on message body result: @@ -268,9 +238,7 @@ The following objects are set on message body result: |`String` |name of the path moved on dropbox |======================================================================= -[[Dropbox-Putoperation]] -Put (upload) operation -^^^^^^^^^^^^^^^^^^^^^^ +### Put (upload) operation Upload files on Dropbox. @@ -293,9 +261,7 @@ dropbox, this will be overwritten. will upload the file on a remote path equal to the local path. |======================================================================= -[[Dropbox-Samples.3]] -Samples -+++++++ +#### Samples [source,java] ------------------------------- @@ -304,9 +270,7 @@ from("direct:start").to("dropbox://put?accessToken=XXX&clientIdentifier=XXX&uplo from("direct:start").to("dropbox://put?accessToken=XXX&clientIdentifier=XXX&uploadMode=add&localPath=/root/folder1&remotePath=/root/folder2").to("mock:result"); ------------------------------- -[[Dropbox-ResultMessageHeaders.3]] -Result Message Headers -++++++++++++++++++++++ +#### Result Message Headers The following headers are set on message result: @@ -319,9 +283,7 @@ The following headers are set on message result: |`UPLOADED_FILES` |in case of multiple files upload, string with the remote paths uploaded |======================================================================= -[[Dropbox-ResultMessageBody.3]] -Result Message Body -+++++++++++++++++++ +#### Result Message Body The following objects are set on message body result: @@ -336,9 +298,7 @@ remote file uploaded and as value the result of the upload operation, OK or KO |======================================================================= -[[Dropbox-Searchoperation]] -Search operation -^^^^^^^^^^^^^^^^ +### Search operation Search inside a remote Dropbox folder including its sub directories. @@ -357,9 +317,7 @@ if it contains all the sub-strings. If this option is not set, all files will be matched. |======================================================================= -[[Dropbox-Samples.4]] -Samples -+++++++ +#### Samples [source,java] ------------------------------- @@ -368,9 +326,7 @@ from("dropbox://search?accessToken=XXX&clientIdentifier=XXX&remotePath=/XXX&quer from("direct:start").to("dropbox://search?accessToken=XXX&clientIdentifier=XXX&remotePath=/XXX").to("mock:result"); ------------------------------- -[[Dropbox-ResultMessageHeaders.4]] -Result Message Headers -++++++++++++++++++++++ +#### Result Message Headers The following headers are set on message result: @@ -381,9 +337,7 @@ The following headers are set on message result: |`FOUNDED_FILES` |list of file path founded |======================================================================= -[[Dropbox-ResultMessageBody.4]] -Result Message Body -+++++++++++++++++++ +#### Result Message Body The following objects are set on message body result: @@ -397,4 +351,4 @@ Dropbox documentation, link:http://dropbox.github.io/dropbox-sdk-java/api-docs/v1.7.x/com/dropbox/core/DbxEntry.html[http://dropbox.github.io/dropbox-sdk-java/api-docs/v1.7.x/com/dropbox/core/DbxEntry.html] - + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ehcache/src/main/docs/ehcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc index 6292610..5cec94a 100644 --- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc +++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc @@ -1,4 +1,4 @@ -# Ehcache Component +## Ehcache Component *Available as of Camel 2.18.x* @@ -23,9 +23,7 @@ their `pom.xml` for this component: </dependency> ------------------------------------------------------------ -[[Ehcache-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -35,9 +33,7 @@ ehcache://cacheName[?options] You can append query options to the URI in the following format, `?option=value&option=#beanRef&...` -[[Ehcache-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -74,9 +70,7 @@ The Ehcache component supports 16 endpoint options which are listed below: // endpoint options: END -[[Ehcache-MessageHeadersCamel]] -Message Headers Camel -++++++++++++++++++++++ +#### Message Headers Camel  [width="100%",cols="10%,10%,80%",options="header",] @@ -115,9 +109,7 @@ Object used for comparison for actions like REPLACE |CamelEhcacheEventType |EventType |The type of event received |======================================================================= -[[Ehcache-Ehcachebasedidempotentrepositoryexample:]] -Ehcache based idempotent repository example: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Ehcache based idempotent repository example: [source,java] ------------------------------------------------------------------------------------------------ @@ -131,9 +123,7 @@ from("direct:in")  -[[Ehcache-Ehcachebasedaggregationrepositoryexample:]] -Ehcache based aggregation repository example: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Ehcache based aggregation repository example: [source,java] --------------------------------------------------------------------------------------------------------------------------------- @@ -204,4 +194,4 @@ public class EhcacheAggregationRepositoryRoutesTest extends CamelTestSupport { return repository; } } ---------------------------------------------------------------------------------------------------------------------------------- +--------------------------------------------------------------------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ejb/src/main/docs/ejb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc index fb5059d..e807a0a 100644 --- a/components/camel-ejb/src/main/docs/ejb-component.adoc +++ b/components/camel-ejb/src/main/docs/ejb-component.adoc @@ -1,4 +1,4 @@ -# EJB Component +## EJB Component *Available as of Camel 2.4* @@ -17,9 +17,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[EJB-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------- @@ -29,9 +27,7 @@ ejb:ejbName[?options] Where *ejbName* can be any string which is used to look up the EJB in the Application Server JNDI link:registry.html[Registry] -[[EJB-Options]] -Options -^^^^^^^ +### Options @@ -71,9 +67,7 @@ The EJB component supports 6 endpoint options which are listed below: // endpoint options: END -[[EJB-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 @@ -82,9 +76,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. -[[EJB-Examples]] -Examples -^^^^^^^^ +### Examples In the following examples we use the Greater EJB which is defined as follows: @@ -122,9 +114,7 @@ public class GreaterImpl implements GreaterLocal { } ------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[EJB-UsingJavaDSL]] -Using Java DSL -++++++++++++++ +#### Using Java DSL In this example we want to invoke the `hello` method on the EJB. Since this example is based on an unit test using Apache OpenEJB we have to @@ -172,9 +162,7 @@ usually allows it to access the JNDI registry and lookup the link:ejb.html[EJB]s. However if you need to access a application server on a remote JVM or the likes, you have to prepare the properties beforehand. -[[EJB-UsingSpringXML]] -Using Spring XML -++++++++++++++++ +#### Using Spring XML And this is the same example using Spring XML instead: @@ -207,9 +195,7 @@ Before we are ready to use link:ejb.html[EJB] in the Camel routes: </camelContext> ------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[EJB-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -217,5 +203,4 @@ See Also * link:getting-started.html[Getting Started] * 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/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc index c7bbc39..650f41e 100644 --- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc +++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc @@ -1,4 +1,4 @@ -# Elasticsearch Component +## Elasticsearch Component *Available as of Camel 2.11* @@ -18,9 +18,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[ElasticSearch-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------- @@ -38,9 +36,7 @@ guide] for more details. ==== -[[ElasticSearch-EndpointOptions]] -Endpoint Options -^^^^^^^^^^^^^^^^ +### Endpoint Options @@ -87,9 +83,7 @@ The Elasticsearch component supports 12 endpoint options which are listed below: -[[ElasticSearch-MessageOperations]] -Message Operations -^^^^^^^^^^^^^^^^^^ +### Message Operations The following ElasticSearch operations are currently supported. Simply set an endpoint URI option or exchange header with a key of "operation" @@ -131,9 +125,7 @@ returns a MultiSearchResponse object in the body indexId in the body. |======================================================================= -[[ElasticSearch-IndexExample]] -Index Example -^^^^^^^^^^^^^ +### Index Example Below is a simple INDEX example @@ -161,21 +153,16 @@ map.put("content", "test"); String indexId = template.requestBody("direct:index", map, String.class); ------------------------------------------------------------------------- -[[ElasticSearch-Formoreinformation,seetheseresources]] -For more information, see these resources -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### For more information, see these resources http://elasticsearch.org[ElasticSearch Main Site] http://www.elasticsearch.org/guide/reference/java-api/[ElasticSearch Java API] -[[ElasticSearch-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/components/camel-elsql/src/main/docs/elsql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc index 035ff86..9d5582d 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -1,4 +1,4 @@ -# ElSQL Component +## ElSQL Component *Available as of Camel 2.16* @@ -49,9 +49,7 @@ expression. If a named parameter cannot be resolved, then an exception is thrown. -[[ElSql-Options]] -Options -^^^^^^^ +### Options // component options: START The ElSQL component supports 4 options which are listed below. @@ -129,9 +127,7 @@ The ElSQL component supports 48 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[ElSql-Resultofthequery]] -Result of the query -^^^^^^^^^^^^^^^^^^^ +### Result of the query For `select` operations, the result is an instance of `List<Map<String, Object>>` type, as returned by the @@ -145,9 +141,7 @@ headers, it provides a concise syntax for querying a sequence or some other small value into a header. It is convenient to use outputHeader and outputType together: -[[ElSql-Headervalues]] -Header values -^^^^^^^^^^^^^ +### Header values When performing `update` operations, the SQL Component stores the update count in the following message headers: @@ -163,9 +157,7 @@ count in the following message headers: `Integer` object. |======================================================================= -[[ElSql-Sample]] -Sample -++++++ +#### Sample In the given route below, we want to get all the projects from the projects table. Notice the SQL query has 2 named parameters, :#lic and @@ -217,9 +209,7 @@ assumes to have `getLicense` and `getMinimum` methods: ORDER BY id ------------------------------------------------------------ -[[ElSql-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -228,5 +218,4 @@ See Also * link:sql-component.html[SQL Component] * link:mybatis.html[MyBatis] -* link:jdbc.html[JDBC] - +* link:jdbc.html[JDBC] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-etcd/src/main/docs/etcd-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-etcd/src/main/docs/etcd-component.adoc b/components/camel-etcd/src/main/docs/etcd-component.adoc index b5eb922..a76c186 100644 --- a/components/camel-etcd/src/main/docs/etcd-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-component.adoc @@ -1,4 +1,4 @@ -# etcd Component +## etcd Component +[[Etcd-Etcd]] +Etcd @@ -70,6 +70,4 @@ The etcd component supports 31 endpoint options which are listed below: // component options: START The etcd component has no options. -// component options: END - - +// component options: END \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc index 9f67187..b056b18 100644 --- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc +++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc @@ -1,13 +1,11 @@ -# OSGi EventAdmin Component +## OSGi EventAdmin Component *Available in Camel 2.6* The `eventadmin` component can be used in an OSGi environment to receive OSGi EventAdmin events and process them. -[[EventAdmin-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users need to add the following dependency to their `pom.xml` @@ -23,9 +21,7 @@ Maven users need to add the following dependency to their `pom.xml` where `${camel-version`} must be replaced by the actual version of Camel (2.6.0 or higher). -[[EventAdmin-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,xml] -------------------------- @@ -34,9 +30,7 @@ eventadmin:topic[?options] where `topic` is the name of the topic to listen too. -[[EventAdmin-URIoptions]] -URI options -^^^^^^^^^^^ +### URI options // component options: START The OSGi EventAdmin component supports 1 options which are listed below. @@ -69,24 +63,18 @@ The OSGi EventAdmin component supports 6 endpoint options which are listed below {% endraw %} // endpoint options: END -[[EventAdmin-Messageheaders]] -Message headers -^^^^^^^^^^^^^^^ +### Message headers [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Name |Type |Message |Description |======================================================================= -[[EventAdmin-Messagebody]] -Message body -^^^^^^^^^^^^ +### Message body The `in` message body will be set to the received Event. -[[EventAdmin-Exampleusage]] -Example usage -^^^^^^^^^^^^^ +### Example usage [source,xml] ------------------------------ @@ -94,4 +82,4 @@ Example usage <from uri="eventadmin:*"/> <to uri="stream:out"/> </route> ------------------------------- +------------------------------ \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-exec/src/main/docs/exec-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-exec/src/main/docs/exec-component.adoc b/components/camel-exec/src/main/docs/exec-component.adoc index ef9533f..9024ad2 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -1,12 +1,10 @@ -# Exec Component +## Exec Component *Available in Camel 2.3* The `exec` component can be used to execute system commands. -[[Exec-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users need to add the following dependency to their `pom.xml` @@ -22,9 +20,7 @@ Maven users need to add the following dependency to their `pom.xml` where `${camel-version`} must be replaced by the actual version of Camel (2.3.0 or higher). -[[Exec-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,xml] --------------------------- @@ -35,9 +31,7 @@ where `executable` is the name, or file path, of the system command that will be executed. If executable name is used (e.g. `exec:java`), the executable must in the system path. -[[Exec-URIoptions]] -URI options -^^^^^^^^^^^ +### URI options // component options: START The Exec component has no options. @@ -63,9 +57,7 @@ The Exec component supports 9 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Exec-Messageheaders]] -Message headers -^^^^^^^^^^^^^^^ +### Message headers The supported headers are defined in `org.apache.camel.component.exec.ExecBinding`. @@ -107,9 +99,7 @@ Camel Message Body with `stderr`. This behavior is disabled (`false`) by default. |======================================================================= -[[Exec-Messagebody]] -Message body -^^^^^^^^^^^^ +### Message body If the `Exec` component receives an `in` message body that is convertible to `java.io.InputStream`, it is used to feed input to the @@ -141,13 +131,9 @@ this component will convert the stdout of the process to the target type. For more details, please refer to the link:exec.html[usage examples] below. -[[Exec-Usageexamples]] -Usage examples -^^^^^^^^^^^^^^ +### Usage examples -[[Exec-Executingwordcount]] -Executing word count (Linux) -++++++++++++++++++++++++++++ +#### Executing word count (Linux) The example below executes `wc` (word count, Linux) to count the words in file `/usr/share/dict/words`. The word count (output) is written to @@ -169,9 +155,7 @@ from("direct:exec") }); -------------------------------------------------------------------------------------- -[[Exec-Executingjava]] -Executing `java` -++++++++++++++++ +#### Executing `java` The example below executes `java` with 2 arguments: `-server` and `-version`, provided that `java` is in the system path. @@ -191,9 +175,7 @@ from("direct:exec") .to("exec:c:/program files/jdk/bin/java?args=-server -version -Duser.name=Camel&workingDir=c:/temp") ---------------------------------------------------------------------------------------------------- -[[Exec-ExecutingAntscripts]] -Executing Ant scripts -+++++++++++++++++++++ +#### Executing Ant scripts The following example executes http://ant.apache.org/[Apache Ant] (Windows only) with the build file `CamelExecBuildFile.xml`, provided @@ -225,9 +207,7 @@ from("direct:exec") }); ------------------------------------------------------------------------------------------------------- -[[Exec-Executingecho]] -Executing `echo` (Windows) -++++++++++++++++++++++++++ +#### Executing `echo` (Windows) Commands such as `echo` and `dir` can be executed only with the command interpreter of the operating system. This example shows how to execute @@ -238,12 +218,9 @@ such a command - `echo` - in Windows. from("direct:exec").to("exec:cmd?args=/C echo echoString") ---------------------------------------------------------- -[[Exec-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/components/camel-facebook/src/main/docs/facebook-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index b22f442..e082551 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -1,4 +1,4 @@ -# Facebook Component +## Facebook Component *Available as of Camel 2.12* @@ -32,18 +32,14 @@ for this component: </dependency> ----------------------------------------------- -[[Facebook-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------- facebook://[endpoint]?[options] --------------------------------- -[[Facebook-FacebookComponent.1]] -FacebookComponent -^^^^^^^^^^^^^^^^^ +### FacebookComponent The facebook component can be configured with the Facebook account settings below, which are mandatory. The values can be provided to the @@ -188,9 +184,7 @@ The Facebook component supports 103 endpoint options which are listed below: // endpoint options: END -[[Facebook-ProducerEndpoints:]] -Producer Endpoints: -^^^^^^^^^^^^^^^^^^^ +### Producer Endpoints: Producer endpoints can use endpoint names and options from the table below. Endpoints can also use the short name without the *get* or @@ -224,9 +218,7 @@ return a boolean, return true for success and false otherwise. In case of Facebook API errors the endpoint will throw a RuntimeCamelException with a facebook4j.FacebookException cause. -[[Facebook-ConsumerEndpoints:]] -Consumer Endpoints: -^^^^^^^^^^^^^^^^^^^ +### Consumer Endpoints: Any of the producer endpoints that take a https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=reading&linkCreation=true&fromPageId=34020899[reading#reading] @@ -241,9 +233,7 @@ camel-facebook creates one route exchange per returned object. As an example, if *"facebook://home"* results in five posts, the route will be executed five times (once for each Post). -[[Facebook-ReadingOptions]] -Reading Options -^^^^^^^^^^^^^^^ +### Reading Options The *reading* option of type *facebook4j.Reading* adds support for reading parameters, which allow selecting specific fields, limits the @@ -261,18 +251,14 @@ The reading option can be a reference or value of type options in either the endpoint URI or exchange header with *CamelFacebook.* prefix. -[[Facebook-Messageheader]] -Message header -^^^^^^^^^^^^^^ +### Message header Any of the https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=URI+options&linkCreation=true&fromPageId=34020899[URI options#urioptions] can be provided in a message header for producer endpoints with *CamelFacebook.* prefix. -[[Facebook-Messagebody]] -Message body -^^^^^^^^^^^^ +### Message body All result message bodies utilize objects provided by the Facebook4J API. Producer endpoints can specify the option name for incoming message @@ -282,9 +268,7 @@ For endpoints that return an array, or *facebook4j.ResponseList*, or *java.util.List*, a consumer endpoint will map every elements in the list to distinct messages. -[[Facebook-Usecases]] -Use cases -^^^^^^^^^ +### Use cases To create a post within your Facebook profile, send this producer a facebook4j.PostUpdate body. @@ -316,4 +300,4 @@ CamelFacebook.query header. from("direct:foo") .setHeader("CamelFacebook.query", header("bar")) .to("facebook://posts"); --------------------------------------------------------- +-------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-flatpack/src/main/docs/flatpack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-component.adoc b/components/camel-flatpack/src/main/docs/flatpack-component.adoc index ca73ca4..9d0e5d4 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -1,4 +1,4 @@ -# Flatpack Component +## Flatpack Component The Flatpack component supports fixed width and delimited file parsing via the http://flatpack.sourceforge.net[FlatPack library]. + @@ -19,9 +19,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Flatpack-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------------------- @@ -38,9 +36,7 @@ flatpack:someName[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Flatpack-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The Flatpack component has no options. @@ -84,9 +80,7 @@ The Flatpack component supports 27 endpoint options which are listed below: {% endraw %} // endpoint options: END -[[Flatpack-Examples]] -Examples -^^^^^^^^ +### Examples * `flatpack:fixed:foo.pzmap.xml` creates a fixed-width endpoint using the `foo.pzmap.xml` file configuration. @@ -95,9 +89,7 @@ the `foo.pzmap.xml` file configuration. * `flatpack:foo` creates a delimited endpoint called `foo` with no file configuration. -[[Flatpack-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel will store the following headers on the IN message: @@ -109,9 +101,7 @@ Camel will store the following headers on the IN message: number of rows. |======================================================================= -[[Flatpack-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body The component delivers the data in the IN message as a `org.apache.camel.component.flatpack.DataSetList` object that has @@ -140,9 +130,7 @@ However, you can also always get it as a `List` (even for String firstName = row.get("FIRSTNAME"); --------------------------------------------------- -[[Flatpack-HeaderandTrailerrecords]] -Header and Trailer records -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Header and Trailer records The header and trailer notions in Flatpack are supported. However, you *must* use fixed record IDs: @@ -173,9 +161,7 @@ trailer. You can omit one or both of them if not needed. </RECORD> --------------------------------------------------------------------------- -[[Flatpack-Usingtheendpoint]] -Using the endpoint -^^^^^^^^^^^^^^^^^^ +### Using the endpoint A common use case is sending a file to this endpoint for further processing in a separate route. For example: @@ -198,9 +184,7 @@ processing in a separate route. For example: You can also convert the payload of each message created to a `Map` for easy link:bean-integration.html[Bean Integration] -[[Flatpack-FlatpackDataFormat]] -Flatpack DataFormat -~~~~~~~~~~~~~~~~~~~ +### Flatpack DataFormat The link:flatpack.html[Flatpack] component ships with the Flatpack data format that can be used to format between fixed width or delimited text @@ -218,9 +202,7 @@ link:splitter.html[Splitter]. *Notice:* The Flatpack library does currently not support header and trailers for the marshal operation. -[[Flatpack-Options]] -Options -^^^^^^^ +### Options The data format has the following options: @@ -249,9 +231,7 @@ expected and ignores the extra characters. expected and ignores the extra characters. |======================================================================= -[[Flatpack-Usage]] -Usage -^^^^^ +### Usage To use the data format, simply instantiate an instance and invoke the marshal or unmarshal operation in the route builder: @@ -286,9 +266,7 @@ in Java code from e.g. a processor. We marshal the data according to the Flatpack format and convert the result as a `String` object and store it on a JMS queue. -[[Flatpack-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Flatpack in your camel routes you need to add the a dependency on *camel-flatpack* which implements this data format. @@ -306,12 +284,9 @@ link:download.html[the download page for the latest versions]). </dependency> ----------------------------------------- -[[Flatpack-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/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc index 57c7909..e9fcb6c 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc @@ -1,4 +1,4 @@ -# Flatpack DataFormat +## Flatpack DataFormat The link:flatpack.html[Flatpack] component ships with the Flatpack data format that can be used to format between fixed width or delimited text @@ -16,9 +16,7 @@ link:splitter.html[Splitter]. *Notice:* The Flatpack library does currently not support header and trailers for the marshal operation. -[[FlatpackDataFormat-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The Flatpack dataformat supports 9 options which are listed below. @@ -42,9 +40,7 @@ The Flatpack dataformat supports 9 options which are listed below. {% endraw %} // dataformat options: END -[[FlatpackDataFormat-Usage]] -Usage -^^^^^ +### Usage To use the data format, simply instantiate an instance and invoke the marshal or unmarshal operation in the route builder: @@ -79,9 +75,7 @@ in Java code from e.g. a processor. We marshal the data according to the Flatpack format and convert the result as a `String` object and store it on a JMS queue. -[[FlatpackDataFormat-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Flatpack in your camel routes you need to add the a dependency on *camel-flatpack* which implements this data format. @@ -97,4 +91,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-flatpack</artifactId> <version>x.x.x</version> </dependency> ------------------------------------------ +----------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-flink/src/main/docs/flink-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc index 03d0404..61b0218 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -1,4 +1,4 @@ -# Apache Flink Component +## Apache Flink Component *Available as of Camel 2.18* @@ -23,9 +23,7 @@ their `pom.xml` for this component: </dependency> ------------------------------------------------------------ -[[camel-flink-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format Currently, the Flink Component supports only Producers. One can create DataSet, DataStream jobs. @@ -60,9 +58,7 @@ The Apache Flink component supports 7 endpoint options which are listed below: -[[Flink-FlinkComponentOptions]] -FlinkComponent Options -^^^^^^^^^^^^^^^^^^^^ +### FlinkComponent Options @@ -88,8 +84,7 @@ The Apache Flink component supports 4 options which are listed below. -Flink DataSet Callback -^^^^^^^^^^^^^^^^^^^^^^ +### Flink DataSet Callback [source,java] ----------------------------------- @@ -108,8 +103,7 @@ public DataSetCallback<Long> dataSetCallback() { } ----------------------------------- -Flink DataStream Callback -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Flink DataStream Callback [source,java] --------------------------- @@ -126,8 +120,7 @@ public VoidDataStreamCallback dataStreamCallback() { } --------------------------- -Camel-Flink Producer call -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Camel-Flink Producer call [source,java] ----------------------------------- @@ -144,11 +137,9 @@ try { } ----------------------------------- -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/components/camel-fop/src/main/docs/fop-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc index c005633..74cc968 100644 --- a/components/camel-fop/src/main/docs/fop-component.adoc +++ b/components/camel-fop/src/main/docs/fop-component.adoc @@ -1,4 +1,4 @@ -# FOP Component +## FOP Component *Available as of Camel 2.10* @@ -18,18 +18,14 @@ for this component: </dependency> ------------------------------------------------------------ -[[FOP-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------- fop://outputFormat?[options] ---------------------------- -[[FOP-OutputFormats]] -Output Formats -^^^^^^^^^^^^^^ +### Output Formats The primary output format is PDF but other output http://xmlgraphics.apache.org/fop/0.95/output.html[formats] are also @@ -63,9 +59,7 @@ supported: The complete list of valid output formats can be found http://svn.apache.org/repos/asf/xmlgraphics/commons/trunk/src/java/org/apache/xmlgraphics/util/MimeConstants.java[here] -[[FOP-EndpointOptions]] -Endpoint Options -^^^^^^^^^^^^^^^^ +### Endpoint Options // component options: START The FOP component has no options. @@ -103,9 +97,7 @@ fopFactory Allows to use a custom configured or implementation of `org.apache.fop.apps.FopFactory`. -[[FOP-MessageOperations]] -Message Operations -^^^^^^^^^^^^^^^^^^ +### Message Operations [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -140,9 +132,7 @@ Message Operations |CamelFop.Render.keywords | | Set of keywords applicable to this document |======================================================================= -[[FOP-Example]] -Example -^^^^^^^ +### Example Below is an example route that renders PDFs from xml data and xslt template and saves the PDF files in target folder: @@ -157,12 +147,9 @@ from("file:source/data/xml") For more information, see these resources... -[[FOP-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/components/camel-freemarker/src/main/docs/freemarker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc index 931104c..2f2d55e 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -1,4 +1,4 @@ -# Freemarker Component +## Freemarker Component The *freemarker:* component allows for processing a message using a http://freemarker.org/[FreeMarker] template. This can be ideal when @@ -17,9 +17,7 @@ for this component: </dependency> ------------------------------------------------------------------------------------- -[[FreeMarker-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------- @@ -33,9 +31,7 @@ file://folder/myfile.ftl[file://folder/myfile.ftl]). You can append query options to the URI in the following format, `?option=value&option=value&...` -[[FreeMarker-Options]] -Options -^^^^^^^ +### Options @@ -77,9 +73,7 @@ The Freemarker component supports 6 endpoint options which are listed below: -[[FreeMarker-Headers]] -Headers -^^^^^^^ +### Headers Headers set during the FreeMarker evaluation are returned to the message and added as headers. This provides a mechanism for the FreeMarker @@ -94,9 +88,7 @@ ${request.setHeader('fruit', 'Apple')} The header, `fruit`, is now accessible from the `message.out.headers`. -[[FreeMarker-FreeMarkerContext]] -FreeMarker Context -^^^^^^^^^^^^^^^^^^ +### FreeMarker Context Camel will provide exchange information in the FreeMarker context (just a `Map`). The `Exchange` is transferred as: @@ -132,18 +124,14 @@ variableMap.put("exchange", exchange); exchange.getIn().setHeader("CamelFreemarkerDataModel", variableMap); -------------------------------------------------------------------- -[[FreeMarker-Hotreloading]] -Hot reloading -^^^^^^^^^^^^^ +### Hot reloading The FreeMarker template resource is by default *not* hot reloadable for both file and classpath resources (expanded jar). If you set `contentCache=false`, then Camel will not cache the resource and hot reloading is thus enabled. This scenario can be used in development. -[[FreeMarker-Dynamictemplates]] -Dynamic templates -^^^^^^^^^^^^^^^^^ +### Dynamic templates Camel provides two headers by which you can define a different resource location for a template or the template content itself. If any of these @@ -162,9 +150,7 @@ configured. | >= 2.1 |FreemarkerConstants.FREEMARKER_TEMPLATE |String |The template to use instead of the endpoint configured. | >= 2.1 |======================================================================= -[[FreeMarker-Samples]] -Samples -^^^^^^^ +### Samples For example you could use something like: @@ -216,9 +202,7 @@ from("direct:in"). to("freemarker:dummy"); --------------------------------------------------------------------------------------------- -[[FreeMarker-TheEmailSample]] -The Email Sample -^^^^^^^^^^^^^^^^ +### The Email Sample In this sample we want to use FreeMarker templating for an order confirmation email. The email template is laid out in FreeMarker as: @@ -235,12 +219,9 @@ ${body} And the java code: -[[FreeMarker-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/components/camel-ftp/src/main/docs/ftp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 2d70f23..502eb94 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -1,4 +1,4 @@ -# FTP Component +## FTP Component This component provides access to remote file systems over the FTP and SFTP protocols. @@ -46,9 +46,7 @@ further below for details related to consuming files. ==== -[[FTP2-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------------------- @@ -89,9 +87,7 @@ The FTPS component is only available in Camel 2.2 or newer. + support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols. -[[FTP2-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The options below are exclusive for the FTP component. @@ -304,9 +300,7 @@ url. from("ftp://foo@myserver?password=secret&ftpClientConfig=#myConfig";).to("bean:foo"); ------------------------------------------------------------------------------------ -[[FTP2-MoreURIoptions]] -More URI options -^^^^^^^^^^^^^^^^ +### More URI options [Info] ==== @@ -317,9 +311,7 @@ this component. ==== -[[FTP2-Examples]] -Examples -^^^^^^^^ +### Examples `ftp://some...@someftpserver.com/public/upload/images/holiday2008?password=secret&binary=true` + @@ -349,9 +341,7 @@ component page. ==== -[[FTP2-Defaultwhenconsumingfiles]] -Default when consuming files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Default when consuming files The link:ftp2.html[FTP] consumer will by default leave the consumed files untouched on the remote FTP server. You have to configure it @@ -364,9 +354,7 @@ default move files to a `.camel` sub directory. The reason Camel does *not* do this by default for the FTP consumer is that it may lack permissions by default to be able to move or delete files. -[[FTP2-limitations]] -limitations -+++++++++++ +#### limitations The option *readLock* can be used to force Camel *not* to consume files that is currently in the progress of being written. However, this option @@ -382,9 +370,7 @@ restricted to the FTP_ROOT folder. That prevents you from moving files outside the FTP area. If you want to move files to another area you can use soft links and move files into a soft linked folder. -[[FTP2-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following message headers can be used to affect the behavior of the component @@ -423,9 +409,7 @@ In addition the FTP/FTPS consumer and producer will enrich the Camel |`CamelFtpReplyString` | *Camel 2.11.1:* The FTP client reply string |======================================================================= -[[FTP2-Abouttimeouts]] -About timeouts -^^^^^^^^^^^^^^ +### About timeouts The two set of libraries (see top) has different API for setting timeout. You can use the `connectTimeout` option for both of them to set @@ -436,9 +420,7 @@ a timeout in millis to establish a network connection. An individual for FTP/FTSP as the data timeout, which corresponds to the `ftpClient.dataTimeout` value. All timeout values are in millis. -[[FTP2-UsingLocalWorkDirectory]] -Using Local Work Directory -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using Local Work Directory Camel supports consuming from remote FTP servers and downloading the files directly into a local work directory. This avoids reading the @@ -474,9 +456,7 @@ copy, as the work file is meant to be deleted anyway. ==== -[[FTP2-Stepwisechangingdirectories]] -Stepwise changing directories -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Stepwise changing directories Camel link:ftp2.html[FTP] can operate in two modes in terms of traversing directories when consuming files (eg downloading) or @@ -518,9 +498,7 @@ FTP server we need to traverse and download files: And that we have a file in each of sub-a (a.txt) and sub-b (b.txt) folder. -[[FTP2-Usingstepwise]] -Using stepwise=true (default mode) -++++++++++++++++++++++++++++++++++ +#### Using stepwise=true (default mode) [source,java] ---------------------------------------------------------- @@ -610,9 +588,7 @@ disconnected. As you can see when stepwise is enabled, it will traverse the directory structure using CD xxx. -[[FTP2-Notusingstepwise]] -Using stepwise=false -++++++++++++++++++++ +#### Using stepwise=false [source,java] ------------------------------------------- @@ -659,9 +635,7 @@ disconnected. As you can see when not using stepwise, there are no CD operation invoked at all. -[[FTP2-Samples]] -Samples -^^^^^^^ +### Samples In the sample below we set up Camel to download all the reports from the FTP server once every hour (60 min) as BINARY content and store it as @@ -677,9 +651,7 @@ And the route using Spring DSL: </route> ------------------------------------------------------------------------------------------------------ -[[FTP2-ConsumingaremoteFTPSserverimplicitSSLandclientauthentication]] -Consuming a remote FTPS server (implicit SSL) and client authentication -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Consuming a remote FTPS server (implicit SSL) and client authentication [source,java] -------------------------------------------------------------------------------------------------- @@ -689,9 +661,7 @@ from("ftps://admin@localhost:2222/public/camel?password=admin&securityProtocol=S .to("bean:foo"); -------------------------------------------------------------------------------------------------- -[[FTP2-ConsumingaremoteFTPSserverexplicitTLSandacustomtruststoreconfiguration]] -Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration [source,java] ---------------------------------------------------------------------------------------------------------------------------------------------------------------- @@ -699,9 +669,7 @@ from("ftps://admin@localhost:2222/public/camel?password=admin&ftpClient.trustSto .to("bean:foo"); ---------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[FTP2-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. This strategy it to use the build in `org.apache.camel.component.file.GenericFileFilter` in @@ -726,9 +694,7 @@ spring XML file: </route> --------------------------------------------------------------------------------------- -[[FTP2-FilteringusingANTpathmatcher]] -Filtering using ANT path matcher -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Filtering using ANT path matcher The ANT path matcher is a filter that is shipped out-of-the-box in the *camel-spring* jar. So you need to depend on *camel-spring* if you are @@ -745,9 +711,7 @@ The file paths are matched with the following rules: The sample below demonstrates how to use it: -[[FTP2-UsingaproxywithSFTP]] -Using a proxy with SFTP -^^^^^^^^^^^^^^^^^^^^^^^ +### Using a proxy with SFTP To use an HTTP proxy to connect to your remote host, you can configure your route in the following way: @@ -770,9 +734,7 @@ You can also assign a user name and password to the proxy, if necessary. Please consult the documentation for `com.jcraft.jsch.Proxy` to discover all options. -[[FTP2-SettingpreferredSFTPauthenticationmethod]] -Setting preferred SFTP authentication method -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Setting preferred SFTP authentication method If you want to explicitly specify the list of authentication methods that should be used by `sftp` component, use `preferredAuthentications` @@ -787,9 +749,7 @@ from("sftp://localhost:9999/root?username=admin&password=admin&preferredAuthenti to("bean:processFile"); ------------------------------------------------------------------------------------------------------------- -[[FTP2-Consumingasinglefileusingafixedname]] -Consuming a single file using a fixed name -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Consuming a single file using a fixed name When you want to download a single file and knows the file name, you can use `fileName=myFileName.txt` to tell Camel the name of the file to @@ -824,21 +784,16 @@ single file (if it exists) and grab the file content as a String type: String data = template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true";, String.class); ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[FTP2-Debuglogging]] -Debug logging -^^^^^^^^^^^^^ +### Debug logging This component has log level *TRACE* that can be helpful if you have problems. -[[FTP2-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:file2.html[File2] - +* link:file2.html[File2] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ftp/src/main/docs/ftps-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index e8b325b..946f961 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -1,4 +1,4 @@ -# FTPS Component +## FTPS Component This component provides access to remote file systems over the FTP and SFTP protocols. @@ -18,9 +18,7 @@ for this component: For more information you can look at link:ftp.html[FTP component] -[[FTPS-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The options below are exclusive for the FTPS component. @@ -151,5 +149,4 @@ The FTPS component supports 113 endpoint options which are listed below: | username | security | | String | Username to use for login |======================================================================= {% endraw %} -// endpoint options: END - +// endpoint options: END \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ftp/src/main/docs/sftp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index 3147a51..6d052c7 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -1,4 +1,4 @@ -# SFTP Component +## SFTP Component This component provides access to remote file systems over the FTP and SFTP protocols. @@ -18,9 +18,7 @@ for this component: For more information you can look at link:ftp.html[FTP component] -[[SFTP-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The options below are exclusive for the FTPS component. @@ -150,4 +148,4 @@ The SFTP component supports 112 endpoint options which are listed below: | useUserKnownHostsFile | security | true | boolean | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts |======================================================================= {% endraw %} -// endpoint options: END +// endpoint options: END \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ganglia/src/main/docs/ganglia-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc index 2ee0a56..33e4d54 100644 --- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc +++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc @@ -1,8 +1,6 @@ -# Ganglia Component +## Ganglia Component -[[Ganglia-AvailableasofCamel2.15.0]] -Available as of Camel 2.15.0 -++++++++++++++++++++++++++++ +#### Available as of Camel 2.15.0 Provides a mechanism to send a value (the message body) as a metric to the http://ganglia.info[Ganglia] monitoring system. Uses the gmetric4j @@ -35,9 +33,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Ganglia-URIformat]] -URI format -~~~~~~~~~~ +### URI format [source,java] ------------------------------ @@ -47,9 +43,7 @@ ganglia:address:port[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Ganglia-GangliacomponentandendpointURIoptions]] -Ganglia component and endpoint URI options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Ganglia component and endpoint URI options @@ -102,27 +96,19 @@ The Ganglia component supports 15 endpoint options which are listed below: -[[Ganglia-Messagebody]] -Message body -~~~~~~~~~~~~ +### Message body Any value (such as a string or numeric type) in the body is sent to the Ganglia system. -[[Ganglia-ReturnvalueAndResponse]] -Return value / response -~~~~~~~~~~~~~~~~~~~~~~~ +### Return value / response Ganglia sends metrics using unidirectional UDP or multicast. There is no response or change to the message body. -[[Ganglia-Examples]] -Examples -~~~~~~~~ +### Examples -[[Ganglia-SendingaStringmetric]] -Sending a String metric -^^^^^^^^^^^^^^^^^^^^^^^ +### Sending a String metric The message body will be converted to a String and sent as a metric value. Unlike numeric metrics, String values can't be charted but @@ -140,9 +126,7 @@ from("direct:ganglia.tx") .to("ganglia:239.2.11.71:8649?mode=MULTICAST&prefix=test"); ------------------------------------------------------------------------ -[[Ganglia-Sendinganumericmetric]] -Sending a numeric metric -^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending a numeric metric [source,java] ------------------------------------------------------------------------ @@ -154,4 +138,4 @@ from("direct:value.for.ganglia") from("direct:ganglia.tx") .to("ganglia:239.2.11.71:8649?mode=MULTICAST&prefix=test"); ------------------------------------------------------------------------- +------------------------------------------------------------------------ \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-geocoder/src/main/docs/geocoder-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-geocoder/src/main/docs/geocoder-component.adoc b/components/camel-geocoder/src/main/docs/geocoder-component.adoc index a4c78d9..9459e53 100644 --- a/components/camel-geocoder/src/main/docs/geocoder-component.adoc +++ b/components/camel-geocoder/src/main/docs/geocoder-component.adoc @@ -1,4 +1,4 @@ -# Geocoder Component +## Geocoder Component *Available as of Camel 2.12* @@ -20,9 +20,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Geocoder-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] -------------------------------------------- @@ -30,9 +28,7 @@ geocoder:address:name[?options] geocoder:latlng:latitude,longitude[?options] -------------------------------------------- -[[Geocoder-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -71,9 +67,7 @@ The Geocoder component supports 16 endpoint options which are listed below: -[[Geocoder-Exchangedataformat]] -Exchange data format -^^^^^^^^^^^^^^^^^^^^ +### Exchange data format Camel will deliver the body as a `com.google.code.geocoder.model.GeocodeResponse` type. + @@ -84,9 +78,7 @@ If the option `headersOnly` is set to `true` then the message body is left as-is, and only headers will be added to the link:exchange.html[Exchange]. -[[Geocoder-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="50%,50%",options="header",] |======================================================================= @@ -117,9 +109,7 @@ Message Headers Notice not all headers may be provided depending on available data and mode in use (address vs latlng). -[[Geocoder-Samples]] -Samples -^^^^^^^ +### Samples In the example below we get the latitude and longitude for Paris, France @@ -161,4 +151,4 @@ shown: ----------------------------------- from("direct:start") .to("geocoder:address:current") ------------------------------------ +----------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-git/src/main/docs/git-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-git/src/main/docs/git-component.adoc b/components/camel-git/src/main/docs/git-component.adoc index a67a841..6f3cc8d 100644 --- a/components/camel-git/src/main/docs/git-component.adoc +++ b/components/camel-git/src/main/docs/git-component.adoc @@ -1,4 +1,4 @@ -# Git Component +## Git Component *Available as of Camel 2.16* @@ -21,9 +21,7 @@ The *git:* component allows you to work with a generic Git repository. git://localRepositoryPath[?options] ----------------------------------- -[[Git-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The producer allows to do operations on a specific repository. + The consumer allows consuming commits, tags and branches on a specific @@ -65,9 +63,7 @@ The Git component supports 14 endpoint options which are listed below: -[[Git-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,10%,20%,50%",options="header",] |======================================================================= @@ -89,9 +85,7 @@ Message Headers |======================================================================= -[[Git-ProducerExample]] -Producer Example -^^^^^^^^^^^^^^^^ +### Producer Example Below is an example route of a producer that add a file test.java to a local repository, commit it with a specific message on master branch and @@ -107,9 +101,7 @@ from("direct:start") .to("git:///tmp/testRepo?operation=push&remotePath=https://foo.com/test/test.git&username=xxx&password=xxx";) -------------------------------------------------------------------------------------------------------------------- -[[Git-ConsumerExample]] -Consumer Example -^^^^^^^^^^^^^^^^ +### Consumer Example Below is an example route of a consumer that consumes commit: @@ -117,4 +109,4 @@ Below is an example route of a consumer that consumes commit: --------------------------------------- from("git:///tmp/testRepo?type=commit") .to(....) ---------------------------------------- +--------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-github/src/main/docs/github-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-github/src/main/docs/github-component.adoc b/components/camel-github/src/main/docs/github-component.adoc index 362f28f..1ed6623 100644 --- a/components/camel-github/src/main/docs/github-component.adoc +++ b/components/camel-github/src/main/docs/github-component.adoc @@ -1,4 +1,4 @@ -# GitHub Component +## GitHub Component *Available as of Camel 2.15* @@ -32,18 +32,14 @@ for this component: </dependency> ----------------------------------------- -[[GitHub-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,text] --------------------------- github://endpoint[?options] --------------------------- -[[GitHub-MandatoryOptions:]] -Mandatory Options: -^^^^^^^^^^^^^^^^^^ +### Mandatory Options: Note that these can be configured directly through the endpoint. @@ -81,9 +77,7 @@ The GitHub component supports 14 endpoint options which are listed below: -[[GitHub-ConsumerEndpoints:]] -Consumer Endpoints: -^^^^^^^^^^^^^^^^^^^ +### Consumer Endpoints: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= @@ -100,9 +94,7 @@ request discussion) or org.eclipse.egit.github.core.CommitComment |commit |polling |org.eclipse.egit.github.core.RepositoryCommit |======================================================================= -[[GitHub-ProducerEndpoints:]] -Producer Endpoints: -^^^^^^^^^^^^^^^^^^^ +### Producer Endpoints: [width="100%",cols="20%,20%,60%",options="header",] |======================================================================= @@ -117,4 +109,4 @@ pull request discussion is assumed. |closePullRequest |none | - GitHubPullRequest (integer) (REQUIRED): Pull request number. |createIssue (From Camel 2.18) |String (issue body text) | - GitHubIssueTitle (String) (REQUIRED): Issue Title. -|======================================================================= +|======================================================================= \ No newline at end of file
