You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2017/01/11 18:27:11 UTC
[06/14] camel git commit: Use single line header for adoc files
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mail/src/main/docs/mail-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc
index 177051c..c1a3199 100644
--- a/components/camel-mail/src/main/docs/mail-component.adoc
+++ b/components/camel-mail/src/main/docs/mail-component.adoc
@@ -1,4 +1,4 @@
-# Mail Component
+## Mail Component
The mail component provides access to Email via Spring's Mail support
and the underlying JavaMail system.
@@ -44,9 +44,7 @@ environments where you need to send mails to a real mail server. Just
the presence of the mock-javamail.jar on the classpath means that it
will kick in and avoid sending the mails.
-[[Mail-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
Mail endpoints can have one of the following URI formats (for the
protocols, SMTP, POP3, or IMAP, respectively):
@@ -73,8 +71,7 @@ You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Mail-Component-Options]]
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[Mail-Component-Options]]
// component options: START
@@ -94,8 +91,7 @@ The Mail component supports 2 options which are listed below.
-[[Mail-Endpoint-Options]]
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[Mail-Endpoint-Options]]
// endpoint options: START
@@ -175,9 +171,7 @@ The Mail component supports 63 endpoint options which are listed below:
-[[Mail-Sampleendpoints]]
-Sample endpoints
-++++++++++++++++
+#### Sample endpoints
Typically, you specify a URI with login credentials as follows (taking
SMTP as an example):
@@ -202,9 +196,7 @@ For example:
smtp://mycompany.mailserver:30?password=tiger&username=scott
------------------------------------------------------------
-[[Mail-Components]]
-Components
-^^^^^^^^^^
+### Components
- link:imap.html[IMAP]
- link:imaps.html[IMAPs]
@@ -213,9 +205,7 @@ Components
- link:smtp.html[STMP]
- link:smtps.html[SMTPs]
-[[Mail-DefaultPortsDefaultports]]
-Default ports
-+++++++++++++
+#### Default ports
Default port numbers are supported. If the port number is omitted, Camel
determines the port number to use based on the protocol.
@@ -231,9 +221,7 @@ determines the port number to use based on the protocol.
|`IMAPS` |`993`
|=======================================================================
-[[Mail-SSLsupport]]
-SSL support
-^^^^^^^^^^^
+### SSL support
The underlying mail framework is responsible for providing SSL support.
�You may either configure SSL/TLS support by completely specifying the
@@ -241,9 +229,7 @@ necessary Java Mail API configuration options, or you may provide a
configured SSLContextParameters through the component or endpoint
configuration.
-[[Mail-UsingtheJSSEConfigurationUtility]]
-Using the JSSE Configuration Utility
-++++++++++++++++++++++++++++++++++++
+#### Using the JSSE Configuration Utility
As of *Camel 2.10*, the mail component supports SSL/TLS configuration
through the link:camel-configuration-utilities.html[Camel JSSE
@@ -286,9 +272,7 @@ Spring DSL based configuration of endpoint
<to uri="smtps://smtp.google.com?username=user@gmail.com&password=password&sslContextParameters=#sslContextParameters"/>...
---------------------------------------------------------------------------------------------------------------------------
-[[Mail-ConfiguringJavaMailDirectly]]
-Configuring JavaMail Directly
-+++++++++++++++++++++++++++++
+#### Configuring JavaMail Directly
Camel uses SUN JavaMail, which only trusts certificates issued by well
known Certificate Authorities (the default JVM trust configuration). If
@@ -296,9 +280,7 @@ you issue your own certificates, you have to import the CA certificates
into the JVM's Java trust/key store files, override the default JVM
trust/key store files (see `SSLNOTES.txt` in JavaMail for details).
-[[Mail-MailMessageContent]]
-Mail Message Content
-^^^^^^^^^^^^^^^^^^^^
+### Mail Message Content
Camel uses the message exchange's IN body as the
http://java.sun.com/javaee/5/docs/api/javax/mail/internet/MimeMessage.html[MimeMessage]
@@ -321,9 +303,7 @@ server, you should be able to get the message id of the
http://java.sun.com/javaee/5/docs/api/javax/mail/internet/MimeMessage.html[MimeMessage]
with the key `CamelMailMessageId` from the Camel message header.
-[[Mail-Headerstakeprecedenceoverpre-configuredrecipients]]
-Headers take precedence over pre-configured recipients
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Headers take precedence over pre-configured recipients
The recipients specified in the message headers always take precedence
over recipients pre-configured in the endpoint URI. The idea is that if
@@ -349,9 +329,7 @@ pre-configured settings.
template.sendBodyAndHeaders("smtp://admin@localhost?to=info@mycompany.com", "Hello World", headers);
------------------------------------------------------------------------------------------------------------
-[[Mail-Multiplerecipientsforeasierconfiguration]]
-Multiple recipients for easier configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Multiple recipients for easier configuration
It is possible to set multiple recipients using a comma-separated or a
semicolon-separated list. This applies both to header settings and to
@@ -365,9 +343,7 @@ settings in an endpoint URI. For example:
The preceding example uses a semicolon, `;`, as the separator character.
-[[Mail-Settingsendernameandemail]]
-Setting sender name and email
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Setting sender name and email
You can specify recipients in the format, `name <email>`, to include
both the name and the email address of the recipient.
@@ -383,9 +359,7 @@ map.put("From", "James Strachan <js...@apache.org>");
map.put("Subject", "Camel is cool");
---------------------------------------------------------
-[[Mail-JavaMailAPI(exSUNJavaMail)]]
-JavaMail API (ex SUN JavaMail)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### JavaMail API (ex SUN JavaMail)
https://java.net/projects/javamail/pages/Home[JavaMail API] is used
under the hood for consuming and producing mails. +
@@ -401,9 +375,7 @@ IMAP API]
https://javamail.java.net/nonav/docs/api/javax/mail/Flags.html[MAIL
Flags]
-[[Mail-Samples]]
-Samples
-^^^^^^^
+### Samples
We start with a simple route that sends the messages received from a JMS
queue as emails. The email account is the `admin` account on
@@ -427,9 +399,7 @@ from("imap://admin@mymailserver.com
In this sample we want to send a mail to multiple recipients:
-[[Mail-Sendingmailwithattachmentsample]]
-Sending mail with attachment sample
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Sending mail with attachment sample
WARNING: *Attachments are not support by all Camel components*
@@ -445,9 +415,7 @@ The mail component supports attachments. In the sample below, we send a
mail message containing a plain text message with a logo file
attachment.
-[[Mail-SSLsample]]
-SSL sample
-^^^^^^^^^^
+### SSL sample
In this sample, we want to poll our Google mail inbox for mails. To
download mail onto a local mail client, Google mail requires you to
@@ -476,9 +444,7 @@ progress in the logs:
2008-05-08 06:32:12,187 INFO newmail - Exchange[MailMessage: messageNumber=[332], from=[James Bond <00...@mi5.co.uk>], to=YOUR_USERNAME@gmail.com], subject=[...
------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[Mail-Consumingmailswithattachmentsample]]
-Consuming mails with attachment sample
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Consuming mails with attachment sample
In this sample we poll a mailbox and store all attachments from the
mails as files. First, we define a route to poll the mailbox. As this
@@ -523,9 +489,7 @@ As you can see the API to handle attachments is a bit clunky but it's
there so you can get the `javax.activation.DataHandler` so you can
handle the attachments using standard API.
-[[Mail-Howtosplitamailmessagewithattachments]]
-How to split a mail message with attachments
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to split a mail message with attachments
In this example we consume mail messages which may have a number of
attachments. What we want to do is to use the
@@ -570,9 +534,7 @@ SplitAttachmentsExpression split = SplitAttachmentsExpression(true);
And then use the expression with the splitter eip.
-[[Mail-UsingcustomSearchTerm]]
-Using custom SearchTerm
-^^^^^^^^^^^^^^^^^^^^^^^
+### Using custom SearchTerm
*Available as of Camel 2.11*
@@ -660,12 +622,9 @@ builder.unseen().body(Op.not, "Spam").subject(Op.not, "Spam")
SearchTerm term = builder.build();
--------------------------------------------------------------
-[[Mail-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-mail/src/main/docs/mime-multipart-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc
index 80c6498..52f3675 100644
--- a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc
+++ b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc
@@ -1,4 +1,4 @@
-# MIME Multipart DataFormat
+## MIME Multipart DataFormat
*Available as of Camel 2.17*
@@ -40,9 +40,7 @@ empty message. Up to Camel version 2.17.1 this will happen all message
bodies that do not contain a MIME multipart message regardless of body
type and stream cache setting.
-[[MIME-Multipart-Options]]
-Options
-^^^^^^^
+### Options
// dataformat options: START
The MIME Multipart dataformat supports 6 options which are listed below.
@@ -63,9 +61,7 @@ The MIME Multipart dataformat supports 6 options which are listed below.
{% endraw %}
// dataformat options: END
-[[MIME-Multipart-MessageHeadersmarshal]]
-Message Headers (marshal)
-^^^^^^^^^^^^^^^^^^^^^^^^^
+### Message Headers (marshal)
[width="100%",cols="20%,20%,60%",options="header",]
|=======================================================================
@@ -89,9 +85,7 @@ body part. Furthermore the given charset is applied for text to binary
conversions.
|=======================================================================
-[[MIME-Multipart-MessageHeadersunmarshal]]
-Message Headers (unmarshal)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Message Headers (unmarshal)
[width="100%",cols="20%,20%,60%",options="header",]
|=======================================================================
@@ -111,9 +105,7 @@ from MIME endoding descriptor to Java encoding descriptor)
MIME multipart. The header is removed afterwards
|=======================================================================
-[[MIME-Multipart-Examples]]
-Examples
-^^^^^^^^
+### Examples
[source,java]
-----------------------------------
@@ -191,9 +183,7 @@ Content-Disposition: attachment; filename="Attachment File Name"
------=_Part_0_1134128170.1447659361365
----------------------------------------------------------------
-[[MIME-Multipart-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use MIME-Multipart in your Camel routes you need to add a dependency
on *camel-mail* which implements this data format.
@@ -207,4 +197,4 @@ If you use Maven you can just add the following to your pom.xml:
<artifactId>camel-mail</artifactId>
<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-metrics/src/main/docs/metrics-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc
index cec5e5f..1e14bbc 100644
--- a/components/camel-metrics/src/main/docs/metrics-component.adoc
+++ b/components/camel-metrics/src/main/docs/metrics-component.adoc
@@ -1,4 +1,4 @@
-# Metrics Component
+## Metrics Component
ifdef::env-github[]
:caution-caption: :boom:
:important-caption: :exclamation:
@@ -7,9 +7,7 @@ ifdef::env-github[]
:warning-caption: :warning:
endif::[]
-[[MetricsComponent-MetricsComponent]]
-Metrics Component
-~~~~~~~~~~~~~~~~~
+### Metrics Component
*Available as of Camel 2.14*
@@ -36,18 +34,14 @@ for this component:
</dependency>
----
-[[MetricsComponent-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source]
----
metrics:[ meter | counter | histogram | timer | gauge ]:metricname[?options]
----
-[[MetricsComponent-options]]
-Options
-^^^^^^^
+### Options
// component options: START
The Metrics component supports 1 options which are listed below.
@@ -86,9 +80,7 @@ The Metrics component supports 9 endpoint options which are listed below:
-[[MetricsComponent-registryMetricRegistry]]
-[[MetricsComponent-registry]]Metric Registry
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-registry]]Metric Registry
Camel Metrics component uses by default a `MetricRegistry` instance with
a `Slf4jReporter` that has a 60 second reporting interval.
@@ -150,9 +142,7 @@ public API in version DropWizard `3.0.1` for users to clean up on exit. Thus usi
Camel Metrics Component leads to Java classloader leak and my cause
`OutOfMemoryErrors` in some cases.
-[[MetricsComponent-Usage]]
-Usage
-^^^^^
+### Usage
Each metric has type and name. Supported types are
link:#MetricsComponent-counter[counter],
@@ -160,9 +150,7 @@ link:#MetricsComponent-histogram[histogram],�link:#MetricsComponent-meter[meter
link:#MetricsComponent-timer[timer] and link:#MetricsComponent-gauge[gauge].
Metric name is simple string. If metric type is not provided then type meter is used by default.
-[[MetricsComponent-Headers]]
-Headers
-+++++++
+#### Headers
Metric name defined in URI can be overridden by using header with name
`CamelMetricsName`.
@@ -184,18 +172,14 @@ endpoint finishes processing of exchange. While processing exchange
Metrics endpoint will catch all exceptions and write log entry using
level `warn`.
-[[MetricsComponent-counterMetricstypecounter]]
-[[MetricsComponent-counter]]Metrics type counter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-counter]]Metrics type counter
[source]
----
metrics:counter:metricname[?options]
----
-[[MetricsComponent-Options]]
-Options
-+++++++
+#### Options
[width="100%",cols="10%,10%,80%",options="header",]
|=====================================================
@@ -232,9 +216,7 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-Headers.1]]
-Headers
-+++++++
+#### Headers
Message headers can be used to override `increment` and `decrement`
values specified in Metrics component URI.
@@ -265,18 +247,14 @@ from("direct:in")
----
-[[MetricsComponent-histogramMetrictypehistogram]]
-[[MetricsComponent-histogram]]Metric type histogram
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-histogram]]Metric type histogram
[source]
----
metrics:histogram:metricname[?options]
----
-[[MetricsComponent-Options.1]]
-Options
-+++++++
+#### Options
[width="100%",cols="10%,10%,80%",options="header",]
|===================================
@@ -304,9 +282,7 @@ from("direct:in")
----
-[[MetricsComponent-Headers.2]]
-Headers
-+++++++
+#### Headers
Message header can be used to override value specified in Metrics
component URI.
@@ -327,18 +303,14 @@ from("direct:in")
----
-[[MetricsComponent-meterMetrictypemeter]]
-[[MetricsComponent-meter]]Metric type meter
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-meter]]Metric type meter
[source]
----
metrics:meter:metricname[?options]
----
-[[MetricsComponent-Options.2]]
-Options
-+++++++
+#### Options
[width="100%",cols="10%,10%,80%",options="header",]
|===================================
@@ -364,9 +336,7 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-Headers.3]]
-Headers
-+++++++
+#### Headers
Message header can be used to override `mark` value specified in Metrics
component URI.
@@ -386,18 +356,14 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-timerMetricstypetimer]]
-[[MetricsComponent-timer]]Metrics type timer
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-timer]]Metrics type timer
[source]
----
metrics:timer:metricname[?options]
----
-[[MetricsComponent-Options.3]]
-Options
-+++++++
+#### Options
[width="100%",cols="10%,10%,80%",options="header",]
|==========================
@@ -422,9 +388,7 @@ from("direct:in")
`TimerContext` objects are stored as Exchange properties between
different Metrics component calls.
-[[MetricsComponent-Headers.4]]
-Headers
-+++++++
+#### Headers
Message header can be used to override action value specified in Metrics
component URI.
@@ -445,18 +409,14 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-gaugeMetrictypegauge]]
-[[MetricsComponent-gauge]]Metric type gauge
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### [[MetricsComponent-gauge]]Metric type gauge
[source]
----
metrics:gauge:metricname[?options]
----
-[[MetricsComponent-Options.4]]
-Options
-+++++++
+#### Options
[width="100%",cols="10%,10%,80%",options="header",]
|=====================================================
@@ -474,9 +434,7 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-Headers.5]]
-Headers
-+++++++
+#### Headers
Message headers can be used to override `subject` values specified in Metrics component URI.
Note: if `CamelMetricsName` header is specified, then new gauge is registered in addition to
@@ -497,9 +455,7 @@ from("direct:in")
.to("direct:out");
----
-[[MetricsComponent-MetricsRoutePolicyFactory]]
-MetricsRoutePolicyFactory
-^^^^^^^^^^^^^^^^^^^^^^^^^
+### MetricsRoutePolicyFactory
This factory allows to add a�link:routepolicy.html[RoutePolicy] for each
route which exposes route utilization statistics using Dropwizard metrics.
@@ -577,9 +533,7 @@ if (registryService != null) {
}
----
-[[MetricsComponent-MetricsMessageHistoryFactory]]
-MetricsMessageHistoryFactory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### MetricsMessageHistoryFactory
*Available as of Camel 2.17*
@@ -655,9 +609,7 @@ String json = service.dumpStatisticsAsJson();
And the JMX API the MBean is registered in the�`type=services` tree
with�`name=MetricsMessageHistoryService`.
-[[MetricsComponent-InstrumentedThreadPoolFactory]]
-InstrumentedThreadPoolFactory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### InstrumentedThreadPoolFactory
*Available as of Camel 2.18*
@@ -666,9 +618,7 @@ which collects information from inside of Camel.
See more details at link:advanced-configuration-of-camelcontext-using-spring.html[Advanced configuration of CamelContext using Spring]
-[[MetricsComponent-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* The `camel-example-cdi-metrics` example that illustrates the integration
- between Camel, Metrics and CDI.
+ between Camel, Metrics and CDI.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mina/src/main/docs/mina-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/docs/mina-component.adoc b/components/camel-mina/src/main/docs/mina-component.adoc
index 47e641b..05c3854 100644
--- a/components/camel-mina/src/main/docs/mina-component.adoc
+++ b/components/camel-mina/src/main/docs/mina-component.adoc
@@ -1,4 +1,4 @@
-# Mina Component
+## Mina Component
*Deprecated*
@@ -21,9 +21,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MINA-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
------------------------------------
@@ -57,9 +55,7 @@ exchange itself over the wire. See options below.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[MINA-Options]]
-Options
-^^^^^^^
+### Options
@@ -124,9 +120,7 @@ The Mina component supports 24 endpoint options which are listed below:
-[[MINA-Usingacustomcodec]]
-Using a custom codec
-^^^^^^^^^^^^^^^^^^^^
+### Using a custom codec
See the http://mina.apache.org/tutorial-on-protocolcodecfilter.html[Mina
documentation] how to write your own codec. To use your custom codec
@@ -135,9 +129,7 @@ link:registry.html[Registry]; for example, by creating a bean in the
Spring XML file. Then use the `codec` option to specify the bean ID of
your codec. See link:hl7.html[HL7] that has a custom codec.
-[[MINA-Samplewithsync=false]]
-Sample with sync=false
-^^^^^^^^^^^^^^^^^^^^^^
+### Sample with sync=false
In this sample, Camel exposes a service that listens for TCP connections
on port 6200. We use the *textline* codec. In our route, we create a
@@ -146,9 +138,7 @@ Mina consumer endpoint that listens on port 6200:
As the sample is part of a unit test, we test it by sending some data to
it on port 6200.
-[[MINA-Samplewithsync=true]]
-Sample with sync=true
-^^^^^^^^^^^^^^^^^^^^^
+### Sample with sync=true
In the next sample, we have a more common use case where we expose a TCP
service on port 6201 also use the textline codec. However, this time we
@@ -160,9 +150,7 @@ using the `template.requestBody()` method. As we know the response is a
`String`, we cast it to `String` and can assert that the response is, in
fact, something we have dynamically set in our processor code logic.
-[[MINA-SamplewithSpringDSL]]
-Sample with Spring DSL
-^^^^^^^^^^^^^^^^^^^^^^
+### Sample with Spring DSL
Spring DSL can, of course, also be used for link:mina.html[MINA]. In the
sample below we expose a TCP server on port 5555:
@@ -188,9 +176,7 @@ could be implemented as follows:
}
-----------------------------------------------
-[[MINA-ConfiguringMinaendpointsusingSpringbeanstyle]]
-Configuring Mina endpoints using Spring bean style
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Configuring Mina endpoints using Spring bean style
Configuration of Mina endpoints is possible using regular Spring bean
style configuration in the Spring DSL.
@@ -206,9 +192,7 @@ The sample below shows the factory approach:
And then we can refer to our endpoint directly in the route, as follows:
-[[MINA-ClosingSessionWhenComplete]]
-Closing Session When Complete
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Closing Session When Complete
When acting as a server you sometimes want to close the session when,
for example, a client conversion is finished. To instruct Camel to close
@@ -229,9 +213,7 @@ written the `bye` message back to the client:
});
--------------------------------------------------------------------------------------------------
-[[MINA-GettheIoSessionformessage]]
-Get the IoSession for message
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Get the IoSession for message
*Available since Camel 2.1*
You can get the IoSession from the message header with this key
@@ -239,9 +221,7 @@ MinaEndpoint.HEADER_MINA_IOSESSION, and also get the local host address
with the key MinaEndpoint.HEADER_LOCAL_ADDRESS and remote host address
with the key MinaEndpoint.HEADER_REMOTE_ADDRESS.
-[[MINA-ConfiguringMinafilters]]
-Configuring Mina filters
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Configuring Mina filters
Filters permit you to use some Mina Filters, such as `SslFilter`. You
can also implement some customized filters. Please note that `codec` and
@@ -334,9 +314,7 @@ Then, you can configure your endpoint using Spring DSL:
</bean>
----------------------------------------------------------------------------------
-[[MINA-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
@@ -344,5 +322,4 @@ See Also
* link:getting-started.html[Getting Started]
* link:mina2.html[MINA2]
-* link:netty.html[Netty]
-
+* link:netty.html[Netty]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mina2/src/main/docs/mina2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/docs/mina2-component.adoc b/components/camel-mina2/src/main/docs/mina2-component.adoc
index 1975038..ab73083 100644
--- a/components/camel-mina2/src/main/docs/mina2-component.adoc
+++ b/components/camel-mina2/src/main/docs/mina2-component.adoc
@@ -1,4 +1,4 @@
-# Mina2 Component
+## Mina2 Component
*Available as of Camel 2.10*
@@ -24,9 +24,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MINA2-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-------------------------------------
@@ -58,9 +56,7 @@ exchange itself over the wire. See options below.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[MINA2-Options]]
-Options
-^^^^^^^
+### Options
@@ -130,9 +126,7 @@ The Mina2 component supports 29 endpoint options which are listed below:
-[[MINA2-Usingacustomcodec]]
-Using a custom codec
-^^^^^^^^^^^^^^^^^^^^
+### Using a custom codec
See the Mina how to write your own codec. To use your custom codec with
`camel-mina`, you should register your codec in the
@@ -140,9 +134,7 @@ link:registry.html[Registry]; for example, by creating a bean in the
Spring XML file. Then use the `codec` option to specify the bean ID of
your codec. See link:hl7.html[HL7] that has a custom codec.
-[[MINA2-Samplewithsyncfalse]]
-Sample with sync=false
-^^^^^^^^^^^^^^^^^^^^^^
+### Sample with sync=false
In this sample, Camel exposes a service that listens for TCP connections
on port 6200. We use the *textline* codec. In our route, we create a
@@ -166,9 +158,7 @@ template.sendBody("mina2:tcp://localhost:" + port1 + "?textline=true&sync=false"
assertMockEndpointsSatisfied();
-------------------------------------------------------------------------------------------------
-[[MINA2-Samplewithsynctrue]]
-Sample with sync=true
-^^^^^^^^^^^^^^^^^^^^^
+### Sample with sync=true
In the next sample, we have a more common use case where we expose a TCP
service on port 6201 also use the textline codec. However, this time we
@@ -196,9 +186,7 @@ String response = (String)template.requestBody("mina2:tcp://localhost:" + port2
assertEquals("Bye World", response);
-----------------------------------------------------------------------------------------------------------------------
-[[MINA2-SamplewithSpringDSL]]
-Sample with Spring DSL
-^^^^^^^^^^^^^^^^^^^^^^
+### Sample with Spring DSL
Spring DSL can, of course, also be used for link:mina.html[MINA]. In the
sample below we expose a TCP server on port 5555:
@@ -224,9 +212,7 @@ could be implemented as follows:
}
-----------------------------------------------
-[[MINA2-ClosingSessionWhenComplete]]
-Closing Session When Complete
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Closing Session When Complete
When acting as a server you sometimes want to close the session when,
for example, a client conversion is finished. To instruct Camel to close
@@ -247,18 +233,14 @@ written the `bye` message back to the client:
});
---------------------------------------------------------------------------------------------------
-[[MINA2-GettheIoSessionformessage]]
-Get the IoSession for message
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Get the IoSession for message
You can get the IoSession from the message header with this key
`Mina2Constants.MINA_IOSESSION`, and also get the local host address
with the key `Mina2Constants.MINA_LOCAL_ADDRESS` and remote host address
with the key `Mina2Constants.MINA_REMOTE_ADDRESS`.
-[[MINA2-ConfiguringMinafilters]]
-Configuring Mina filters
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Configuring Mina filters
Filters permit you to use some Mina Filters, such as `SslFilter`. You
can also implement some customized filters. Please note that `codec` and
@@ -266,9 +248,7 @@ can also implement some customized filters. Please note that `codec` and
filters you may define are appended to the end of the filter chain; that
is, after `codec` and `logger`.
-[[MINA2-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
@@ -276,5 +256,4 @@ See Also
* link:getting-started.html[Getting Started]
* link:mina.html[MINA]
-* link:netty.html[Netty]
-
+* link:netty.html[Netty]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mllp/src/main/docs/mllp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc
index f9875bc..fe9d081 100644
--- a/components/camel-mllp/src/main/docs/mllp-component.adoc
+++ b/components/camel-mllp/src/main/docs/mllp-component.adoc
@@ -1,4 +1,4 @@
-# MLLP Component
+## MLLP Component
*available as of Camel 2.17*
@@ -35,9 +35,7 @@ for this component:
</dependency>
---------------------------------------------------------
-[[MLLP-MLLPOptions]]
-MLLP Options
-~~~~~~~~~~~~
+### MLLP Options
@@ -93,9 +91,7 @@ The MLLP component supports 24 endpoint options which are listed below:
-[[MLLP-MLLPConsumer]]
-MLLP Consumer
-~~~~~~~~~~~~~
+### MLLP Consumer
The MLLP Consumer supports receiving MLLP-framed messages and sending
HL7 Acknowledgements. �The MLLP Consumer can automatically generate the
@@ -105,9 +101,7 @@ the�CamelMllpAcknowledgement exchange property. �Additionally, the type
of acknowledgement that will be generated can be controlled by setting
the CamelMllpAcknowledgementType exchange property.
-[[MLLP-MessageHeaders]]
-*Message Headers*
-^^^^^^^^^^^^^^^^^
+### *Message Headers*
The MLLP Consumer adds these headers on the Camel message:
@@ -134,9 +128,7 @@ The MLLP Consumer adds these headers on the Camel message:
All headers�are�String�types. If a header value is missing, its value
is�null.
-[[MLLP-ExchangeProperties]]
-*Exchange Properties*
-^^^^^^^^^^^^^^^^^^^^^
+### *Exchange Properties*
The type of acknowledgment the MLLP Consumer generates can be controlled
by these properties on the Camel exchange:
@@ -151,13 +143,9 @@ by these properties on the Camel exchange:
All headers�are�String�types. If a header value is missing, its value
is�null.
-[[MLLP-ConsumerConfiguration]]
-Consumer Configuration
-^^^^^^^^^^^^^^^^^^^^^^
+### Consumer Configuration
-[[MLLP-MLLPProducer]]
-MLLP Producer
-~~~~~~~~~~~~~
+### MLLP Producer
The MLLP Producer supports sending MLLP-framed messages and receiving
HL7 Acknowledgements. �The MLLP Producer interrogates the HL7
@@ -165,9 +153,7 @@ Acknowledgments and raises exceptions if a negative acknowledgement is
received. �The received acknowledgement is interrogated and an exception
is raised in the event of a negative acknowledgement.
-[[MLLP-MessageHeaders.1]]
-*Message Headers*
-^^^^^^^^^^^^^^^^^
+### *Message Headers*
The MLLP Producer adds these headers on the Camel message:
@@ -181,7 +167,4 @@ The MLLP Producer adds these headers on the Camel message:
|===================================
All headers�are�String�types. If a header value is missing, its value
-is�null.
-
-
-
+is�null.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc
index f66c8af..67525ea 100644
--- a/components/camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc
+++ b/components/camel-mongodb-gridfs/src/main/docs/gridfs-component.adoc
@@ -1,4 +1,4 @@
-# MongoDBGridFS Component
+## MongoDBGridFS Component
*Available as of Camel 2.17*
@@ -15,18 +15,14 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MongoDBGridFS-URIformat]]
-URI format
-~~~~~~~~~~
+### URI format
[source,java]
------------------------------------------------------------------------------
gridfs:connectionBean?database=databaseName&bucket=bucketName[&moreOptions...]
------------------------------------------------------------------------------
-[[MongoDBGridFS-options]]
-MongoDB GridFS options
-~~~~~~~~~~~~~~~~~~~~~~
+### MongoDB GridFS options
// component options: START
@@ -67,9 +63,7 @@ The MongoDBGridFS component supports 18 endpoint options which are listed below:
-[[MongoDBGridFS-ConfigurationofdatabaseinSpringXML]]
-Configuration of database in Spring XML
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Configuration of database in Spring XML
The following Spring XML creates a bean defining the connection to a
MongoDB instance.
@@ -86,9 +80,7 @@ MongoDB instance.
</beans>
----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDBGridFS-Sampleroute]]
-Sample route
-^^^^^^^^^^^^
+### Sample route
The following route defined in Spring XML executes the operation
link:mongodb-gridfs.html[*findOne*] on a collection.
@@ -107,13 +99,9 @@ link:mongodb-gridfs.html[*findOne*] on a collection.
�
-[[MongoDBGridFS-GridFSoperations-producerendpoint]]
-GridFS operations - producer endpoint
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### GridFS operations - producer endpoint
-[[MongoDBGridFS-count]]
-count
-+++++
+#### count
Returns the total number of file in the collection, returning an Integer
as the OUT message body. +
@@ -136,9 +124,7 @@ headers.put(Exchange.FILE_NAME, "filename.txt");
Integer count = template.requestBodyAndHeaders("direct:count", query, headers);
-------------------------------------------------------------------------------
-[[MongoDBGridFS-listAll]]
-listAll
-+++++++
+#### listAll
Returns an Reader that lists all the filenames and their IDs in a tab
separated stream.
@@ -154,9 +140,7 @@ filename2.txt 2897651254
�
-[[MongoDBGridFS-findOne]]
-*findOne*
-+++++++++
+#### *findOne*
Finds a file in the GridFS system and sets the body to an InputStream of
the content. � Also provides the metadata has headers. �It uses
@@ -173,9 +157,7 @@ InputStream result = template.requestBodyAndHeaders("direct:findOne", "irrelevan
�
-[[MongoDBGridFS-create]]
-create
-++++++
+#### create
Creates a new file in the GridFs database. It uses the
Exchange.FILE_NAME from the incoming headers for the name and the body
@@ -190,9 +172,7 @@ InputStream stream = ... the data for the file ...
template.requestBodyAndHeaders("direct:create", stream, headers);
------------------------------------------------------------------------
-[[MongoDBGridFS-remove]]
-remove
-++++++
+#### remove
Removes a file from the GridFS database.
@@ -204,9 +184,7 @@ headers.put(Exchange.FILE_NAME, "filename.txt");
template.requestBodyAndHeaders("direct:remove", "", headers);
------------------------------------------------------------------------
-[[MongoDBGridFS-GridFSConsumer]]
-GridFS Consumer
-^^^^^^^^^^^^^^^
+### GridFS Consumer
See also
@@ -216,5 +194,4 @@ See also
current version]
*
http://svn.apache.org/viewvc/camel/trunk/components/camel-mongodb/src/test/[Unit
-tests] for more examples of usage
-
+tests] for more examples of usage
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mongodb/src/main/docs/mongodb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
index ff04df5..e3c5222 100644
--- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
+++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
@@ -1,4 +1,4 @@
-# MongoDB Component
+## MongoDB Component
*Available as of Camel 2.10*
@@ -40,18 +40,14 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MongoDB-URIformat]]
-URI format
-~~~~~~~~~~
+### URI format
[source,java]
---------------------------------------------------------------------------------------------------------------
mongodb:connectionBean?database=databaseName&collection=collectionName&operation=operationName[&moreOptions...]
---------------------------------------------------------------------------------------------------------------
-[[MongoDB-options]]
-MongoDB options
-~~~~~~~~~~~~~~~
+### MongoDB options
// component options: START
@@ -103,9 +99,7 @@ The MongoDB component supports 24 endpoint options which are listed below:
-[[MongoDB-ConfigurationofdatabaseinSpringXML]]
-Configuration of database in Spring XML
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Configuration of database in Spring XML
The following Spring XML creates a bean defining the connection to a
MongoDB instance.
@@ -123,9 +117,7 @@ MongoDB instance.
</beans>
----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Sampleroute]]
-Sample route
-^^^^^^^^^^^^
+### Sample route
The following route defined in Spring XML executes the operation
link:mongodb.html[*dbStats*] on a collection.
@@ -142,17 +134,11 @@ link:mongodb.html[*dbStats*] on a collection.
</route>
---------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-MongoDBoperations-producerendpoints]]
-MongoDB operations - producer endpoints
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### MongoDB operations - producer endpoints
-[[MongoDB-Queryoperations]]
-Query operations
-^^^^^^^^^^^^^^^^
+### Query operations
-[[MongoDB-findById]]
-findById
-++++++++
+#### findById
This operation retrieves only one element from the collection whose _id
field matches the content of the IN message body. The incoming object
@@ -172,9 +158,7 @@ from("direct:findById")
TIP: *Supports optional parameters*. This operation supports specifying a fields filter. See
link:mongodb.html[Specifying optional parameters].
-[[MongoDB-findOneByQuery]]
-findOneByQuery
-++++++++++++++
+#### findOneByQuery
Use this operation to retrieve just one element from the collection that
matches a MongoDB query. *The query object is extracted from the IN
@@ -204,9 +188,7 @@ from("direct:findOneByQuery")
TIP: *Supports optional parameters*. This operation supports specifying a fields filter and/or a sort clause. See
link:mongodb.html[Specifying optional parameters].
-[[MongoDB-findAll]]
-findAll
-+++++++
+#### findAll
The `findAll` operation returns all documents matching a query, or none
at all, in which case all documents contained in the collection are
@@ -276,9 +258,7 @@ consideration. |int/Integer
TIP: *Supports optional parameters*. This operation supports specifying a fields filter and/or a sort clause. See
link:mongodb.html[Specifying optional parameters].
-[[MongoDB-count]]
-count
-+++++
+#### count
Returns the total number of objects in a collection, returning a Long as
the OUT message body. +
@@ -307,9 +287,7 @@ DBObject query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Specifyingoptionalparameters]]
-Specifying a fields filter (projection)
-+++++++++++++++++++++++++++++++++++++++
+#### Specifying a fields filter (projection)
Query operations will, by default, return the matching objects in their
entirety (with all their fields). If your documents are large and you
@@ -330,8 +308,7 @@ DBObject fieldFilter = BasicDBObjectBuilder.start().add("_id", 0).add("boringFie
Object result = template.requestBodyAndHeader("direct:findAll", (Object) null, MongoDbConstants.FIELDS_FILTER, fieldFilter);
----------------------------------------------------------------------------------------------------------------------------
-Specifying a sort clause
-++++++++++++++++++++++++
+#### Specifying a sort clause
There is a often a requirement to fetch the min/max record from a
collection based on sorting by a particular field. In Mongo the
@@ -364,13 +341,9 @@ to a single field, based on the `documentTimestamp` field:
----------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Create/updateoperations]]
-Create/update operations
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Create/update operations
-[[MongoDB-insert]]
-insert
-++++++
+#### insert
Inserts an new object into the MongoDB collection, taken from the IN
message body. Type conversion is attempted to turn it into `DBObject` or
@@ -417,9 +390,7 @@ constant). The value stored is�`org.bson.types.ObjectId` for single
insert or `java.util.List<org.bson.types.ObjectId>` if multiple records
have been inserted.
-[[MongoDB-save]]
-save
-++++
+#### save
The save operation is equivalent to an _upsert_ (UPdate, inSERT)
operation, where the record will be updated, and if it doesn't exist, it
@@ -449,9 +420,7 @@ from("direct:insert")
.to("mongodb:myDb?database=flights&collection=tickets&operation=save");
---------------------------------------------------------------------------
-[[MongoDB-update]]
-update
-++++++
+#### update
Update one or multiple records on the collection. Requires a
List<DBObject> as the IN message body containing exactly 2 elements:
@@ -495,13 +464,9 @@ DBObject updateObj = new BasicDBObject("$set", new BasicDBObject("scientist", "D
Object result = template.requestBodyAndHeader("direct:update", new Object[] {filterField, updateObj}, MongoDbConstants.MULTIUPDATE, true);
------------------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Deleteoperations]]
-Delete operations
-^^^^^^^^^^^^^^^^^
+### Delete operations
-[[MongoDB-remove]]
-remove
-++++++
+#### remove
Remove matching records from the collection. The IN message body will
act as the removal filter query, and is expected to be of type
@@ -522,13 +487,9 @@ A header with key `CamelMongoDbRecordsAffected` is returned
containing the number of records deleted (copied from
`WriteResult.getN()`).
-[[MongoDB-Otheroperations]]
-Other operations
-^^^^^^^^^^^^^^^^
+### Other operations
-[[MongoDB-aggregate]]
-aggregate
-+++++++++
+#### aggregate
*Available as of Camel 2.14*
@@ -546,9 +507,7 @@ from("direct:aggregate")
.to("mock:resultAggregate");
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-getDbStats]]
-getDbStats
-++++++++++
+#### getDbStats
Equivalent of running the `db.stats()` command in the MongoDB shell,
which displays useful statistic figures about the database. +
@@ -585,9 +544,7 @@ assertTrue("Result is not of type DBObject", result instanceof DBObject);
The operation will return a data structure similar to the one displayed
in the shell, in the form of a `DBObject` in the OUT message body.
-[[MongoDB-getColStats]]
-getColStats
-+++++++++++
+#### getColStats
Equivalent of running the `db.collection.stats()` command in the MongoDB
shell, which displays useful statistic figures about the collection. +
@@ -627,9 +584,7 @@ assertTrue("Result is not of type DBObject", result instanceof DBObject);
The operation will return a data structure similar to the one displayed
in the shell, in the form of a `DBObject` in the OUT message body.
-[[MongoDB-command]]
-command
-+++++++
+#### command
*Available as of Camel 2.15*
@@ -645,9 +600,7 @@ DBObject commandBody = new BasicDBObject("hostInfo", "1");
Object result = template.requestBody("direct:command", commandBody);
--------------------------------------------------------------------------------
-[[MongoDB-Dynamicoperations]]
-Dynamic operations
-^^^^^^^^^^^^^^^^^^
+### Dynamic operations
An Exchange can override the endpoint's fixed operation by setting the
`CamelMongoDbOperation` header, defined by the
@@ -665,9 +618,7 @@ Object result = template.requestBodyAndHeader("direct:insert", "irrelevantBody",
assertTrue("Result is not of type Long", result instanceof Long);
-----------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-TailableCursorConsumer]]
-Tailable Cursor Consumer
-~~~~~~~~~~~~~~~~~~~~~~~~
+### Tailable Cursor Consumer
MongoDB offers a mechanism to instantaneously consume ongoing data from
a collection, by keeping the cursor open just like the `tail -f` command
@@ -689,9 +640,7 @@ new objects are inserted, MongoDB will push them as DBObjects in natural
order to your tailable cursor consumer, who will transform them to an
Exchange and will trigger your route logic.
-[[MongoDB-Howthetailablecursorconsumerworks]]
-How the tailable cursor consumer works
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How the tailable cursor consumer works
To turn a cursor into a tailable cursor, a few special flags are to be
signalled to MongoDB when first generating the cursor. Once created, the
@@ -742,9 +691,7 @@ The above route will consume from the "flights.cancellations" capped
collection, using "departureTime" as the increasing field, with a
default regeneration cursor delay of 1000ms.
-[[MongoDB-Persistenttailtracking]]
-Persistent tail tracking
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Persistent tail tracking
Standard tail tracking is volatile and the last value is only kept in
memory. However, in practice you will need to restart your Camel
@@ -764,9 +711,7 @@ persisting at regular intervals too in the future (flush every 5
seconds) for added robustness if the demand is there. To request this
feature, please open a ticket in the Camel JIRA.
-[[MongoDB-Enablingpersistenttailtracking]]
-Enabling persistent tail tracking
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Enabling persistent tail tracking
To enable this function, set at least the following options on the
endpoint URI:
@@ -812,9 +757,7 @@ from("mongodb:myDb?database=flights&collection=cancellations&tailTrackIncreasing
.to("mock:test");
-----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-TailtrackingOnOplog]]
-Oplog Tail Tracking
-^^^^^^^^^^^^^^^^^^^
+### Oplog Tail Tracking
The *oplog* collection tracking feature allows to implement trigger like functionality in MongoDB.
In order to activate this collection you will have first to activate a replica set. For more
@@ -928,9 +871,7 @@ public class MongoDbTracker {
-----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Typeconversions]]
-Type conversions
-~~~~~~~~~~~~~~~~
+### Type conversions
The `MongoDbBasicConverters` type converter included with the
camel-mongodb component provides the following conversions:
@@ -954,9 +895,7 @@ object to a `Map`, which is in turn used to initialise a new
This type converter is auto-discovered, so you don't need to configure
anything manually.
-[[MongoDB-Seealso]]
-See also
-~~~~~~~~
+### See also
* http://www.mongodb.org/[MongoDB website]
* http://en.wikipedia.org/wiki/NoSQL[NoSQL Wikipedia article]
@@ -964,5 +903,4 @@ See also
current version]
*
http://svn.apache.org/viewvc/camel/trunk/components/camel-mongodb/src/test/[Unit
-tests] for more examples of usage
-
+tests] for more examples of usage
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
index 7d9f61a..5d069ff 100644
--- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
+++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
@@ -1,4 +1,4 @@
-# MongoDB Component
+## MongoDB Component
*Available as of Camel 2.19*
@@ -42,18 +42,14 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MongoDB-URIformat]]
-URI format
-~~~~~~~~~~
+### URI format
[source,java]
---------------------------------------------------------------------------------------------------------------
mongodb3:connectionBean?database=databaseName&collection=collectionName&operation=operationName[&moreOptions...]
---------------------------------------------------------------------------------------------------------------
-[[MongoDB-options]]
-MongoDB options
-~~~~~~~~~~~~~~~
+### MongoDB options
// component options: START
@@ -106,9 +102,7 @@ readPreference *Remove in camel 2.19.* See Mongo client options <<MongoDB-Config
-[[MongoDB-ConfigurationofdatabaseinSpringXML]]
-Configuration of database in Spring XML
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Configuration of database in Spring XML
The following Spring XML creates a bean defining the connection to a
MongoDB instance.
@@ -134,9 +128,7 @@ xsi:schemaLocation="http://www.springframework.org/schema/context
</beans>
----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Sampleroute]]
-Sample route
-^^^^^^^^^^^^
+### Sample route
The following route defined in Spring XML executes the operation
link:mongodb3.html[*dbStats*] on a collection.
@@ -153,17 +145,11 @@ link:mongodb3.html[*dbStats*] on a collection.
</route>
---------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-MongoDBoperations-producerendpoints]]
-MongoDB operations - producer endpoints
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### MongoDB operations - producer endpoints
-[[MongoDB-Queryoperations]]
-Query operations
-^^^^^^^^^^^^^^^^
+### Query operations
-[[MongoDB-findById]]
-findById
-++++++++
+#### findById
This operation retrieves only one element from the collection whose _id
field matches the content of the IN message body. The incoming object
@@ -183,9 +169,7 @@ from("direct:findById")
TIP: *Supports optional parameters*. This operation supports specifying a fields filter. See
link:mongodb3.html[Specifying optional parameters].
-[[MongoDB-findOneByQuery]]
-findOneByQuery
-++++++++++++++
+#### findOneByQuery
Use this operation to retrieve just one element (the first) from the collection that
matches a MongoDB query. *The query object is extracted `CamelMongoDbCriteria` header*.
@@ -216,9 +200,7 @@ from("direct:findOneByQuery")
TIP: *Supports optional parameters*. This operation supports specifying a fields projection and/or a sort clause. See
link:mongodb3.html[Specifying optional parameters].
-[[MongoDB-findAll]]
-findAll
-+++++++
+#### findAll
The `findAll` operation returns all documents matching a query, or none
at all, in which case all documents contained in the collection are
@@ -290,9 +272,7 @@ consideration. |int/Integer
TIP: *Supports optional parameters*. This operation supports specifying a fields projection and/or a sort clause. See
link:mongodb3.html[Specifying optional parameters].
-[[MongoDB-count]]
-count
-+++++
+#### count
Returns the total number of objects in a collection, returning a Long as
the OUT message body. +
@@ -322,9 +302,7 @@ Document query = ...
Long count = template.requestBodyAndHeader("direct:count", query, MongoDbConstants.COLLECTION, "dynamicCollectionName");
------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Specifyingoptionalparameters]]
-Specifying a fields filter (projection)
-+++++++++++++++++++++++++++++++++++++++
+#### Specifying a fields filter (projection)
Query operations will, by default, return the matching objects in their
entirety (with all their fields). If your documents are large and you
@@ -356,8 +334,7 @@ Bson fieldProjection = Projection.exclude("_id", "boringField");
Object result = template.requestBodyAndHeader("direct:findAll", ObjectUtils.NULL, MongoDbConstants.FIELDS_PROJECTION, fieldProjection);
----------------------------------------------------------------------------------------------------------------------------
-Specifying a sort clause
-++++++++++++++++++++++++
+#### Specifying a sort clause
There is a often a requirement to fetch the min/max record from a
collection based on sorting by a particular field
@@ -391,13 +368,9 @@ to a single field, based on the `documentTimestamp` field:
;
----------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Create/updateoperations]]
-Create/update operations
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Create/update operations
-[[MongoDB-insert]]
-insert
-++++++
+#### insert
Inserts an new object into the MongoDB collection, taken from the IN
message body. Type conversion is attempted to turn it into `Document` or
@@ -444,9 +417,7 @@ have been inserted.
In MongoDB Java Driver 3.x the insertOne and insertMany operation return void.
The Camel insert operation return the Document or List of Documents inserted. Note that each Documents are Updated by a new OID if need.
-[[MongoDB-save]]
-save
-++++
+#### save
The save operation is equivalent to an _upsert_ (UPdate, inSERT)
operation, where the record will be updated, and if it doesn't exist, it
@@ -478,9 +449,7 @@ from("direct:insert")
.to("mongodb3:myDb?database=flights&collection=tickets&operation=save");
---------------------------------------------------------------------------
-[[MongoDB-update]]
-update
-++++++
+#### update
Update one or multiple records on the collection. Requires a filter query and
a update rules.
@@ -549,13 +518,9 @@ Object result = template.requestBodyAndHeader("direct:update", updateObj, MongoD
------------------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Deleteoperations]]
-Delete operations
-^^^^^^^^^^^^^^^^^
+### Delete operations
-[[MongoDB-remove]]
-remove
-++++++
+#### remove
Remove matching records from the collection. The IN message body will
act as the removal filter query, and is expected to be of type
@@ -576,13 +541,9 @@ A header with key `CamelMongoDbRecordsAffected` is returned
containing the number of records deleted (copied from
`WriteResult.getN()`).
-[[MongoDB-Otheroperations]]
-Other operations
-^^^^^^^^^^^^^^^^
+### Other operations
-[[MongoDB-aggregate]]
-aggregate
-+++++++++
+#### aggregate
Perform a aggregation with the given pipeline contained in the
body.�*Aggregations could be long and heavy operations. Use with care.*
@@ -600,9 +561,7 @@ from("direct:aggregate")
.to("mock:resultAggregate");
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-getDbStats]]
-getDbStats
-++++++++++
+#### getDbStats
Equivalent of running the `db.stats()` command in the MongoDB shell,
which displays useful statistic figures about the database. +
@@ -639,9 +598,7 @@ assertTrue("Result is not of type Document", result instanceof Document);
The operation will return a data structure similar to the one displayed
in the shell, in the form of a `Document` in the OUT message body.
-[[MongoDB-getColStats]]
-getColStats
-+++++++++++
+#### getColStats
Equivalent of running the `db.collection.stats()` command in the MongoDB
shell, which displays useful statistic figures about the collection. +
@@ -681,9 +638,7 @@ assertTrue("Result is not of type Document", result instanceof Document);
The operation will return a data structure similar to the one displayed
in the shell, in the form of a `Document` in the OUT message body.
-[[MongoDB-command]]
-command
-+++++++
+#### command
Run the body as a command on database. Usefull for admin operation as
getting host informations, replication or sharding status.
@@ -697,9 +652,7 @@ DBObject commandBody = new BasicDBObject("hostInfo", "1");
Object result = template.requestBody("direct:command", commandBody);
--------------------------------------------------------------------------------
-[[MongoDB-Dynamicoperations]]
-Dynamic operations
-^^^^^^^^^^^^^^^^^^
+### Dynamic operations
An Exchange can override the endpoint's fixed operation by setting the
`CamelMongoDbOperation` header, defined by the
@@ -717,9 +670,7 @@ Object result = template.requestBodyAndHeader("direct:insert", "irrelevantBody",
assertTrue("Result is not of type Long", result instanceof Long);
-----------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-TailableCursorConsumer]]
-Tailable Cursor Consumer
-~~~~~~~~~~~~~~~~~~~~~~~~
+### Tailable Cursor Consumer
MongoDB offers a mechanism to instantaneously consume ongoing data from
a collection, by keeping the cursor open just like the `tail -f` command
@@ -741,9 +692,7 @@ new objects are inserted, MongoDB will push them as `Document` in natural
order to your tailable cursor consumer, who will transform them to an
Exchange and will trigger your route logic.
-[[MongoDB-Howthetailablecursorconsumerworks]]
-How the tailable cursor consumer works
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How the tailable cursor consumer works
To turn a cursor into a tailable cursor, a few special flags are to be
signalled to MongoDB when first generating the cursor. Once created, the
@@ -794,9 +743,7 @@ The above route will consume from the "flights.cancellations" capped
collection, using "departureTime" as the increasing field, with a
default regeneration cursor delay of 1000ms.
-[[MongoDB-Persistenttailtracking]]
-Persistent tail tracking
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Persistent tail tracking
Standard tail tracking is volatile and the last value is only kept in
memory. However, in practice you will need to restart your Camel
@@ -816,9 +763,7 @@ persisting at regular intervals too in the future (flush every 5
seconds) for added robustness if the demand is there. To request this
feature, please open a ticket in the Camel JIRA.
-[[MongoDB-Enablingpersistenttailtracking]]
-Enabling persistent tail tracking
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Enabling persistent tail tracking
To enable this function, set at least the following options on the
endpoint URI:
@@ -864,9 +809,7 @@ from("mongodb3:myDb?database=flights&collection=cancellations&tailTrackIncreasin
.to("mock:test");
-----------------------------------------------------------------------------------------------------------------------------------
-[[MongoDB-Typeconversions]]
-Type conversions
-~~~~~~~~~~~~~~~~
+### Type conversions
The `MongoDbBasicConverters` type converter included with the
camel-mongodb component provides the following conversions:
@@ -887,9 +830,7 @@ object to a `Map`, which is in turn used to initialise a new
This type converter is auto-discovered, so you don't need to configure
anything manually.
-[[MongoDB-Seealso]]
-See also
-~~~~~~~~
+### See also
* http://www.mongodb.org/[MongoDB website]
* http://en.wikipedia.org/wiki/NoSQL[NoSQL Wikipedia article]
@@ -897,5 +838,4 @@ See also
current version]
*
http://svn.apache.org/viewvc/camel/trunk/components/camel-mongodb/src/test/[Unit
-tests] for more examples of usage
-
+tests] for more examples of usage
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-mqtt/src/main/docs/mqtt-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
index c950628..f813c9d 100644
--- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc
+++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
@@ -1,4 +1,4 @@
-# MQTT Component
+## MQTT Component
*Available as of Camel 2.10*
@@ -20,9 +20,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MQTT-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------
@@ -31,9 +29,7 @@ mqtt://name[?options]
Where *name* is the name you want to assign the component.
-[[MQTT-Options]]
-Options
-^^^^^^^
+### Options
@@ -112,9 +108,7 @@ The MQTT component supports 40 endpoint options which are listed below:
-[[MQTT-Samples]]
-Samples
-^^^^^^^
+### Samples
Sending messages:
@@ -130,9 +124,7 @@ Consuming messages:
from("mqtt:bar?subscribeTopicName=test.mqtt.topic").transform(body().convertToString()).to("mock:result")
---------------------------------------------------------------------------------------------------------
-[[MQTT-Endpoints]]
-Endpoints
-~~~~~~~~~
+### Endpoints
Camel supports the link:message-endpoint.html[Message Endpoint] pattern
using the
@@ -158,12 +150,9 @@ implements the link:polling-consumer.html[Polling Consumer] pattern for
consuming message exchanges from the endpoint via a
http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/PollingConsumer.html[PollingConsumer]
-[[MQTT-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:message-endpoint.html[Message Endpoint] pattern
* link:uris.html[URIs]
-* link:writing-components.html[Writing Components]
-
+* link:writing-components.html[Writing Components]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-msv/src/main/docs/msv-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc
index 07e354b..6c843c2 100644
--- a/components/camel-msv/src/main/docs/msv-component.adoc
+++ b/components/camel-msv/src/main/docs/msv-component.adoc
@@ -1,4 +1,4 @@
-# MSV Component
+## MSV Component
The MSV component performs XML validation of the message body using the
https://msv.dev.java.net/[MSV Library] and any of the supported XML
@@ -22,9 +22,7 @@ Note that the link:jing.html[Jing] component also supports
http://relaxng.org/compact-tutorial-20030326.html[RelaxNG Compact
Syntax]
-[[MSV-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------------------------
@@ -45,9 +43,7 @@ msv:http://acme.com/cheese.rng
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[MSV-Options]]
-Options
-^^^^^^^
+### Options
@@ -97,9 +93,7 @@ The MSV component supports 12 endpoint options which are listed below:
-[[MSV-Example]]
-Example
-^^^^^^^
+### Example
The following
http://svn.apache.org/repos/asf/camel/trunk/components/camel-msv/src/test/resources/org/apache/camel/component/validator/msv/camelContext.xml[example]
@@ -109,12 +103,9 @@ based on whether or not the XML matches the given
http://relaxng.org/[RelaxNG XML Schema] (which is supplied on the
classpath).
-[[MSV-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-mustache/src/main/docs/mustache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc
index 5b5e778..a6ad9ce 100644
--- a/components/camel-mustache/src/main/docs/mustache-component.adoc
+++ b/components/camel-mustache/src/main/docs/mustache-component.adoc
@@ -1,4 +1,4 @@
-# Mustache Component
+## Mustache Component
*Available as of Camel 2.12*
@@ -19,9 +19,7 @@ for this component:
</dependency>
---------------------------------------------------------------------------------
-[[Mustache-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-------------------------------
@@ -35,9 +33,7 @@ file://folder/myfile.mustache[file://folder/myfile.mustache]).
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Mustache-Options]]
-Options
-^^^^^^^
+### Options
{% raw %}
@@ -84,9 +80,7 @@ The Mustache component supports 6 endpoint options which are listed below:
{% endraw %}
-[[Mustache-MustacheContext]]
-Mustache Context
-^^^^^^^^^^^^^^^^
+### Mustache Context
Camel will provide exchange information in the Mustache context (just a
`Map`). The `Exchange` is transferred as:
@@ -110,9 +104,7 @@ Camel will provide exchange information in the Mustache context (just a
|`response` |The Out message (only for InOut message exchange pattern).
|=======================================================================
-[[Mustache-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
@@ -129,9 +121,7 @@ configured. |
|MustacheConstants.MUSTACHE_TEMPLATE |String |The template to use instead of the endpoint configured. |
|=======================================================================
-[[Mustache-Samples]]
-Samples
-^^^^^^^
+### Samples
For example you could use something like:
@@ -164,9 +154,7 @@ setHeader(MustacheConstants.MUSTACHE_RESOURCE_URI).constant("path/to/my/template
to("mustache:dummy");
--------------------------------------------------------------------------------------------
-[[Mustache-TheEmailSample]]
-The Email Sample
-^^^^^^^^^^^^^^^^
+### The Email Sample
In this sample we want to use Mustache templating for an order
confirmation email. The email template is laid out in Mustache as:
@@ -181,12 +169,9 @@ Regards Camel Riders Bookstore
{{body}}
-------------------------------------------------
-[[Mustache-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-mvel/src/main/docs/mvel-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc
index bdd5e38..2207c65 100644
--- a/components/camel-mvel/src/main/docs/mvel-component.adoc
+++ b/components/camel-mvel/src/main/docs/mvel-component.adoc
@@ -1,4 +1,4 @@
-# MVEL Component
+## MVEL Component
*Available as of Camel 2.12*
@@ -19,9 +19,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MVELComponent-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------------
@@ -35,9 +33,7 @@ file://folder/myfile.mvel[file://folder/myfile.mvel]).
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[MVELComponent-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -64,9 +60,7 @@ The MVEL component supports 4 endpoint options which are listed below:
-[[MVELComponent-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
+### Message Headers
The mvel component sets a couple headers on the message.
@@ -77,9 +71,7 @@ The mvel component sets a couple headers on the message.
|`CamelMvelResourceUri` |The *templateName* as a `String` object.
|=======================================================================
-[[MVELComponent-MVELContext]]
-MVEL Context
-^^^^^^^^^^^^
+### MVEL Context
Camel will provide exchange information in the MVEL context (just a
`Map`). The `Exchange` is transfered as:
@@ -107,9 +99,7 @@ Camel will provide exchange information in the MVEL context (just a
|`response` |The Out message (only for InOut message exchange pattern).
|=======================================================================
-[[MVELComponent-Hotreloading]]
-Hot reloading
-^^^^^^^^^^^^^
+### Hot reloading
The mvel template resource is, by default, hot reloadable for both file
and classpath resources (expanded jar). If you set `contentCache=true`,
@@ -117,9 +107,7 @@ Camel will only load the resource once, and thus hot reloading is not
possible. This scenario can be used in production, when the resource
never changes.
-[[MVELComponent-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
@@ -136,9 +124,7 @@ configured.
|CamelMvelTemplate |String |The template to use instead of the endpoint configured.
|=======================================================================
-[[MVELComponent-Samples]]
-Samples
-^^^^^^^
+### Samples
For example you could use something like
@@ -171,12 +157,9 @@ from("direct:in").
to("velocity:dummy");
------------------------------------------------------------------------------------------
-[[MVELComponent-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-mvel/src/main/docs/mvel-language.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mvel/src/main/docs/mvel-language.adoc b/components/camel-mvel/src/main/docs/mvel-language.adoc
index 15d4549..a38222e 100644
--- a/components/camel-mvel/src/main/docs/mvel-language.adoc
+++ b/components/camel-mvel/src/main/docs/mvel-language.adoc
@@ -1,4 +1,4 @@
-# MVEL Language
+## MVEL Language
Camel allows Mvel to be used as an link:expression.html[Expression] or
link:predicate.html[Predicate] the link:dsl.html[DSL] or
@@ -20,9 +20,7 @@ you can construct the syntax as follows:
"getRequest().getBody().getFamilyName()"
----------------------------------------
-[[Mvel-Options]]
-Mvel Options
-^^^^^^^^^^^^
+### Mvel Options
// language options: START
The MVEL language supports 1 options which are listed below.
@@ -38,9 +36,7 @@ The MVEL language supports 1 options which are listed below.
{% endraw %}
// language options: END
-[[Mvel-Variables]]
-Variables
-^^^^^^^^^
+### Variables
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -67,9 +63,7 @@ Variables
|property(name, type) |Type |the property by the given name as the given type
|=======================================================================
-[[Mvel-Samples]]
-Samples
-^^^^^^^
+### Samples
For example you could use Mvel inside a link:message-filter.html[Message
Filter] in XML
@@ -92,9 +86,7 @@ And the sample using Java DSL:
from("seda:foo").filter().mvel("request.headers.foo == 'bar'").to("seda:bar");
---------------------------------------------------------------------------------
-[[Mvel-Loadingscriptfromexternalresource]]
-Loading script from external resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Loading script from external resource
*Available as of Camel 2.11*
@@ -108,9 +100,7 @@ eg to refer to a file on the classpath you can do:
.setHeader("myHeader").mvel("resource:classpath:script.mvel")
-------------------------------------------------------------
-[[Mvel-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use Mvel in your camel routes you need to add the a dependency on
*camel-mvel* which implements the Mvel language.
@@ -126,4 +116,4 @@ link:download.html[the download page for the latest versions]).
<artifactId>camel-mvel</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-mybatis/src/main/docs/mybatis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
index a22f25a..92e3567 100644
--- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc
+++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
@@ -1,4 +1,4 @@
-# MyBatis Component
+## MyBatis Component
*Available as of Camel 2.7*
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[MyBatis-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-------------------------------
@@ -40,9 +38,7 @@ the root of the classpath with the expected name of
If the file is located in another location, you will need to configure
the `configurationUri` option on the `MyBatisComponent` component.
-[[MyBatis-Options]]
-Options
-^^^^^^^
+### Options
@@ -110,9 +106,7 @@ The MyBatis component supports 30 endpoint options which are listed below:
-[[MyBatis-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
+### Message Headers
Camel will populate the result message, either IN or OUT with a header
with the statement used:
@@ -128,9 +122,7 @@ instance an `INSERT` could return the auto-generated key, or number of
rows etc.
|=======================================================================
-[[MyBatis-MessageBody]]
-Message Body
-^^^^^^^^^^^^
+### Message Body
The response from MyBatis will only be set as the body if it's a
`SELECT` statement. That means, for example, for `INSERT` statements
@@ -138,9 +130,7 @@ Camel will not replace the body. This allows you to continue routing and
keep the original body. The response from MyBatis is always stored in
the header with the key `CamelMyBatisResult`.
-[[MyBatis-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:
@@ -172,9 +162,7 @@ Where *insertAccount* is the MyBatis ID in the SQL mapping file:
</insert>
------------------------------------------------------------
-[[MyBatis-UsingStatementTypeforbettercontrolofMyBatis]]
-Using StatementType for better control of MyBatis
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using StatementType for better control of MyBatis
When routing to an MyBatis endpoint you will want more fine grained
control so you can control whether the SQL statement to be executed is a
@@ -192,9 +180,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 the
IN body to MyBatis:
-[[MyBatis-UsingInsertListStatementType]]
-Using InsertList StatementType
-++++++++++++++++++++++++++++++
+#### Using InsertList StatementType
*Available as of Camel 2.10*
@@ -206,9 +192,7 @@ Then you can insert multiple rows, by sending a Camel message to the
`mybatis` endpoint which uses the `InsertList` statement type, as shown
below:
-[[MyBatis-UsingUpdateListStatementType]]
-Using UpdateList StatementType
-++++++++++++++++++++++++++++++
+#### Using UpdateList StatementType
*Available as of Camel 2.11*
@@ -240,9 +224,7 @@ from("direct:start")
.to("mock:result");
--------------------------------------------------------------
-[[MyBatis-UsingDeleteListStatementType]]
-Using DeleteList StatementType
-++++++++++++++++++++++++++++++
+#### Using DeleteList StatementType
*Available as of Camel 2.11*
@@ -273,18 +255,14 @@ from("direct:start")
.to("mock:result");
--------------------------------------------------------------
-[[MyBatis-NoticeonInsertList,UpdateListandDeleteListStatementTypes]]
-Notice on InsertList, UpdateList and DeleteList StatementTypes
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+#### Notice on InsertList, UpdateList and DeleteList StatementTypes
Parameter of any type (List, Map, etc.) can be passed to mybatis and an
end user is responsible for handling it as required +
with the help of http://www.mybatis.org/core/dynamic-sql.html[mybatis
dynamic queries] capabilities.
-[[MyBatis-Scheduledpollingexample]]
-Scheduled polling example
-+++++++++++++++++++++++++
+#### Scheduled polling example
This component supports scheduled polling and can therefore be used as
a�link:polling-consumer.html[Polling Consumer]. For example to poll the
@@ -319,9 +297,7 @@ And the MyBatis SQL mapping file used:
</select>
----------------------------------------------------------------------------
-[[MyBatis-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
@@ -335,9 +311,7 @@ database to processed, so we avoid consuming it twice or more.
And the statements in the sqlmap file:
-[[MyBatis-Participatingintransactions]]
-Participating in transactions
-+++++++++++++++++++++++++++++
+#### Participating in transactions
Setting up a transaction manager under camel-mybatis can be a little bit
fiddly, as it involves externalising the database configuration outside
@@ -420,12 +394,9 @@ usual:
</camelContext>
------------------------------------------------------------------------------------------------
-[[MyBatis-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-nagios/src/main/docs/nagios-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc
index 36677bb..e608975 100644
--- a/components/camel-nagios/src/main/docs/nagios-component.adoc
+++ b/components/camel-nagios/src/main/docs/nagios-component.adoc
@@ -1,4 +1,4 @@
-# Nagios Component
+## Nagios Component
*Available as of Camel 2.3*
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Nagios-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
------------------------------
@@ -33,9 +31,7 @@ its endpoint. +
Camel also provides a link:camel-jmx.html[EventNotifer] which allows
you to send notifications to Nagios.
-[[Nagios-Options]]
-Options
-^^^^^^^
+### Options
@@ -82,9 +78,7 @@ The Nagios component supports 8 endpoint options which are listed below:
-[[Nagios-Sendingmessageexamples]]
-Sending message examples
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Sending message examples
You can send a message to Nagios where the message payload contains the
message. By default it will be `OK` level and use the
@@ -111,9 +105,7 @@ To send a `CRITICAL` message you can send the headers such as:
template.sendBodyAndHeaders("direct:start", "Hello Nagios", headers);
-----------------------------------------------------------------------------
-[[Nagios-UsingNagiosEventNotifer]]
-Using `NagiosEventNotifer`
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using `NagiosEventNotifer`
The link:nagios.html[Nagios] component also provides an
link:camel-jmx.html[EventNotifer] which you can use to send events to
@@ -136,12 +128,9 @@ In Spring XML its just a matter of defining a Spring bean with the type
link:advanced-configuration-of-camelcontext-using-spring.html[Advanced
configuration of CamelContext using Spring].
-[[Nagios-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-nats/src/main/docs/nats-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc
index a1b45b8..d92076e 100644
--- a/components/camel-nats/src/main/docs/nats-component.adoc
+++ b/components/camel-nats/src/main/docs/nats-component.adoc
@@ -1,4 +1,4 @@
-# Nats Component
+## Nats Component
*Available since Camel 2.17.0*
@@ -17,9 +17,7 @@ their�`pom.xml`�for this component.
</dependency>
------------------------------------------------------------
-[[NATS-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------
@@ -28,9 +26,7 @@ nats:servers[?options]
Where�*servers*�represents the list of NATS servers.
-[[NATS-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -78,9 +74,7 @@ The Nats component supports 23 endpoint options which are listed below:
-[[NATS-Headers]]
-Headers
-^^^^^^^
+### Headers
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -105,4 +99,4 @@ from("direct:send").to("nats://localhost:4222?topic=test");
[source,java]
----------------------------------------------------------------------------------------
from("nats://localhost:4222?topic=test&maxMessages=5&queueName=test").to("mock:result");
-----------------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------
\ No newline at end of file