http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-http4/src/main/docs/http4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-http4/src/main/docs/http4-component.adoc b/components/camel-http4/src/main/docs/http4-component.adoc index 8e3076b..318b596 100644 --- a/components/camel-http4/src/main/docs/http4-component.adoc +++ b/components/camel-http4/src/main/docs/http4-component.adoc @@ -1,4 +1,4 @@ -# HTTP4 Component +## HTTP4 Component *Available as of Camel 2.3* @@ -26,9 +26,7 @@ Camel-http4 uses http://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient 4.x] while camel-http uses http://hc.apache.org/httpclient-3.x/[Apache HttpClient 3.x]. -[[HTTP4-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------- @@ -47,9 +45,7 @@ Therefore it should never be used as input into your Camel Routes. To bind/expose an HTTP endpoint via a HTTP server as input to a Camel route, use the link:jetty.html[Jetty Component] instead. -[[HTTP4-HttpOptions]] -Http4 Component Options -^^^^^^^^^^^^^^^^^^^^^^^ +### Http4 Component Options @@ -138,9 +134,7 @@ The HTTP4 component supports 32 endpoint options which are listed below: -[[HTTP4-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,20%,70%",options="header",] |======================================================================= @@ -171,9 +165,7 @@ a content type, such as `text/html`. provide a content encoding, such as `gzip`. |======================================================================= -[[HTTP4-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body Camel will store the HTTP response from the external server on the OUT body. All headers from the IN message will be copied to the OUT message, @@ -183,9 +175,7 @@ HTTP response headers as well to the OUT message headers. Â -[[HTTP4-UsingSystemProperties]] -Using System Properties -^^^^^^^^^^^^^^^^^^^^^^^ +### Using System Properties When setting useSystemProperties to true, the HTTP Client will look for the following System Properties and it will use it: @@ -207,9 +197,7 @@ the following System Properties and it will use it: * http.keepAlive * http.maxConnections -[[HTTP4-Responsecode]] -Response code -^^^^^^^^^^^^^ +### Response code Camel will handle according to the HTTP response code: @@ -227,9 +215,7 @@ the `HttpOperationFailedException` from being thrown for failed response codes. This allows you to get any response from the remote server. + There is a sample below demonstrating this. -[[HTTP4-HttpOperationFailedException]] -HttpOperationFailedException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### HttpOperationFailedException This exception contains the following information: @@ -239,9 +225,7 @@ This exception contains the following information: * Response body as a `java.lang.String`, if server provided a body as response -[[HTTP4-CallingusingGETorPOST]] -Calling using GET or POST -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Calling using GET or POST The following algorithm is used to determine whether the `GET` or `POST` HTTP method should be used: + @@ -251,9 +235,7 @@ HTTP method should be used: + 4. `POST` if there is data to send (body is not null). + 5. `GET` otherwise. -[[HTTP4-HowtogetaccesstoHttpServletRequestandHttpServletResponse]] -How to get access to HttpServletRequest and HttpServletResponse -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to get access to HttpServletRequest and HttpServletResponse You can get access to these two using the Camel type converter system using + @@ -266,9 +248,7 @@ HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class); HttpServletRequest response = exchange.getIn().getBody(HttpServletResponse.class); ---------------------------------------------------------------------------------- -[[HTTP4-ConfiguringURItocall]] -Configuring URI to call -^^^^^^^^^^^^^^^^^^^^^^^ +### Configuring URI to call You can set the HTTP producer's URI directly form the endpoint URI. In the route below, Camel will call out to the external server, `oldhost`, @@ -307,9 +287,7 @@ endpoint is configured with http4://oldhost. + If the http4 endpoint is working in bridge mode, it will ignore the message header of `Exchange.HTTP_URI`. -[[HTTP4-ConfiguringURIParameters]] -Configuring URI Parameters -^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Configuring URI Parameters The *http* producer supports URI parameters to be sent to the HTTP server. The URI parameters can either be set directly on the endpoint @@ -330,9 +308,7 @@ from("direct:start") .to("http4://oldhost"); --------------------------------------------------------------------- -[[HTTP4-HowtosetthehttpmethodtotheHTTPproducer]] -How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer *Using the http PATCH method* @@ -372,9 +348,7 @@ And the equivalent Spring sample: </camelContext> --------------------------------------------------------------------- -[[HTTP4-Usingclienttimeout-SO_TIMEOUT]] -Using client timeout - SO_TIMEOUT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using client timeout - SO_TIMEOUT See the https://svn.apache.org/repos/asf/camel/trunk/components/camel-http4/src/test/java/org/apache/camel/component/http4/HttpSOTimeoutTest.java[HttpSOTimeoutTest] @@ -384,9 +358,7 @@ unit test. https://github.com/apache/camel/blob/master/components/camel-http4/src/test/java/org/apache/camel/component/http4/HttpSOTimeoutTest.java[HttpSOTimeoutTest] unit test. -[[HTTP4-ConfiguringaProxy]] -Configuring a Proxy -^^^^^^^^^^^^^^^^^^^ +### Configuring a Proxy The HTTP4 component provides a way to configure a proxy. @@ -399,9 +371,7 @@ from("direct:start") There is also support for proxy authentication via the `proxyAuthUsername` and `proxyAuthPassword` options. -[[HTTP4-UsingproxysettingsoutsideofURI]] -Using proxy settings outside of URI -+++++++++++++++++++++++++++++++++++ +#### Using proxy settings outside of URI To avoid System properties conflicts, you can set proxy configuration only from the CamelContext or URI. + @@ -432,9 +402,7 @@ Properties and then the endpoint proxy options if provided. + Notice in *Camel 2.8* there is also a `http.proxyScheme` property you can set to explicit configure the scheme to use. -[[HTTP4-Configuringcharset]] -Configuring charset -^^^^^^^^^^^^^^^^^^^ +### Configuring charset If you are using `POST` to send data you can configure the `charset` using the `Exchange` property: @@ -444,9 +412,7 @@ using the `Exchange` property: exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1"); ---------------------------------------------------------- -[[HTTP4-Samplewithscheduledpoll]] -Sample with scheduled poll -++++++++++++++++++++++++++ +#### Sample with scheduled poll This sample polls the Google homepage every 10 seconds and write the page to the file `message.html`: @@ -459,9 +425,7 @@ from("timer://foo?fixedRate=true&delay=0&period=10000") .to("file:target/google"); ------------------------------------------------------------ -[[HTTP4-URIParametersfromtheendpointURI]] -URI Parameters from the endpoint URI -++++++++++++++++++++++++++++++++++++ +#### URI Parameters from the endpoint URI In this sample we have the complete URI endpoint that is just what you would have typed in a web browser. Multiple URI parameters can of course @@ -474,9 +438,7 @@ web browser. Camel does no tricks here. template.sendBody("http4://www.google.com/search?q=Camel", null); ----------------------------------------------------------------- -[[HTTP4-URIParametersfromtheMessage]] -URI Parameters from the Message -+++++++++++++++++++++++++++++++ +#### URI Parameters from the Message [source,java] ------------------------------------------------------------------ @@ -489,9 +451,7 @@ template.sendBody("http4://www.google.com/search", null, headers); In the header value above notice that it should *not* be prefixed with `?` and you can separate parameters as usual with the `&` char. -[[HTTP4-GettingtheResponseCode]] -Getting the Response Code -+++++++++++++++++++++++++ +#### Getting the Response Code You can get the HTTP response code from the HTTP4 component by getting the value from the Out message header with @@ -508,25 +468,19 @@ Message out = exchange.getOut(); int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class); ------------------------------------------------------------------------------------ -[[HTTP4-DisablingCookies]] -Disabling Cookies -^^^^^^^^^^^^^^^^^ +### Disabling Cookies To disable cookies you can set the HTTP Client to ignore cookies by adding this URI option: + `httpClient.cookiePolicy=ignoreCookies` -[[HTTP4-AdvancedUsage]] -Advanced Usage -^^^^^^^^^^^^^^ +### Advanced Usage If you need more control over the HTTP producer you should use the `HttpComponent` where you can set various classes to give you custom behavior. -[[HTTP4-SettingupSSLforHTTPClient]] -Setting up SSL for HTTP Client -++++++++++++++++++++++++++++++ +#### Setting up SSL for HTTP Client [[HTTP4-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility @@ -696,4 +650,4 @@ property. <property name="sslContextParameters" ref="sslContextParams2"/> <property name="x509HostnameVerifier" ref="hostnameVerifier"/> </bean> ----------------------------------------------------------------------------- +---------------------------------------------------------------------------- \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ibatis/src/main/docs/ibatis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ibatis/src/main/docs/ibatis-component.adoc b/components/camel-ibatis/src/main/docs/ibatis-component.adoc index 0203cc2..ddedce8 100644 --- a/components/camel-ibatis/src/main/docs/ibatis-component.adoc +++ b/components/camel-ibatis/src/main/docs/ibatis-component.adoc @@ -1,4 +1,4 @@ -# iBatis Component +## iBatis Component The *ibatis:* component allows you to query, poll, insert, update and delete data in a relational database using @@ -27,9 +27,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[iBATIS-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------ @@ -50,9 +48,7 @@ the root of the classpath and expected named as `SqlMapConfig.xml`. + In Camel 2.2 you can configure this on the iBatisComponent with the `setSqlMapConfig(String)` method. -[[iBATIS-Options]] -Options -^^^^^^^ +### Options @@ -123,9 +119,7 @@ The iBatis component supports 28 endpoint options which are listed below: -[[iBATIS-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel will populate the result message, either IN or OUT with a header with the operationName used: @@ -141,9 +135,7 @@ instance an `INSERT` could return the auto-generated key, or number of rows etc. |======================================================================= -[[iBATIS-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body The response from iBatis will only be set as body if it's a `SELECT` statement. That means, for example, for `INSERT` statements Camel will @@ -151,9 +143,7 @@ not replace the body. This allows you to continue routing and keep the original body. The response from iBatis is always stored in the header with the key `CamelIBatisResult`. -[[iBATIS-Samples]] -Samples -^^^^^^^ +### Samples For example if you wish to consume beans from a JMS queue and insert them into a database you could do the following: @@ -185,9 +175,7 @@ Where *insertAccount* is the iBatis ID in the SQL map file: </insert> ------------------------------------------------------------ -[[iBATIS-UsingStatementTypeforbettercontrolofIBatis]] -Using StatementType for better control of IBatis -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using StatementType for better control of IBatis When routing to an iBatis endpoint you want more fine grained control so you can control whether the SQL statement to be executed is a `SELEECT`, @@ -205,9 +193,7 @@ We can do the same for some of the other operations, such as And the same for `UPDATE`, where we can send an `Account` object as IN body to iBatis: -[[iBATIS-Scheduledpollingexample]] -Scheduled polling example -+++++++++++++++++++++++++ +#### Scheduled polling example Since this component does not support scheduled polling, you need to use another mechanism for triggering the scheduled polls, such as the @@ -231,9 +217,7 @@ And the iBatis SQL map file used: </select> ---------------------------------------------------------------------------- -[[iBATIS-UsingonConsume]] -Using onConsume -+++++++++++++++ +#### Using onConsume This component supports executing statements *after* data have been consumed and processed by Camel. This allows you to do post updates in @@ -247,14 +231,11 @@ database to processed, so we avoid consuming it twice or more. And the statements in the sqlmap file: -[[iBATIS-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:mybatis.html[MyBatis] - +* link:mybatis.html[MyBatis] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ical/src/main/docs/ical-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ical/src/main/docs/ical-dataformat.adoc b/components/camel-ical/src/main/docs/ical-dataformat.adoc index 39128d5..ceb68c8 100644 --- a/components/camel-ical/src/main/docs/ical-dataformat.adoc +++ b/components/camel-ical/src/main/docs/ical-dataformat.adoc @@ -1,4 +1,4 @@ -# iCal DataFormat +## iCal DataFormat *Available as of Camel 2.11.1* @@ -26,9 +26,7 @@ END:VEVENT END:VCALENDAR ---------------------------------------------------------------------- -[[ICal-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The iCal dataformat supports 2 options which are listed below. @@ -45,9 +43,7 @@ The iCal dataformat supports 2 options which are listed below. {% endraw %} // dataformat options: END -[[ICal-BasicUsage]] -Basic Usage -^^^^^^^^^^^ +### Basic Usage To unmarshal and marshal the message shown above, your route will look like the following: @@ -74,12 +70,9 @@ for this component: </dependency> ------------------------------------------------------------ -[[ICal-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-infinispan/src/main/docs/infinispan-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc index bb014c1..6031c7d 100644 --- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc +++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc @@ -1,4 +1,4 @@ -# Infinispan Component +## Infinispan Component *Available as of Camel 2.13.0* @@ -22,18 +22,14 @@ for this component: </dependency> ------------------------------------------------------------ -[[Infinispan-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------- infinispan://hostName?[options] ------------------------------- -[[Infinispan-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The producer allows sending messages to a local infinispan cache configured in the registry, or to a remote cache using the HotRod @@ -76,9 +72,7 @@ The Infinispan component supports 15 endpoint options which are listed below: -[[Infinispan-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,10%,10%,60%",options="header",] |======================================================================= @@ -123,9 +117,7 @@ present the command defaults to InifinispanConfiguration's one operation returning something is ignored by the client application |======================================================================= -[[Infinispan-Example]] -Example -^^^^^^^ +### Example Below is an example route that retrieves a value from the cache for a specific key: @@ -138,9 +130,7 @@ from("direct:start") .to("infinispan://localhost?cacheContainer=#cacheContainer"); ------------------------------------------------------------------------------------ -[[Infinispan-UsingtheInfinispanbasedidempotentrepository]] -Using the Infinispan based idempotent repository -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using the Infinispan based idempotent repository In this section we will use the Infinispan based idempotent repository. @@ -178,12 +168,9 @@ XML file as well: For more information, see these resources... -[[Infinispan-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-influxdb/src/main/docs/influxdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-influxdb/src/main/docs/influxdb-component.adoc b/components/camel-influxdb/src/main/docs/influxdb-component.adoc index d171c5f..e8a7689 100644 --- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc +++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc @@ -1,4 +1,4 @@ -# InfluxDB Component +## InfluxDB Component *Available as of Camel 2.18.0* @@ -26,18 +26,14 @@ for this component: </dependency> ------------------------------------------------------------ -[[InfluxDb-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------- influxdb://beanName?[options] ------------------------------- -[[InfluxDb-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options The producer allows sending messages to a influxdb configured in the registry, using the native java driver. @@ -72,9 +68,7 @@ The InfluxDB component supports 7 endpoint options which are listed below: -[[InfluxDb-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,10%,10%,60%",options="header",] |======================================================================= @@ -83,9 +77,7 @@ Message Headers |======================================================================= -[[InfluxDb-Example]] -Example -^^^^^^^ +### Example Below is an example route that stores a point into the db (taking the db name from the URI) @@ -106,12 +98,9 @@ from("direct:start") For more information, see these resources... -[[InfluxDb-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-irc/src/main/docs/irc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-irc/src/main/docs/irc-component.adoc b/components/camel-irc/src/main/docs/irc-component.adoc index 2ae82e3..af4a499 100644 --- a/components/camel-irc/src/main/docs/irc-component.adoc +++ b/components/camel-irc/src/main/docs/irc-component.adoc @@ -1,4 +1,4 @@ -# IRC Component +## IRC Component The *irc* component implements an http://en.wikipedia.org/wiki/Internet_Relay_Chat[IRC] (Internet Relay @@ -17,9 +17,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[IRC-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------------------------------- @@ -30,9 +28,7 @@ irc:nick@host[:port]?channels=#channel1,#channel2,#channel3[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[IRC-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -87,13 +83,9 @@ The IRC component supports 26 endpoint options which are listed below: -[[IRC-SSLSupport]] -SSL Support -^^^^^^^^^^^ +### SSL Support -[[IRC-UsingtheJSSEConfigurationUtility]] -Using the JSSE Configuration Utility -++++++++++++++++++++++++++++++++++++ +#### Using the JSSE Configuration Utility As of Camel 2.9, the IRC component supports SSL/TLS configuration through the link:camel-configuration-utilities.html[Camel JSSE @@ -144,9 +136,7 @@ Spring DSL based configuration of endpoint <to uri="ircs://camel-prd-user@server:6669/#camel-test?nickname=camel-prd&password=password&sslContextParameters=#sslContextParameters"/>... ---------------------------------------------------------------------------------------------------------------------------------------------- -[[IRC-Usingthelegacybasicconfigurationoptions]] -Using the legacy basic configuration options -++++++++++++++++++++++++++++++++++++++++++++ +#### Using the legacy basic configuration options You can also connect to an SSL enabled IRC server, as follows: @@ -165,9 +155,7 @@ If you need to provide your own custom trust manager, use the ircs:host[:port]/#room?username=user&password=pass&trustManager=#referenceToMyTrustManagerBean ---------------------------------------------------------------------------------------------- -[[IRC-Usingkeys]] -Using keys -^^^^^^^^^^ +### Using keys *Available as of Camel 2.2* @@ -181,8 +169,7 @@ For example we join 3 channels where as only channel 1 and 3 uses a key. irc:n...@irc.server.org?channels=#chan1,#chan2,#chan3&keys=chan1Key,,chan3key ----------------------------------------------------------------------------- -Getting a list of users of the channel -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Getting a list of users of the channel Using the `namesOnJoin` option one can invoke the IRC-`NAMES` command after the component has joined a channel. The server will reply with `irc.num = 353`. So in order to process the result the property `onReply` has to be `true`. @@ -199,12 +186,9 @@ from("ircs:nick@myserver:1234/#mychannelname?listOnJoin=true&onReply=true") .to("mock:result").stop(); ----------------------------------------------------------------------------- -[[IRC-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-ironmq/src/main/docs/ironmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc b/components/camel-ironmq/src/main/docs/ironmq-component.adoc index 088c78b..18032c0 100644 --- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc +++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc @@ -1,4 +1,4 @@ -# ironmq Component +## ironmq Component *Available as of Camel 2.17* @@ -23,9 +23,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[IronMQ-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -33,9 +31,7 @@ URI format ----------------------------- Where **queueName** identifies the IronMQ queue you want to publish or consume messages from. -[[IronMQ-Options]] -Options -^^^^^^^ +### Options @@ -90,9 +86,7 @@ The ironmq component supports 31 endpoint options which are listed below: -[[IronMQ-IronMQComponentOptions]] -IronMQComponent Options -^^^^^^^^^^^^^^^^^^^^^^^ +### IronMQComponent Options @@ -105,14 +99,10 @@ The ironmq component has no options. -[[IronMQ-Messagebody]] -Message Body -^^^^^^^^^^^^ +### Message Body Should be either a String or a array of Strings. In the latter case the batch of strings will be send to IronMQ as one request, creating one message pr. element in the array. -[[IronMQ-MessageHeaders]] -Producer message headers -^^^^^^^^^^^^^^^^^^^^^^^^ +### Producer message headers [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -121,8 +111,7 @@ Producer message headers |CamelIronMQMessageId |String or io.iron.ironmq.Ids|The id of the IronMQ message as a String when sending a single message, or a Ids object when sending a array of strings. |======================================================================= -Consumer message headers -^^^^^^^^^^^^^^^^^^^^^^^^ +### Consumer message headers [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -133,8 +122,7 @@ Consumer message headers |======================================================================= -Consumer example -^^^^^^^^^^^^^^^^ +### Consumer example Consume 50 messages pr. poll from the queue 'testqueue' on aws eu, and save the messages to files. @@ -144,12 +132,11 @@ from("ironmq:testqueue?ironMQCloud=https://mq-aws-eu-west-1-1.iron.io&projectId= .to("file:somefolder"); -------------------------------------------------- -Producer example -^^^^^^^^^^^^^^^^ +### Producer example Dequeue from activemq jms and enqueue the messages on IronMQ. [source,java] -------------------------------------------------- from("activemq:foo") .to("ironmq:testqueue?projectId=myIronMQProjectid&token=myIronMQToken"); --------------------------------------------------- +-------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc index 5f9980d..5bdfa56 100644 --- a/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc +++ b/components/camel-jackson/src/main/docs/json-jackson-dataformat.adoc @@ -1,4 +1,4 @@ -# JSon Jackson DataFormat +## JSon Jackson DataFormat *Available as of Camel 2.18* @@ -12,9 +12,7 @@ from("activemq:My.Queue"). to("mqseries:Another.Queue"); ------------------------------- -[[Jackson-Options]] -Jackson Options -^^^^^^^^^^^^^^^ +### Jackson Options @@ -50,9 +48,7 @@ The JSon Jackson dataformat supports 17 options which are listed below. -[[Jackson-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Jackson in your camel routes you need to add the dependency on *camel-jackson* which implements this data format. @@ -69,4 +65,4 @@ link:download.html[the download page for the latest versions]). <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ----------------------------------------------------------- +---------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc index 45c89d5..874aa46 100644 --- a/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc +++ b/components/camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc @@ -1,4 +1,4 @@ -# JacksonXML DataFormat +## JacksonXML DataFormat *Available as of Camel 2.16* @@ -27,9 +27,7 @@ from("activemq:My.Queue"). to("mqseries:Another.Queue"); ------------------------------- -[[JacksonXML-Options]] -JacksonXML Options -^^^^^^^^^^^^^^^^^^ +### JacksonXML Options @@ -62,9 +60,7 @@ The JacksonXML dataformat supports 15 options which are listed below. // dataformat options: END -[[JacksonXML-UsingJacksonXMLinSpringDSL]] -Using Jackson XML in Spring DSL -+++++++++++++++++++++++++++++++ +#### Using Jackson XML in Spring DSL When using link:data-format.html[Data Format] in Spring DSL you need to declare the data formats first. This is done in the *DataFormats* XML @@ -90,9 +86,7 @@ And then you can refer to this id in the route: </route> ------------------------------------- -[[JacksonXML-ExcludingPOJOfieldsfrommarshalling]] -Excluding POJO fields from marshalling -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Excluding POJO fields from marshalling When marshalling a POJO to XML you might want to exclude certain fields from the XML output. With Jackson you can @@ -112,9 +106,7 @@ Note that the weight field is missing in the resulting XML: <pojo age="30" weight="70"/> ---------------------------- -[[JacksonXML-Include/ExcludefieldsusingthejsonViewattributewithJacksonXMLDataFormat]] -Include/Exclude fields using the `jsonView` attribute with `JacksonXML`DataFormat -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Include/Exclude fields using the `jsonView` attribute with `JacksonXML`DataFormat As an example of using this attribute you can instead of: @@ -144,9 +136,7 @@ And the same in XML DSL: </marshal> --------------------------------------------------------------------------------------------------------------------------------------------------- -[[JacksonXML-Settingserializationincludeoption]] -Setting serialization include option -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Setting serialization include option If you want to marshal a pojo to XML, and the pojo has some fields with null values. And you want to skip these null values, then you need to @@ -179,9 +169,7 @@ Or from XML DSL you configure this as </dataFormats> ------------------------------------------------------ -[[JacksonXML-UnmarshallingfromXMLtoPOJOwithdynamicclassname]] -Unmarshalling from XML to POJO with dynamic class name -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Unmarshalling from XML to POJO with dynamic class name If you use jackson to unmarshal XML to POJO, then you can now specify a header in the message that indicate which class name to unmarshal to. + @@ -208,9 +196,7 @@ Or from XML DSL you configure this as </dataFormats> ------------------------------------------------------- -[[JacksonXML-UnmarshallingfromXMLtoListMaporListPojo]] -Unmarshalling from XML to List<Map> or List<pojo> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Unmarshalling from XML to List<Map> or List<pojo> If you are using Jackson to unmarshal XML to a list of map/pojo, you can now specify this by setting `useList="true"` or use @@ -246,9 +232,7 @@ And you can specify the pojo type also </dataFormats> ------------------------------------------------------------------------------- -[[JacksonXML-UsingcustomJacksonmodules]] -Using custom Jackson modules -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using custom Jackson modules You can use custom Jackson modules by specifying the class names of those using the moduleClassNames option as shown below. @@ -280,9 +264,7 @@ to the module as shown below:  Multiple modules can be specified separated by comma, such as moduleRefs="myJacksonModule,myOtherModule" -[[JacksonXML-EnablingordisablefeaturesusingJackson]] -Enabling or disable features using Jackson -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Enabling or disable features using Jackson Jackson has a number of features you can enable or disable, which its ObjectMapper uses. For example to disable failing on unknown properties @@ -315,9 +297,7 @@ df.disableFeature(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); df.disableFeature(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES); ---------------------------------------------------------------------- -[[JacksonXML-ConvertingMapstoPOJOusingJackson]] -Converting Maps to POJO using Jackson -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Converting Maps to POJO using Jackson Jackson `ObjectMapper` can be used to convert maps to POJO objects. Jackson component comes with the data converter that can be used to @@ -338,9 +318,7 @@ If there is a single `ObjectMapper` instance available in the Camel registry, it will used by the converter to perform the conversion. Otherwise the default mapper will be used.  -[[JacksonXML-FormattedXMLmarshallingpretty-printing]] -Formatted XML marshalling (pretty-printing) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Formatted XML marshalling (pretty-printing) Using the `prettyPrint` option one can output a well formatted XML while marshalling: @@ -363,9 +341,7 @@ Please note that there are 5 different overloaded `jacksonxml()` DSL methods which support the `prettyPrint` option in combination with other settings for `unmarshalType`, `jsonView` etc. -[[JacksonXML-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Jackson XML in your camel routes you need to add the dependency on *camel-jacksonxml* which implements this data format. @@ -382,4 +358,4 @@ link:download.html[the download page for the latest versions]). <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ----------------------------------------------------------- +---------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-javaspace/src/main/docs/javaspace-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-javaspace/src/main/docs/javaspace-component.adoc b/components/camel-javaspace/src/main/docs/javaspace-component.adoc index ffe4cf5..141e93b 100644 --- a/components/camel-javaspace/src/main/docs/javaspace-component.adoc +++ b/components/camel-javaspace/src/main/docs/javaspace-component.adoc @@ -1,4 +1,4 @@ -# JavaSpace Component +## JavaSpace Component *Available as of Camel 2.1* @@ -34,9 +34,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[JavaSpace-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------- @@ -46,9 +44,7 @@ javaspace:jini://host[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[JavaSpace-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -82,13 +78,9 @@ The JavaSpace component supports 11 endpoint options which are listed below: -[[JavaSpace-Examples]] -Examples -^^^^^^^^ +### Examples -[[JavaSpace-SendingandReceivingEntries]] -Sending and Receiving Entries -+++++++++++++++++++++++++++++ +#### Sending and Receiving Entries [source,java] -------------------------------------------------------------------------------------------------------- @@ -104,9 +96,7 @@ from("javaspace:jini://localhost?spaceName=mySpace&templateId=template&verb=take In this case the payload can be any object that inherits from the Jini `Entry` type. -[[JavaSpace-Sendingandreceivingserializableobjects]] -Sending and receiving serializable objects -++++++++++++++++++++++++++++++++++++++++++ +#### Sending and receiving serializable objects Using the preceding routes, it is also possible to send and receive any serializable object. The JavaSpace component detects that the payload is @@ -114,9 +104,7 @@ not a Jini `Entry` and then it automatically wraps the payload with a Camel Jini `Entry`. In this way, a JavaSpace can be used as a generic transport mechanism. -[[JavaSpace-UsingJavaSpaceasaremoteinvocationtransport]] -Using JavaSpace as a remote invocation transport -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Using JavaSpace as a remote invocation transport The JavaSpace component has been tailored to work in combination with the Camel bean component. It is therefore possible to call a remote POJO @@ -138,12 +126,9 @@ realize the master/worker pattern. The idea is to use the POJO to provide the business logic and rely on Camel for sending/receiving requests/replies with the proper correlation. -[[JavaSpace-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-jaxb/src/main/docs/jaxb-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc index ccbd16f..05b260b 100644 --- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc @@ -1,13 +1,11 @@ -# JAXB DataFormat +## JAXB DataFormat JAXB is a link:data-format.html[Data Format] which uses the JAXB2 XML marshalling standard which is included in Java 6 to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload. -[[JAXB-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The JAXB dataformat supports 17 options which are listed below. @@ -39,9 +37,7 @@ The JAXB dataformat supports 17 options which are listed below. {% endraw %} // dataformat options: END -[[JAXB-UsingtheJavaDSL]] -Using the Java DSL -^^^^^^^^^^^^^^^^^^ +### Using the Java DSL For example the following uses a named DataFormat of _jaxb_ which is configured with a number of Java package names to initialize the @@ -67,9 +63,7 @@ from("activemq:My.Queue"). to("mqseries:Another.Queue"); ------------------------------- -[[JAXB-UsingSpringXML]] -Using Spring XML -^^^^^^^^^^^^^^^^ +### Using Spring XML The following example shows how to use JAXB to unmarshal using link:spring.html[Spring] configuring the jaxb data type @@ -84,9 +78,7 @@ You can specify context path using `:` as separator, for example `com.mycompany:com.mycompany2`. Note that this is handled by JAXB implementation and might change if you use different vendor than RI. -[[JAXB-Partialmarshalling/unmarshalling]] -Partial marshalling/unmarshalling -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Partial marshalling/unmarshalling *This feature is new to Camel 2.2.0.* + JAXB 2 supports marshalling and unmarshalling XML tree fragments. By @@ -101,9 +93,7 @@ to JAXB's unmarshaler. For marshalling you have to add `partNamespace` attribute with QName of destination namespace. Example of Spring DSL you can find above. -[[JAXB-Fragment]] -Fragment -^^^^^^^^ +### Fragment *This feature is new to Camel 2.8.0.* + JaxbDataFormat has new property fragment which can set the the @@ -112,9 +102,7 @@ you don't want the JAXB Marshaller to generate the XML declaration, you can set this option to be true. The default value of this property is false. -[[JAXB-IgnoringtheNonXMLCharacter]] -Ignoring the NonXML Character -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Ignoring the NonXML Character *This feature is new to Camel 2.2.0.* + JaxbDataFromat supports to ignore the @@ -159,9 +147,7 @@ Camel's NonXML filtering: <jaxb filterNonXmlChars="true" contextPath="org.apache.camel.foo.bar" xmlStreamWriterWrapper="#testXmlStreamWriterWrapper" /> ------------------------------------------------------------------------------------------------------------------------------ -[[JAXB-WorkingwiththeObjectFactory]] -Working with the ObjectFactory -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Working with the ObjectFactory If you use XJC to create the java class from the schema, you will get an ObjectFactory for you JAXB context. Since the ObjectFactory uses @@ -174,9 +160,7 @@ unmarshaled message body. + body, you need to set the JaxbDataFormat object's ignoreJAXBElement property to be false. -[[JAXB-Settingencoding]] -Setting encoding -^^^^^^^^^^^^^^^^ +### Setting encoding You can set the *encoding* option to use when marshalling. Its the `Marshaller.JAXB_ENCODING` encoding property on the JAXB Marshaller. + @@ -187,9 +171,7 @@ property will overrule the encoding set on the JAXB data format. In this Spring DSL we have defined to use `iso-8859-1` as the encoding: -[[JAXB-Controllingnamespaceprefixmapping]] -Controlling namespace prefix mapping -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Controlling namespace prefix mapping *Available as of Camel 2.11* @@ -227,9 +209,7 @@ with the id "myMap", which was what we defined above. </marshal> ---------------------------------------------------------------------------------------- -[[JAXB-Schemavalidation]] -Schema validation -^^^^^^^^^^^^^^^^^ +### Schema validation *Available as of Camel 2.11* @@ -276,9 +256,7 @@ JaxbDataFormat jaxbDataFormat = new JaxbDataFormat(); jaxbDataFormat.setSchemaFactory(thradSafeSchemaFactory); -------------------------------------------------------- -[[JAXB-SchemaLocation]] -Schema Location -^^^^^^^^^^^^^^^ +### Schema Location *Available as of Camel 2.14* @@ -303,9 +281,7 @@ You can do the same using the XML DSL: </marshal> -------------------------------------------------------- -[[JAXB-MarshaldatathatisalreadyXML]] -Marshal data that is already XML -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Marshal data that is already XML *Available as of Camel 2.14.1* @@ -318,9 +294,7 @@ the JAXB marshaller only attempts to marshal JAXBElements (javax.xml.bind.JAXBIntrospector#isElement returns true). And in those situations the marshaller fallbacks to marshal the message body as-is. -[[JAXB-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use JAXB in your camel routes you need to add the a dependency on *camel-jaxb* which implements this data format. @@ -336,4 +310,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-jaxb</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-jbpm/src/main/docs/jbpm-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc index e4554ff..3100600 100644 --- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc +++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc @@ -1,4 +1,4 @@ -# JBPM Component +## JBPM Component *Available as of Camel 2.16* @@ -19,18 +19,14 @@ for this component: </dependency> ------------------------------------------------------------------------------------ -[[jBPM-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] --------------------------------------------- jbpm::hostName[:port][/resourceUri][?options] --------------------------------------------- -[[jBPM-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START @@ -81,9 +77,7 @@ The JBPM component supports 26 endpoint options which are listed below: -[[jBPM-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -131,9 +125,7 @@ org.infinispan.notifications.cachelistener.event.Event.Type |CamelJBPMStatusList |null |List<Status> |The list of status to use when filtering tasks |======================================================================= -[[jBPM-Example]] -Example -^^^^^^^ +### Example Below is an example route that starts a business process with id project1.integration-test and deploymentId @@ -147,13 +139,11 @@ from("direct:start")  + "&deploymentId=org.kie.example:project1:1.0.0-SNAPSHOT"); ---------------------------------------------------------------------------------------------- -[[jBPM-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] - + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jcache/src/main/docs/jcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index e7c737a..bae1e38 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -1,4 +1,4 @@ -# JCache Component +## JCache Component @@ -48,6 +48,4 @@ The JCache component supports 23 endpoint options which are listed below: // component options: START The JCache 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-jclouds/src/main/docs/jclouds-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index 81e67b7..6515e92 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -1,4 +1,4 @@ -# JClouds Component +## JClouds Component *Available as of Camel 2.9* @@ -33,9 +33,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[jclouds-Configuringthecomponent]] -Configuring the component -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Configuring the component The camel jclouds component will make use of multiple jclouds blobstores and compute services as long as they are passed to the component during @@ -84,9 +82,7 @@ As you can see the component is capable of handling multiple blobstores and compute services. The actual implementation that will be used by each endpoint is specified by passing the provider inside the URI. -[[jclouds-Options]] -Jclouds Options -^^^^^^^^^^^^^^^ +### Jclouds Options [source,java] ----------------------------------------- @@ -100,9 +96,7 @@ target service (_e.g. aws-s3 or aws_ec2_). You can append query options to the URI in the following format, `?option=value&option=value&...` -[[jclouds-BlobstoreURIOptions]] -Blobstore URI Options -^^^^^^^^^^^^^^^^^^^^^ +### Blobstore URI Options @@ -167,9 +161,7 @@ jclouds:blobstore:aws-s3?operation=CamelJcloudsGet&container=mycontainer&blobNam For producer endpoint you can override all of the above URI options by passing the appropriate headers to the message. -[[jclouds-MessageHeadersforblobstore]] -Message Headers for blobstore -+++++++++++++++++++++++++++++ +#### Message Headers for blobstore [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -184,13 +176,9 @@ Message Headers for blobstore |`CamelJcloudsBlobName` |The name of the blob. |======================================================================= -[[jclouds-BlobstoreUsageSamples]] -Blobstore Usage Samples -^^^^^^^^^^^^^^^^^^^^^^^ +### Blobstore Usage Samples -[[jclouds-Example1:Puttingtotheblob]] -Example 1: Putting to the blob -++++++++++++++++++++++++++++++ +#### Example 1: Putting to the blob This example will show you how you can store any message inside a blob using the jclouds component. @@ -217,9 +205,7 @@ route. </route> -------------------------------------------------------------------------------------------- -[[jclouds-Example2:GettingReadingfromablob]] -Example 2: Getting/Reading from a blob -++++++++++++++++++++++++++++++++++++++ +#### Example 2: Getting/Reading from a blob This example will show you how you can read the contnet of a blob using the jclouds component. @@ -246,9 +232,7 @@ route. </route> -------------------------------------------------------------------------------------------- -[[jclouds-Example3:Consumingablob]] -Example 3: Consuming a blob -+++++++++++++++++++++++++++ +#### Example 3: Consuming a blob This example will consume all blob that are under the specified container. The generated exchange will contain the payload of the blob @@ -278,16 +262,12 @@ You can achieve the same goal by using xml, as you can see below. jclouds:compute:aws-ec2?operation=CamelJcloudsCreateNode&imageId=AMI_XXXXX&locationId=eu-west-1&group=mygroup ------------------------------------------------------------------------------------------------------------- -[[jclouds-ComputeUsageSamples]] -Compute Usage Samples -^^^^^^^^^^^^^^^^^^^^^ +### Compute Usage Samples Below are some examples that demonstrate the use of jclouds compute producer in java dsl and spring/blueprint xml. -[[jclouds-Example1:Listingtheavailableimages.]] -Example 1: Listing the available images. -++++++++++++++++++++++++++++++++++++++++ +#### Example 1: Listing the available images. [source,java] -------------------------------------------- @@ -307,9 +287,7 @@ its body. You can also do the same using xml. </route> -------------------------------------------------------------------------- -[[jclouds-Example2:Createanewnode.]] -Example 2: Create a new node. -+++++++++++++++++++++++++++++ +#### Example 2: Create a new node. [source,java] --------------------------------------------- @@ -334,9 +312,7 @@ spring xml. </route> ------------------------------------------------------------------------------------------------------------------------- -[[jclouds-Example3:Runashellscriptonrunningnode.]] -Example 3: Run a shell script on running node. -++++++++++++++++++++++++++++++++++++++++++++++ +#### Example 3: Run a shell script on running node. [source,java] -------------------------------------------- @@ -369,9 +345,7 @@ Here is the same using spring xml. </route> ---------------------------------------------------------------------------------------------- -[[jclouds-Seealso]] -See also -++++++++ +#### See also If you want to find out more about jclouds here is list of interesting resources @@ -380,4 +354,4 @@ http://jclouds.incubator.apache.org/documentation/userguide/blobstore-guide/[Jcl Blobstore wiki] http://jclouds.incubator.apache.org/documentation/userguide/compute/[Jclouds -Compute wiki] +Compute wiki] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jcr/src/main/docs/jcr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index 7f54eba..150546d 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -1,4 +1,4 @@ -# JCR Component +## JCR Component The *`jcr`* component allows you to add/read nodes to/from a JCR compliant content repository (for example, @@ -18,9 +18,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[JCR-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------------- @@ -32,16 +30,12 @@ jcr://user:password@repository/path/to/node From *Camel 2.10* onwards you can use consumer as an EventListener in JCR or a producer to read a node by identifier. -[[JCR-Usage]] -Usage -^^^^^ +### Usage The `repository` element of the URI is used to look up the JCR `Repository` object in the Camel context registry. -[[JCR-Options]] -JCR Options -+++++++++++ +#### JCR Options // component options: START @@ -86,9 +80,7 @@ message headers in Camel versions earlier than 2.12.3. See https://issues.apache.org/jira/browse/CAMEL-7067[https://issues.apache.org/jira/browse/CAMEL-7067] for more details. -[[JCR-Example]] -Example -^^^^^^^ +### Example The snippet below creates a node named `node` under the `/home/test` node in the content repository. One additional property is added to the @@ -117,12 +109,9 @@ all the children. </route> --------------------------------------------------------------------------------------------- -[[JCR-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-jdbc/src/main/docs/jdbc-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc index 6219831..2a7849f 100644 --- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc +++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc @@ -1,4 +1,4 @@ -# JDBC Component +## JDBC Component The *jdbc* component enables you to access databases through JDBC, where SQL queries (SELECT) and operations (INSERT, UPDATE, etc) are sent in @@ -22,9 +22,7 @@ for this component: This component can only be used to define producer endpoints, which means that you cannot use the JDBC component in a `from()` statement. -[[JDBC-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -36,9 +34,7 @@ This component only supports producer endpoints. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[JDBC-Options]] -Options -^^^^^^^ +### Options @@ -89,9 +85,7 @@ The JDBC component supports 14 endpoint options which are listed below: -[[JDBC-Result]] -Result -^^^^^^ +### Result By default the result is returned in the OUT body as an `ArrayList<HashMap<String, Object>>`. The `List` object contains the @@ -102,9 +96,7 @@ the result. *Note:* This component fetches `ResultSetMetaData` to be able to return the column name as the key in the `Map`. -[[JDBC-MessageHeaders]] -Message Headers -+++++++++++++++ +#### Message Headers [width="100%",cols="10%,90%",options="header",] |======================================================================= @@ -128,9 +120,7 @@ type. `useHeadersAsParameters` has been enabled. |======================================================================= -[[JDBC-Generatedkeys]] -Generated keys -^^^^^^^^^^^^^^ +### Generated keys *Available as of Camel 2.10* @@ -147,9 +137,7 @@ test]. Using generated keys does not work with together with named parameters. -[[JDBC-Usingnamedparameters]] -Using named parameters -^^^^^^^^^^^^^^^^^^^^^^ +### Using named parameters *Available as of Camel 2.12* @@ -172,9 +160,7 @@ Notice in the example above we set two headers with constant value + You can also store the header values in a `java.util.Map` and store the map on the headers with the key `CamelJdbcParameters`. -[[JDBC-Samples]] -Samples -^^^^^^^ +### Samples In the following example, we fetch the rows from the customer table. @@ -210,9 +196,7 @@ from("direct:hello") .to("mock:result"); ------------------------------------------------------------------------------------------------- -[[JDBC-Sample-Pollingthedatabaseeveryminute]] -Sample - Polling the database every minute -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sample - Polling the database every minute If we want to poll a database using the JDBC component, we need to combine it with a polling scheduler such as the link:timer.html[Timer] @@ -224,9 +208,7 @@ data from the database every 60 seconds: from("timer://foo?period=60000").setBody(constant("select * from customer")).to("jdbc:testdb").to("activemq:queue:customers"); ------------------------------------------------------------------------------------------------------------------------------ -[[JDBC-Sample-MoveDataBetweenDataSources]] -Sample - Move Data Between Data Sources + -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sample - Move Data Between Data Sources + A common use case is to query for data, process it and move it to another data source (ETL operations). In the following example, we @@ -246,14 +228,11 @@ from("timer://MoveNewCustomersEveryHour?period=3600000")  -[[JDBC-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:sql.html[SQL] - +* link:sql.html[SQL] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jetty9/src/main/docs/jetty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc index fc6ced7..8bc5d3b 100644 --- a/components/camel-jetty9/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc @@ -1,4 +1,4 @@ -# Jetty 9 Component +## Jetty 9 Component The *jetty* component provides HTTP-based link:endpoint.html[endpoints] for consuming and producing HTTP requests. That is, the Jetty component @@ -31,9 +31,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Jetty-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------------------------------- @@ -43,9 +41,7 @@ jetty:http://hostname[:port][/resourceUri][?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Jetty-Options]] -Options -^^^^^^^ +### Options @@ -172,9 +168,7 @@ The Jetty 9 component supports 54 endpoint options which are listed below: -[[Jetty-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel uses the same message headers as the link:http.html[HTTP] component. @@ -190,17 +184,13 @@ header named `orderid` with the value 123. Starting with Camel 2.2.0, you can get the request.parameter from the message header not only from Get Method, but also other HTTP method. -[[Jetty-Usage]] -Usage -^^^^^ +### Usage The Jetty component supports both consumer and producer endpoints. Another option for producing to other HTTP endpoints, is to use the link:http.html[HTTP Component] -[[Jetty-ProducerExample]] -Producer Example -^^^^^^^^^^^^^^^^ +### Producer Example The following is a basic example of how to send an HTTP request to an existing HTTP endpoint. @@ -222,9 +212,7 @@ or in Spring XML <route> --------------------------------------------- -[[Jetty-ConsumerExample]] -Consumer Example -^^^^^^^^^^^^^^^^ +### Consumer Example In this sample we define a route that exposes a HTTP service at `http://localhost:8080/myapp/myservice`: @@ -267,9 +255,7 @@ link:simple.html[Simple] (such as link:el.html[EL] or link:ognl.html[OGNL]) we could also test for the parameter value and do routing based on the header value as well. -[[Jetty-SessionSupport]] -Session Support -^^^^^^^^^^^^^^^ +### Session Support The session support option, `sessionSupport`, can be used to enable a `HttpSession` object and access the session object while processing the @@ -302,9 +288,7 @@ public void process(Exchange exchange) throws Exception { } -------------------------------------------------------------------------------------- -[[Jetty-SSLSupport(HTTPS)]] -SSL Support (HTTPS) -^^^^^^^^^^^^^^^^^^^ +### SSL Support (HTTPS) [[Jetty-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility @@ -475,9 +459,7 @@ difference between the various Camel versions: The value you use as keys in the above map is the port you configure Jetty to listen on. -[[Jetty-ConfiguringgeneralSSLproperties]] -Configuring general SSL properties -++++++++++++++++++++++++++++++++++ +#### Configuring general SSL properties *Available as of Camel 2.5* @@ -501,9 +483,7 @@ the port number as entry). </bean> ----------------------------------------------------------------------------- -[[Jetty-HowtoobtainreferencetotheX509Certificate]] -How to obtain reference to the X509Certificate -++++++++++++++++++++++++++++++++++++++++++++++ +#### How to obtain reference to the X509Certificate Jetty stores a reference to the certificate in the HttpServletRequest which you can access from code as follows: @@ -514,9 +494,7 @@ HttpServletRequest req = exchange.getIn().getBody(HttpServletRequest.class); X509Certificate cert = (X509Certificate) req.getAttribute("javax.servlet.request.X509Certificate") -------------------------------------------------------------------------------------------------- -[[Jetty-ConfiguringgeneralHTTPproperties]] -Configuring general HTTP properties -+++++++++++++++++++++++++++++++++++ +#### Configuring general HTTP properties *Available as of Camel 2.5* @@ -537,9 +515,7 @@ the port number as entry). </bean> ----------------------------------------------------------------------------- -[[Jetty-ObtainingX-Forwarded-ForheaderwithHttpServletRequest.getRemoteAddr]] -Obtaining X-Forwarded-For header with HttpServletRequest.getRemoteAddr() -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Obtaining X-Forwarded-For header with HttpServletRequest.getRemoteAddr() If the HTTP requests are handled by an Apache server and forwarded to jetty with mod_proxy, the original client IP address is in the @@ -571,9 +547,7 @@ This is particularly useful when an existing Apache server handles TLS connections for a domain and proxies them to application servers internally. -[[Jetty-DefaultbehaviorforreturningHTTPstatuscodes]] -Default behavior for returning HTTP status codes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Default behavior for returning HTTP status codes The default behavior of HTTP status codes is defined by the `org.apache.camel.component.http.DefaultHttpBinding` class, which @@ -586,9 +560,7 @@ returned, and the stacktrace is returned in the body. If you want to specify which HTTP status code to return, set the code in the `Exchange.HTTP_RESPONSE_CODE` header of the OUT message. -[[Jetty-CustomizingHttpBinding]] -Customizing HttpBinding -^^^^^^^^^^^^^^^^^^^^^^^ +### Customizing HttpBinding By default, Camel uses the `org.apache.camel.component.http.DefaultHttpBinding` to handle how a @@ -614,9 +586,7 @@ And then we can reference this binding when we define the route: <route><from uri="jetty:http://0.0.0.0:8080/myapp/myservice?httpBindingRef=mybinding"/><to uri="bean:doSomething"/></route> --------------------------------------------------------------------------------------------------------------------------- -[[Jetty-Jettyhandlersandsecurityconfiguration]] -Jetty handlers and security configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Jetty handlers and security configuration You can configure a list of Jetty handlers on the endpoint, which can be useful for enabling advanced Jetty security features. These handlers are @@ -686,9 +656,7 @@ from("jetty:http://0.0.0.0:9080/myservice?handlers=securityHandler";) If you need more handlers, set the `handlers` option equal to a comma-separated list of bean IDs. -[[Jetty-HowtoreturnacustomHTTP500replymessage]] -How to return a custom HTTP 500 reply message -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How to return a custom HTTP 500 reply message You may want to return a custom reply message when something goes wrong, instead of the default reply message Camel link:jetty.html[Jetty] @@ -699,9 +667,7 @@ link:exception-clause.html[Exception Clause] to construct the custom reply message. For example as show here, where we return `Dude something went wrong` with HTTP error code 500: -[[Jetty-Multi-partFormsupport]] -Multi-part Form support -^^^^^^^^^^^^^^^^^^^^^^^ +### Multi-part Form support From Camel 2.3.0, camel-jetty support to multipart form post out of box. The submitted form-data are mapped into the message header. Camel-jetty @@ -713,9 +679,7 @@ of the attachment file name. You can find the example here. earlier versions you receive the temporary file name for the attachment instead* -[[Jetty-JettyJMXsupport]] -Jetty JMX support -^^^^^^^^^^^^^^^^^ +### Jetty JMX support From Camel 2.3.0, camel-jetty supports the enabling of Jetty's JMX capabilities at the component and endpoint level with the endpoint @@ -746,14 +710,11 @@ sharing the same MBeanServer between the instances, you can provide both instances with a reference to the same MBeanContainer in order to avoid name collisions when registering Jetty MBeans. -[[Jetty-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:http.html[HTTP] - +* link:http.html[HTTP] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jgroups/src/main/docs/jgroups-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc index d381aa2..384a3b3 100644 --- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc @@ -1,4 +1,4 @@ -# JGroups Component +## JGroups Component *Available since Camel 2.10.0* @@ -33,9 +33,7 @@ Camel *2.13.0* or higher, please use the following POM entry instead. </dependency> ------------------------------------------------------------ -[[JGroups-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ----------------------------- @@ -45,9 +43,7 @@ jgroups:clusterName[?options] Where *clusterName* represents the name of the JGroups cluster the component should connect to. -[[JGroups-Options]] -Options -^^^^^^^ +### Options @@ -93,9 +89,7 @@ The JGroups component supports 7 endpoint options which are listed below: -[[JGroups-Headers]] -Headers -^^^^^^^ +### Headers [width="100%",cols="10%,10%,10%,70%",options="header",] |======================================================================= @@ -116,9 +110,7 @@ consumed message has been extracted. endpoint. |=======================================================================  -[[JGroups-Usage]] -Usage -^^^^^ +### Usage Using `jgroups` component on the consumer side of the route will capture messages received by the `JChannel` associated with the endpoint and @@ -143,9 +135,7 @@ endpoint. from("direct:start").to("jgroups:clusterName"); -------------------------------------------------- -[[JGroups-Predefinedfilters]] -Predefined filters -^^^^^^^^^^^^^^^^^^ +### Predefined filters Starting from version *2.13.0* of Camel, JGroups component comes with predefined filters factory class named `JGroupsFilters.` @@ -168,9 +158,7 @@ from("jgroups:clusterName?enableViewMessages=true"). to("seda:masterNodeEventsQueue"); ---------------------------------------------------------------------------------------- -[[JGroups-Predefinedexpressions]] -Predefined expressions -^^^^^^^^^^^^^^^^^^^^^^ +### Predefined expressions Starting from version *2.13.0* of Camel, JGroups component comes with predefined expressions factory class named `JGroupsExpressions.` @@ -208,13 +196,9 @@ from("jgroups:clusterName?enableViewMessages=true"). from("timer://master?repeatCount=1").routeId("masterRoute").autoStartup(false).to(masterMockUri); ----------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[JGroups-Examples]] -Examples -^^^^^^^^ +### Examples -[[JGroups-SendingreceivingmessagestofromtheJGroupscluster]] -Sending (receiving) messages to (from) the JGroups cluster -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Sending (receiving) messages to (from) the JGroups cluster In order to send message to the JGroups cluster use producer endpoint, just as demonstrated on the snippet below. @@ -240,9 +224,7 @@ from("jgroups:myCluster").to("mock:messagesFromTheCluster"); mockEndpoint.assertIsSatisfied(); ------------------------------------------------------------ -[[JGroups-Receiveclusterviewchangenotifications]] -Receive cluster view change notifications -+++++++++++++++++++++++++++++++++++++++++ +#### Receive cluster view change notifications The snippet below demonstrates how to create the consumer endpoint listening to the notifications regarding cluster membership changes. By @@ -258,9 +240,7 @@ from("jgroups:clusterName?enableViewMessages=true").to(mockEndpoint); mockEndpoint.assertIsSatisfied(); --------------------------------------------------------------------- -[[JGroups-Keepingsingletonroutewithinthecluster]] -Keeping singleton route within the cluster -++++++++++++++++++++++++++++++++++++++++++ +#### Keeping singleton route within the cluster The snippet below demonstrates how to keep the singleton consumer route in the cluster of Camel Contexts. As soon as the master node dies, one @@ -281,4 +261,4 @@ from("jgroups:clusterName?enableViewMessages=true").  to("controlbus:route?routeId=masterRoute&action=start&async=true"); from("jetty:http://localhost:8080/orders";).routeId("masterRoute").autoStartup(false).to("jms:orders"); ------------------------------------------------------------------------------------------------------------------------------------------------------------------ +----------------------------------------------------------------------------------------------------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jibx/src/main/docs/jibx-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc index ec98de0..a322bcb 100644 --- a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc +++ b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc @@ -1,4 +1,4 @@ -# JiBX DataFormat +## JiBX DataFormat *Available as of Camel 2.6* @@ -26,9 +26,7 @@ from("mqseries:Another.Queue"). to("activemq:My.Queue"); ------------------------------------------- -[[JiBX-Options]] -Options -^^^^^^^ +### Options // dataformat options: START The JiBX dataformat supports 3 options which are listed below. @@ -47,9 +45,7 @@ The JiBX dataformat supports 3 options which are listed below. // dataformat options: END -[[JiBX-JiBXSpringDSL]] -JiBX Spring DSL -^^^^^^^^^^^^^^^ +### JiBX Spring DSL JiBX data format is also supported by Camel Spring DSL. @@ -79,9 +75,7 @@ JiBX data format is also supported by Camel Spring DSL. </camelContext> -------------------------------------------------------------------------------------- -[[JiBX-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use JiBX in your camel routes you need to add the a dependency on *camel-jibx* which implements this data format. @@ -97,4 +91,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-jibx</artifactId> <version>2.6.0</version> </dependency> -------------------------------------- +------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-jing/src/main/docs/jing-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc index 2c4a649..8510f3e 100644 --- a/components/camel-jing/src/main/docs/jing-component.adoc +++ b/components/camel-jing/src/main/docs/jing-component.adoc @@ -1,4 +1,4 @@ -# Jing Component +## Jing Component The Jing component uses the http://www.thaiopensource.com/relaxng/jing.html[Jing Library] to perform @@ -24,9 +24,7 @@ for this component: Note that the link:msv.html[MSV] component can also support RelaxNG XML syntax. -[[Jing-URIformatCamel2.16]] -URI format Camel 2.16 -^^^^^^^^^^^^^^^^^^^^^ +### URI format Camel 2.16 [source,java] ------------------------------ @@ -36,9 +34,7 @@ jing:someLocalOrRemoteResource From Camel 2.16 the component use jing as name, and you can use the option compactSyntax to turn on either RNG or RNC mode. -[[Jing-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -64,9 +60,7 @@ The Jing component supports 3 endpoint options which are listed below: -[[Jing-Example]] -Example -^^^^^^^ +### Example The following http://svn.apache.org/repos/asf/camel/trunk/components/camel-jing/src/test/resources/org/apache/camel/component/validator/jing/rnc-context.xml[example] @@ -76,12 +70,9 @@ based on whether or not the XML matches the given http://relaxng.org/compact-tutorial-20030326.html[RelaxNG Compact Syntax] schema (which is supplied on the classpath). -[[Jing-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-jira/src/main/docs/jira-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jira/src/main/docs/jira-component.adoc b/components/camel-jira/src/main/docs/jira-component.adoc index 28abb51..7ca42ac 100644 --- a/components/camel-jira/src/main/docs/jira-component.adoc +++ b/components/camel-jira/src/main/docs/jira-component.adoc @@ -1,4 +1,4 @@ -# JIRA Component +## JIRA Component *Available as of Camel 2.15* @@ -31,18 +31,14 @@ for this component: </dependency> --------------------------------------- -[[JIRA-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,text] ------------------------- jira://endpoint[?options] ------------------------- -[[JIRA-Options:]] -JIRA Options -^^^^^^^^^^^^^ +### JIRA Options // component options: START @@ -75,9 +71,7 @@ The JIRA component supports 10 endpoint options which are listed below: -[[JIRA-JQL:]] -JQL: -^^^^ +### JQL: The JQL URI option is used by both consumer endpoints.  Theoretically, items like "project key", etc. could be URI options themselves. @@ -107,4 +101,4 @@ delay, etc.  Example: [source,text] ---------------------------------------------------------------------------------------------------------------------------------------------- jira://[endpoint]?[required options]&jql=RAW(project=[project key] AND status in (Open, \"Coding In Progress\") AND \"Number of comments\">0)" ----------------------------------------------------------------------------------------------------------------------------------------------- +---------------------------------------------------------------------------------------------------------------------------------------------- \ No newline at end of file
