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:08 UTC
[03/14] camel git commit: Use single line header for adoc files
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-slack/src/main/docs/slack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc
index 9e0a5bc..6b41a65 100644
--- a/components/camel-slack/src/main/docs/slack-component.adoc
+++ b/components/camel-slack/src/main/docs/slack-component.adoc
@@ -1,4 +1,4 @@
-# Slack Component
+## Slack Component
*Available as of Camel 2.16*
@@ -21,9 +21,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Slack-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
To send a message to a channel.
@@ -39,9 +37,7 @@ To send a direct message to a slackuser.
slack:@username[?options]
-------------------------
-[[Slack-Options]]
-Options
-^^^^^^^
+### Options
@@ -80,9 +76,7 @@ The Slack component supports 6 endpoint options which are listed below:
// endpoint options: END
-[[Slack-SlackComponent.1]]
-SlackComponent
-^^^^^^^^^^^^^^
+### SlackComponent
The SlackComponent with XML must be configured as a Spring or Blueprint
bean that contains the incoming webhook url for the integration as a
@@ -97,9 +91,7 @@ parameter.
For Java you can configure this using Java code.
-[[Slack-Example]]
-Example
-^^^^^^^
+### Example
A CamelContext with Blueprint could be as:
@@ -122,12 +114,9 @@ A CamelContext with Blueprint could be as:
</blueprint>
---------------------------------------------------------------------------------------------------------------------------
-[[Slack-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-smpp/src/main/docs/smpp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc
index 8db80ec..c83cf21 100644
--- a/components/camel-smpp/src/main/docs/smpp-component.adoc
+++ b/components/camel-smpp/src/main/docs/smpp-component.adoc
@@ -1,4 +1,4 @@
-# SMPP Component
+## SMPP Component
*CamelSmppFinalStatusAvailable as of Camel 2.2*
@@ -27,9 +27,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SMPP-SMSlimitations]]
-SMS limitations
-^^^^^^^^^^^^^^^
+### SMS limitations
SMS is neither reliable or secure.� Users who require reliable and
secure delivery may want to consider using the XMPP or SIP components
@@ -56,9 +54,7 @@ schemes and other purposes where security is important.
While the Camel component makes it as easy as possible to send messages
to the SMS network, it can not offer an easy solution to these problems.
-[[SMPP-Datacoding,alphabetandinternationalcharactersets]]
-Data coding, alphabet and international character sets
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Data coding, alphabet and international character sets
Data coding and alphabet can be specified on a per-message basis.�
Default values can be specified for the endpoint.� It is important to
@@ -129,9 +125,7 @@ control panel option]. It is suggested that users check with their SMSC
operator to confirm exactly which character set is being used as the
default.
-[[SMPP-Messagesplittingandthrottling]]
-Message splitting and throttling
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Message splitting and throttling
After transforming a message body from a String to a byte array, the
Camel component is also responsible for splitting the message into parts
@@ -149,9 +143,7 @@ that has been split may be counted separately by the provider's
throttling mechanism.� The Camel Throttler component can be useful for
throttling messages in the SMPP route before handing them to the SMSC.
-[[SMPP-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------------------
@@ -169,9 +161,7 @@ use SSLSocket to init a connection to the server.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[SMPP-URIOptions]]
-URI Options
-^^^^^^^^^^^
+### URI Options
@@ -255,9 +245,7 @@ You can have as many of these options as you like.
smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&transactionTimer=5000&systemType=consumer
------------------------------------------------------------------------------------------------------------------
-[[SMPP-ProducerMessageHeaders]]
-Producer Message Headers
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Producer Message Headers
The following message headers can be used to affect the behavior of the
SMPP producer
@@ -392,9 +380,7 @@ converted in the following way:
`org.jsmpp.bean.OptionalParameter.Null` -> `null`
|=======================================================================
-[[SMPP-ConsumerMessageHeaders]]
-Consumer Message Headers
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Consumer Message Headers
The following message headers are used by the SMPP consumer to set the
request data from the SMSC in the message header
@@ -529,9 +515,7 @@ TIP: *JSMPP library*
See the documentation of the http://jsmpp.org[JSMPP Library] for more
details about the underlying library.
-[[SMPP-Exceptionhandling]]
-Exception handling
-^^^^^^^^^^^^^^^^^^
+### Exception handling
This component supports the general Camel exception handling
capabilities
@@ -564,9 +548,7 @@ from("smpp://smppclient@localhost:2775?password=password&enquireLinkTimer=3000&t
Please refer to the http://smsforum.net/SMPP_v3_4_Issue1_2.zip[SMPP
specification] for the complete list of error codes and their meanings.
-[[SMPP-Samples]]
-Samples
-^^^^^^^
+### Samples
A route which sends an SMS using the Java DSL:
@@ -613,9 +595,7 @@ If you need an SMSC simulator for your test, you can use the simulator
provided by
http://opensmpp.logica.com/CommonPart/Download/download2.html#simulator[Logica].
-[[SMPP-Debuglogging]]
-Debug logging
-^^^^^^^^^^^^^
+### Debug logging
This component has log level *DEBUG*, which can be helpful in debugging
problems. If you use log4j, you can add the following line to your
@@ -626,12 +606,9 @@ configuration:
log4j.logger.org.apache.camel.component.smpp=DEBUG
--------------------------------------------------
-[[SMPP-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-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc
index 10f4289..03d6e98 100644
--- a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc
+++ b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc
@@ -1,4 +1,4 @@
-# YAML SnakeYAML DataFormat
+## YAML SnakeYAML DataFormat
YAML is a�link:data-format.html[Data Format]�to marshal and unmarshal
Java objects to and from�http://www.yaml.org/[YAML].
@@ -12,9 +12,7 @@ Every library requires adding the special camel component (see
"Dependency..." paragraphs further down). By default Camel uses the
SnakeYAML library.
-[[YAML-Options]]
-YAML Options
-^^^^^^^^^^^^
+### YAML Options
// dataformat options: START
The YAML SnakeYAML dataformat supports 11 options which are listed below.
@@ -42,9 +40,7 @@ The YAML SnakeYAML dataformat supports 11 options which are listed below.
WARNING: SnakeYAML can load any class from YAML definition which may lead to security breach so by default, SnakeYAML DataForma restrict the object it can load to standard Java objects like List or Long. If you want to load custom POJOs you need to add theirs type to SnakeYAML DataFormat type filter list. If your source is trusted, you can set the property allowAnyType to true so SnakeYAML DataForma won't perform any filter on the types.
-[[YAMLDataFormat-UsingYAMLdataformatwiththeSnakeYAMLlibrary]]
-Using YAML data format with the SnakeYAML library
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using YAML data format with the SnakeYAML library
- Turn Object messages into yaml then send to MQSeries
+
@@ -77,9 +73,7 @@ from("activemq:My.Queue")
.to("mqseries:Another.Queue");
------------------------------------------------------------
-[[YAMLDataFormat-UsingYAMLinSpringDSL]]
-Using YAML in Spring DSL
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Using YAML 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
@@ -131,9 +125,7 @@ And then you can refer to those ids in the route:
-------------------------------------
-[[YAMLDataFormat-DependenciesforSnakeYAML]]
-Dependencies for SnakeYAML
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Dependencies for SnakeYAML
To use YAML in your camel routes you need to add the a dependency
on�*camel-snakeyaml*�which implements this data format.
@@ -153,4 +145,4 @@ substituting the version number for the latest & greatest release
�
-�
+�
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-snmp/src/main/docs/snmp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc
index 3cd76e0..9c3dad8 100644
--- a/components/camel-snmp/src/main/docs/snmp-component.adoc
+++ b/components/camel-snmp/src/main/docs/snmp-component.adoc
@@ -1,4 +1,4 @@
-# SNMP Component
+## SNMP Component
*Available as of Camel 2.1*
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SNMP-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------
@@ -33,9 +31,7 @@ and receiving traps.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[SNMP-Producer]]
-Snmp Producer
-^^^^^^^^^^^^^
+### Snmp Producer
*Available from 2.18 release*
@@ -43,9 +39,7 @@ It can also be used to request information using GET method.
The response body type is org.apache.camel.component.snmp.SnmpMessage
-[[SNMP-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -101,9 +95,7 @@ The SNMP component supports 36 endpoint options which are listed below:
{% endraw %}
// endpoint options: END
-[[SNMP-Theresultofapoll]]
-The result of a poll
-^^^^^^^^^^^^^^^^^^^^
+### The result of a poll
Given the situation, that I poll for the following OIDs:
@@ -154,9 +146,7 @@ requested....1.3.6.1.2.1.1.1.0. +
So it may absolutely happen, that you receive more than you
requested...be prepared.
-[[SNMP-Examples]]
-Examples
-^^^^^^^^
+### Examples
Polling a remote device:
@@ -185,12 +175,9 @@ convertBodyTo(String.class).
to("activemq:snmp.states");
------------------------------------------------------------------------------
-[[SNMP-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-soap/src/main/docs/soapjaxb-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc
index 70d1d62..3e4aa17 100644
--- a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc
+++ b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc
@@ -1,4 +1,4 @@
-# SOAP DataFormat
+## SOAP DataFormat
*Available as of Camel 2.3*
@@ -16,9 +16,7 @@ onwards.
See link:jaxb.html[JAXB] for details how you can control namespace
prefix mappings when marshalling using link:soap.html[SOAP] data format.
-[[SOAP-Options]]
-SOAP Options
-^^^^^^^^^^^^
+### SOAP Options
// dataformat options: START
@@ -43,9 +41,7 @@ The SOAP dataformat supports 7 options which are listed below.
-[[SOAP-ElementNameStrategy]]
-ElementNameStrategy
-^^^^^^^^^^^^^^^^^^^
+### ElementNameStrategy
An element name strategy is used for two purposes. The first is to find
a xml element name for a given object and soap action when marshaling
@@ -72,9 +68,7 @@ similar tool then you probably will want to use the
ServiceInterfaceStrategy. In the case you have no annotated service
interface you should use QNameStrategy or TypeNameStrategy.
-[[SOAP-UsingtheJavaDSL]]
-Using the Java DSL
-^^^^^^^^^^^^^^^^^^
+### Using the Java DSL
The following example uses a named DataFormat of _soap_ which is
configured with the package com.example.customerservice to initialize
@@ -100,9 +94,7 @@ As the SOAP dataformat inherits from the link:jaxb.html[JAXB] dataformat
most settings apply here as well
-[[SOAP-UsingSOAP1.2]]
-Using SOAP 1.2
-++++++++++++++
+#### Using SOAP 1.2
*Available as of Camel 2.11*
@@ -140,9 +132,7 @@ And in the Camel route
</route>
---------------------------------------------------------------------------------------------------------------
-[[SOAP-Multi-partMessages]]
-Multi-part Messages
-^^^^^^^^^^^^^^^^^^^
+### Multi-part Messages
*Available as of Camel 2.8.1*
@@ -166,9 +156,7 @@ ServiceInterfaceStrategy strat = new ServiceInterfaceStrategy(com.example.custo
SoapJaxbDataFormat soapDataFormat = new SoapJaxbDataFormat("com.example.customerservice.multipart", strat);
-------------------------------------------------------------------------------------------------------------------------------------------
-[[SOAP-Multi-partRequest]]
-Multi-part Request
-++++++++++++++++++
+#### Multi-part Request
The payload parameters for a multi-part request are initiazlied using a
`BeanInvocation` object that reflects the signature of the target
@@ -201,9 +189,7 @@ beanInvocation.setArgs(args);
exchange.getIn().setBody(beanInvocation);
----------------------------------------------------------------------------------------
-[[SOAP-Multi-partResponse]]
-Multi-part Response
-+++++++++++++++++++
+#### Multi-part Response
A multi-part soap response may include an element in the soap body and
will have one or more elements in the soap header. The camel-soap
@@ -220,9 +206,7 @@ camel-jaxb.
You can also have the camel-soap DataFormate ignore header content
all-together by setting the `ignoreUnmarshalledHeaders` value to `true`.
-[[SOAP-HolderObjectmapping]]
-Holder Object mapping
-+++++++++++++++++++++
+#### Holder Object mapping
JAX-WS specifies the use of a type-parameterized `javax.xml.ws.Holder`
object for `In/Out` and `Out` parameters. A `Holder` object may be used
@@ -232,13 +216,9 @@ values in accordance with the JAXB mapping for the class of the
`Holder`'s value. No mapping is provided for `Holder` objects in an
unmarshalled response.
-[[SOAP-Examples]]
-Examples
-^^^^^^^^
+### Examples
-[[SOAP-Webserviceclient]]
-Webservice client
-+++++++++++++++++
+#### Webservice client
The following route supports marshalling the request and unmarshalling a
response or fault.
@@ -273,9 +253,7 @@ CustomerService proxy = ProxyHelper.createProxy(startEndpoint, classLoader, Cust
GetCustomersByNameResponse response = proxy.getCustomersByName(new GetCustomersByName());
---------------------------------------------------------------------------------------------------
-[[SOAP-WebserviceServer]]
-Webservice Server
-+++++++++++++++++
+#### Webservice Server
Using the following route sets up a webservice server that listens on
jms queue customerServiceQueue and processes requests using the class
@@ -297,9 +275,7 @@ from("jms://queue:customerServiceQueue")
.marshal(soapDF);
---------------------------------------------------------------------------------------------------------------------------------------
-[[SOAP-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use the SOAP dataformat in your camel routes you need to add the
following dependency to your pom.
@@ -311,4 +287,4 @@ following dependency to your pom.
<artifactId>camel-soap</artifactId>
<version>2.3.0</version>
</dependency>
--------------------------------------
+-------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-solr/src/main/docs/solr-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc
index ebcf0ce..4c5e957 100644
--- a/components/camel-solr/src/main/docs/solr-component.adoc
+++ b/components/camel-solr/src/main/docs/solr-component.adoc
@@ -1,4 +1,4 @@
-# Solr Component
+## Solr Component
*Available as of Camel 2.9*
@@ -19,9 +19,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Solr-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
*NOTE:* solrs and solrCloud are new added since *Camel 2.14*.
@@ -32,9 +30,7 @@ solrs://host[:port]/solr?[options]
solrCloud://host[:port]/solr?[options]
--------------------------------------
-[[Solr-Options]]
-Solr Options
-^^^^^^^^^^^^
+### Solr Options
// component options: START
@@ -69,9 +65,7 @@ The Solr component supports 14 endpoint options which are listed below:
// endpoint options: END
-[[Solr-MessageOperations]]
-Message Operations
-^^^^^^^^^^^^^^^^^^
+### Message Operations
The following Solr operations are currently supported. Simply set an
exchange header with a key of "SolrOperation" and a value set to one of
@@ -116,9 +110,7 @@ bean]
optimize command
|=======================================================================
-[[Solr-Example]]
-Example
-^^^^^^^
+### Example
Below is a simple INSERT, DELETE and COMMIT example
@@ -177,9 +169,7 @@ delete routes and then call the commit route.
template.sendBody("direct:commit", null);
-----------------------------------------------
-[[Solr-QueryingSolr]]
-Querying Solr
-^^^^^^^^^^^^^
+### Querying Solr
Currently, this component doesn't support querying data natively (may be
added later). For now, you can query Solr using link:http.html[HTTP] as
@@ -203,12 +193,9 @@ Tutorial]
http://wiki.apache.org/solr/SolrQuerySyntax[Solr Query Syntax]
-[[Solr-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-spark-rest/src/main/docs/spark-rest-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
index c09f81c..db249c6 100644
--- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
+++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
@@ -1,4 +1,4 @@
-# Spark Rest Component
+## Spark Rest Component
*Available as of Camel 2.14*
@@ -20,18 +20,14 @@ for this component:
</dependency>
-------------------------------------------------
-[[Spark-rest-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------------------
spark-rest://verb:path?[options]
----------------------------------
-[[Spark-rest-URIOptions]]
-URI Options
-^^^^^^^^^^^
+### URI Options
@@ -87,9 +83,7 @@ The Spark Rest component supports 13 endpoint options which are listed below:
// endpoint options: END
-[[Spark-rest-PathusingSparksyntax]]
-Path using Spark syntax
-^^^^^^^^^^^^^^^^^^^^^^^
+### Path using Spark syntax
The path option is defined using a Spark REST syntax where you define
the REST context path using support for parameters and splat. See more
@@ -113,9 +107,7 @@ header with the key "me".
.transform().simple("Bye ${header.me}");
--------------------------------------------
-[[Spark-rest-MappingtoCamelMessage]]
-Mapping to Camel Message
-^^^^^^^^^^^^^^^^^^^^^^^^
+### Mapping to Camel Message
The Spark Request object is mapped to a Camel Message as
a�`org.apache.camel.component.sparkrest.SparkMessage` which has access
@@ -135,9 +127,7 @@ Simple language to construct a response message.
.transform().simple("Bye big ${header.splat[1]} from ${header.splat[0]}");
------------------------------------------------------------------------------
-[[Spark-rest-RestDSL]]
-Rest DSL
-^^^^^^^^
+### Rest DSL
Apache Camel provides a new Rest DSL that allow to define the REST
services in a nice REST style. For example we can define a REST hello
@@ -171,23 +161,18 @@ service as shown below:
See more details at the�link:rest-dsl.html[Rest DSL].
-[[Spark-rest-Moreexamples]]
-More examples
-^^^^^^^^^^^^^
+### More examples
There is a *camel-example-spark-rest-tomcat* example in the Apache Camel
distribution, that demonstrates how to use camel-spark-rest in a web
application that can be deployed on Apache Tomcat, or similar web
containers.
-[[Spark-rest-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:rest.html[Rest]
-
+* link:rest.html[Rest]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-spark/src/main/docs/spark-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc
index fc71216..e5cc252 100644
--- a/components/camel-spark/src/main/docs/spark-component.adoc
+++ b/components/camel-spark/src/main/docs/spark-component.adoc
@@ -1,4 +1,4 @@
-# Apache Spark Component
+## Apache Spark Component
INFO: Apache Spark component is available starting from Camel *2.17*.
@@ -10,9 +10,7 @@ message from various transports, dynamically choose a task to execute,
use incoming message as input data for that task and finally deliver the
results of the execution back to the Camel pipeline.
-[[ApacheSpark-Supportedarchitecturalstyles]]
-Supported architectural styles
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Supported architectural styles
Spark component can be used as a driver application deployed into an
application server (or executed as a fat jar).
@@ -28,18 +26,14 @@ While Spark component is primary designed to work as a _long running
job_�serving as an bridge between Spark cluster and the other endpoints,
you can also use it as a _fire-once_ short job. ��
-[[ApacheSpark-RunningSparkinOSGiservers]]
-Running Spark in OSGi servers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Running Spark in OSGi servers
Currently the Spark component doesn't support execution in the OSGi
container. Spark has been designed to be executed as a fat jar, usually
submitted as a job to a cluster. For those reasons running Spark in an
OSGi server is at least challenging and is not support by Camel as well.
-[[ApacheSpark-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
Currently the Spark component supports only producers - it it intended
to invoke a Spark job and return results. You can call RDD, data frame
@@ -52,9 +46,7 @@ or Hive SQL job.
spark:{rdd|dataframe|hive}
--------------------------
-[[ApacheSpark-options]]
-Spark options
-+++++++++++++
+#### Spark options
@@ -95,9 +87,7 @@ The Apache Spark component supports 7 endpoint options which are listed below:
// endpoint options: END
�
-[[ApacheSpark-RDDjobs]]
-RDD jobs�
-^^^^^^^^^
+### RDD jobs�
To invoke an RDD job, use the following URI:
@@ -166,9 +156,7 @@ JavaRDDLike myRdd(JavaSparkContext sparkContext) {
}
--------------------------------------------------
-[[ApacheSpark-VoidRDDcallbacks]]
-Void RDD callbacks
-++++++++++++++++++
+#### Void RDD callbacks
If your RDD callback doesn't return any value back to a Camel pipeline,
you can either return `null` value or use�`VoidRddCallback` base class:
@@ -188,9 +176,7 @@ RddCallback<Void> rddCallback() {
}
------------------------------------------------------------------
-[[ApacheSpark-ConvertingRDDcallbacks]]
-Converting RDD callbacks
-++++++++++++++++++++++++
+#### Converting RDD callbacks
If you know what type of the input data will be sent to the RDD
callback, you can use�`ConvertingRddCallback` and let Camel to
@@ -213,9 +199,7 @@ RddCallback<Long> rddCallback(CamelContext context) {
}
---------------------------------------------------------------------------
-[[ApacheSpark-AnnotatedRDDcallbacks]]
-Annotated RDD callbacks
-+++++++++++++++++++++++
+#### Annotated RDD callbacks
Probably the easiest way to work with the RDD callbacks is to provide
class with method marked with�`@RddCallback` annotation:
@@ -282,9 +266,7 @@ long result = producerTemplate.requestBody("spark:rdd?rdd=#rdd&rddCallback=#rddC
�
-[[ApacheSpark-DataFramejobs]]
-DataFrame jobs
-^^^^^^^^^^^^^^
+### DataFrame jobs
Instead of working with RDDs Spark component can work with DataFrames as
well.�
@@ -359,9 +341,7 @@ DataFrame cars(HiveContext hiveContext) {
}
------------------------------------------------------------------------
-[[ApacheSpark-Hivejobs]]
-Hive jobs
-^^^^^^^^^
+### Hive jobs
�Instead of working with RDDs or DataFrame Spark component can also
receive Hive SQL queries as payloads.�To send Hive query to Spark
@@ -401,12 +381,9 @@ DataFrame cars(HiveContext hiveContext) {
}
------------------------------------------------------------------------
-[[ApacheSpark-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-splunk/src/main/docs/splunk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc
index c45960c..c93716a 100644
--- a/components/camel-splunk/src/main/docs/splunk-component.adoc
+++ b/components/camel-splunk/src/main/docs/splunk-component.adoc
@@ -1,4 +1,4 @@
-# Splunk Component
+## Splunk Component
*Available as of Camel 2.13*
@@ -19,18 +19,14 @@ for this component:
</dependency>
---------------------------------------------
-[[Splunk-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-------------------------------
splunk://[endpoint]?[options]
-------------------------------
-[[Splunk-ProducerEndpoints:]]
-Producer Endpoints:
-^^^^^^^^^^^^^^^^^^^
+### Producer Endpoints:
[width="100%",cols="10%,90%",options="header",]
|=======================================================================
@@ -62,9 +58,7 @@ SplunkEvent.��See comment under message body.
In this example a converter is required to convert to a SplunkEvent
class.
-[[Splunk-ConsumerEndpoints:]]
-Consumer Endpoints:
-^^^^^^^^^^^^^^^^^^^
+### Consumer Endpoints:
[width="100%",cols="10%,90%",options="header",]
|=======================================================================
@@ -87,9 +81,7 @@ name of the query in the savedSearch option.
camel-splunk creates a route exchange per search result with a
SplunkEvent in the body.
-[[Splunk-URIOptions]]
-URI Options
-^^^^^^^^^^^
+### URI Options
@@ -165,9 +157,7 @@ The Splunk component supports 43 endpoint options which are listed below:
// endpoint options: END
-[[Splunk-Messagebody]]
-Message body
-^^^^^^^^^^^^
+### Message body
Splunk operates on data in key/value pairs. The SplunkEvent class is a
placeholder for such data, and should be in the message body for the producer.
@@ -178,9 +168,7 @@ As of Camel 2.16.0 you can send raw data to Splunk by setting the raw
option on the producer endpoint. This is useful for eg. json/xml and
other payloads where Splunk has build in support.�
-[[Splunk-UseCases]]
-Use Cases
-^^^^^^^^^
+### Use Cases
Search Twitter for tweets with music and publish events to Splunk
@@ -229,21 +217,16 @@ Search Splunk for tweets
.log("${body}");
--------------------------------------------------------------------------------------------------------------------------------
-[[Splunk-Othercomments]]
-Other comments
-^^^^^^^^^^^^^^
+### Other comments
Splunk comes with a variety of options for leveraging machine generated
data with prebuilt apps for analyzing and displaying this. +
For example the jmx app. could be used to publish jmx attributes, eg.
route and jvm metrics to Splunk, and displaying this on a dashboard.
-[[Splunk-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-spring-batch/src/main/docs/spring-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
index a7cfbcc..843a2cd 100644
--- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
+++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
@@ -1,4 +1,4 @@
-# Spring Batch Component
+## Spring Batch Component
The *spring-batch:* component and support classes provide integration
bridge between Camel and http://www.springsource.org/spring-batch[Spring
@@ -17,9 +17,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SpringBatch-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
------------------------------
@@ -34,9 +32,7 @@ WARNING:This component can only be used to define producer endpoints, which
means that you cannot use the Spring Batch component in a `from()`
statement.
-[[SpringBatch-Options]]
-Options
-^^^^^^^
+### Options
@@ -83,9 +79,7 @@ The Spring Batch component supports 5 endpoint options which are listed below:
-[[SpringBatch-Usage]]
-Usage
-^^^^^
+### Usage
When Spring Batch component receives the message, it triggers the job
execution. The job will be executed using the
@@ -107,9 +101,7 @@ parameters. `String`, `Long`, `Double` and `java.util.Date` values are
copied to the `org.springframework.batch.core.JobParametersBuilder` -
other data types are converted to Strings.
-[[SpringBatch-Examples]]
-Examples
-^^^^^^^^
+### Examples
Triggering the Spring Batch job execution:
@@ -140,16 +132,12 @@ JobExecution jobExecution = mockEndpoint.getExchanges().get(0).getIn().getBody(J
BatchStatus currentJobStatus = jobExecution.getStatus();
---------------------------------------------------------------------------------------------------
-[[SpringBatch-Supportclasses]]
-Support classes
-^^^^^^^^^^^^^^^
+### Support classes
Apart from the Component, Camel Spring Batch provides also support
classes, which can be used to hook into Spring Batch infrastructure.
-[[SpringBatch-CamelItemReader]]
-CamelItemReader
-+++++++++++++++
+#### CamelItemReader
`CamelItemReader` can be used to read batch data directly from the Camel
infrastructure.
@@ -173,9 +161,7 @@ JMS queue.
</batch:job>
-----------------------------------------------------------------------------------------------
-[[SpringBatch-CamelItemWriter]]
-CamelItemWriter
-+++++++++++++++
+#### CamelItemWriter
`CamelItemWriter` has similar purpose as `CamelItemReader`, but it is
dedicated to write chunk of the processed data.
@@ -199,9 +185,7 @@ JMS queue.
</batch:job>
-----------------------------------------------------------------------------------------------
-[[SpringBatch-CamelItemProcessor]]
-CamelItemProcessor
-++++++++++++++++++
+#### CamelItemProcessor
`CamelItemProcessor` is the implementation of Spring Batch
`org.springframework.batch.item.ItemProcessor` interface. The latter
@@ -241,9 +225,7 @@ the http://camel.apache.org/simple.html[Simple expression language].
</batch:job>
-------------------------------------------------------------------------------------------------------------
-[[SpringBatch-CamelJobExecutionListener]]
-CamelJobExecutionListener
-+++++++++++++++++++++++++
+#### CamelJobExecutionListener
`CamelJobExecutionListener` is the implementation of the
`org.springframework.batch.core.JobExecutionListener` interface sending
@@ -274,4 +256,4 @@ JMS queue.
<batch:listener ref="camelJobExecutionListener"/>
</batch:listeners>
</batch:job>
------------------------------------------------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------------------------------------
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
index 3d3dc08..954991e 100644
--- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
+++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
@@ -1,4 +1,4 @@
-# Spring Integration Component
+## Spring Integration Component
The *spring-integration:* component provides a bridge for Camel
components to talk to
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SpringIntegration-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-----------------------------------------------
@@ -35,9 +33,7 @@ used by the Spring Integration Spring context. It will equal to the
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[SpringIntegration-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -66,9 +62,7 @@ The Spring Integration component supports 8 endpoint options which are listed be
// endpoint options: END
-[[SpringIntegration-Usage]]
-Usage
-^^^^^
+### Usage
The Spring integration component is a bridge that connects Camel
endpoints with Spring integration endpoints through the Spring
@@ -76,21 +70,15 @@ integration's input channels and output channels. Using this component,
we can send Camel messages to Spring Integration endpoints or receive
messages from Spring integration endpoints in a Camel routing context.
-[[SpringIntegration-Examples]]
-Examples
-^^^^^^^^
+### Examples
-[[SpringIntegration-UsingtheSpringintegrationendpoint]]
-Using the Spring integration endpoint
-+++++++++++++++++++++++++++++++++++++
+#### Using the Spring integration endpoint
You can set up a Spring integration endpoint using a URI, as follows:
Or directly using a Spring integration channel name:
-[[SpringIntegration-TheSourceandTargetadapter]]
-The Source and Target adapter
-+++++++++++++++++++++++++++++
+#### The Source and Target adapter
Spring integration also provides the Spring integration's source and
target adapters, which can route messages from a Spring integration
@@ -101,12 +89,9 @@ This example uses the following namespaces:
You can bind your source or target to a Camel endpoint as follows:
-[[SpringIntegration-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-spring-ldap/src/main/docs/spring-ldap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
index df5f34e..48ee50b 100644
--- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
@@ -1,4 +1,4 @@
-# Spring LDAP Component
+## Spring LDAP Component
*Available since Camel 2.11*
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SpringLDAP-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------------------------
@@ -32,9 +30,7 @@ http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap
LDAP Template bean]. In this bean, you configure the URL and the
credentials for your LDAP access.
-[[SpringLDAP-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -59,9 +55,7 @@ The Spring LDAP component supports 4 endpoint options which are listed below:
// endpoint options: END
-[[SpringLDAP-Usage]]
-Usage
-^^^^^
+### Usage
The component supports producer endpoint only. An attempt to create a
consumer endpoint will result in an `UnsupportedOperationException`. +
@@ -75,48 +69,36 @@ operations. For the `search` and `function_driven` operations, the body is set t
the search, see
http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap/core/LdapTemplate.html#search%28java.lang.String,%20java.lang.String,%20int,%20org.springframework.ldap.core.AttributesMapper%29[http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap/core/LdapTemplate.html#search%28java.lang.String,%20java.lang.String,%20int,%20org.springframework.ldap.core.AttributesMapper%29].
-[[SpringLDAP-Search]]
-Search
-++++++
+#### Search
The message body must have an entry with the key *`filter`*. The value
must be a `String` representing a valid LDAP filter, see
http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol#Search_and_Compare[http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol#Search_and_Compare].
-[[SpringLDAP-Bind]]
-Bind
-++++
+#### Bind
The message body must have an entry with the key *`attributes`*. The
value must be an instance of
http://docs.oracle.com/javase/6/docs/api/javax/naming/directory/Attributes.html[javax.naming.directory.Attributes]
This entry specifies the LDAP node to be created.
-[[SpringLDAP-Unbind]]
-Unbind
-++++++
+#### Unbind
No further entries necessary, the node with the specified *`dn`* is
deleted.
-[[SpringLDAP-Authenticate]]
-Authenticate
-+++++++++++
+#### Authenticate
The message body must have entries with the keys *`filter`* and *`password`*. The
values must be an instance of `String` representing a valid LDAP filter and a user password, respectively.
-[[SpringLDAP-ModifyAttributes]]
-Modify Attributes
-++++++++++++++++
+#### Modify Attributes
The message body must have an entry with the key *`modificationItems`*. The
value must be an instance of any array of type
http://docs.oracle.com/javase/6/docs/api/javax/naming/directory/ModificationItem.html[javax.naming.directory.ModificationItem]
-[[SpringLDAP-FunctionDriven]]
-Function-Driven
-++++++++++++++++
+#### Function-Driven
The message body must have entries with the keys *`function`* and *`request`*. The *`function`* value must be of type `java.util.function.BiFunction<L, Q, S>`. The `L` type parameter must be of type `org.springframework.ldap.core.LdapOperations`. The *`request`* value must be the same type as the `Q` type parameter in the *`function`* and it must encapsulate the parameters expected by the LdapTemplate method being invoked within the *`function`*. The `S` type parameter represents the response type as returned by the LdapTemplate method being invoked.
This operation allows dynamic invocation of LdapTemplate methods that are not covered by the operations mentioned above.
@@ -132,5 +114,4 @@ in `org.apache.camel.springldap.SpringLdapProducer`:
* public static final String PASSWORD = "password";
* public static final String MODIFICATION_ITEMS = "modificationItems";
* public static final String FUNCTION = "function";
-* public static final String REQUEST = "request";
-
+* public static final String REQUEST = "request";
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
index cdc2286..7a96cca 100644
--- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
+++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
@@ -1,4 +1,4 @@
-# Spring Redis Component
+## Spring Redis Component
*Available as of Camel 2.11*
@@ -15,9 +15,7 @@ INFO:*Prerequisites*
In order to use this component, you must have a Redis server running.
-[[SpringRedis-URIFormat]]
-URI Format
-^^^^^^^^^^
+### URI Format
[source,java]
----------------------------------
@@ -27,9 +25,7 @@ spring-redis://host:port[?options]
You can append query options to the URI in the following format,
`?options=value&option2=value&...`
-[[SpringRedis-URIOptions]]
-URI Options
-^^^^^^^^^^^
+### URI Options
// component options: START
@@ -62,16 +58,12 @@ The Spring Redis component supports 12 endpoint options which are listed below:
// endpoint options: END
-[[SpringRedis-Usage]]
-Usage
-^^^^^
+### Usage
See also the unit tests available
at�https://github.com/apache/camel/tree/master/components/camel-spring-redis/src/test/java/org/apache/camel/component/redis[https://github.com/apache/camel/tree/master/components/camel-spring-redis/src/test/java/org/apache/camel/component/redis].
-[[SpringRedis-MessageheadersevaluatedbytheRedisproducer]]
-Message headers evaluated by the Redis producer
-+++++++++++++++++++++++++++++++++++++++++++++++
+#### Message headers evaluated by the Redis producer
The producer issues commands to the server and each command has
different set of parameters with specific types. The result from the
@@ -343,9 +335,7 @@ milliseconds |CamelRedis.Key (String), CamelRedis.Timestamp (Long) |Boolean
|`PUBLISH` |Post a message to a channel |CamelRedis.Channel (String), CamelRedis.Message (Object) |void
|=======================================================================
-[[SpringRedis-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
Maven users will need to add the following dependency to their pom.xml.
@@ -363,12 +353,9 @@ Maven users will need to add the following dependency to their pom.xml.
where `${camel-version`} must be replaced by the actual version of Camel
(2.11 or higher).
-[[SpringRedis-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-spring-ws/src/main/docs/spring-ws-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
index 5bdbab2..45331bb 100644
--- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
+++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
@@ -1,4 +1,4 @@
-# Spring WebService Component
+## Spring WebService Component
*Available as of Camel 2.6*
@@ -33,9 +33,7 @@ module is also included in Spring-WS 1.5.9 (see
http://stackoverflow.com/questions/3313314/can-spring-ws-1-5-be-used-with-spring-3[this
post])
-[[SpringWebServices-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
The URI scheme for this component is as follows
@@ -79,9 +77,7 @@ calling upon.
You can append query *options* to the URI in the following format,
`?option=value&option=value&...`
-[[SpringWebServices-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -127,9 +123,7 @@ The Spring WebService component supports 25 endpoint options which are listed be
// endpoint options: END
-[[SpringWebServices-Messageheaders]]
-Message headers
-+++++++++++++++
+#### Message headers
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
@@ -160,9 +154,7 @@ outputAction option if present
faultAction option if present
|=======================================================================
-[[SpringWebServices-Accessingwebservices]]
-Accessing web services
-~~~~~~~~~~~~~~~~~~~~~~
+### Accessing web services
To call a web service at `http://foo.com/bar` simply define a route:
@@ -181,9 +173,7 @@ template.requestBody("direct:example", "<foobar xmlns=\"http://foo.com\"><msg>te
Remember if it's a SOAP service you're calling you don't have to include
SOAP tags. Spring-WS will perform the XML-to-SOAP marshaling.
-[[SpringWebServices-SendingSOAPandWS-Addressingactionheaders]]
-Sending SOAP and WS-Addressing action headers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Sending SOAP and WS-Addressing action headers
When a remote web service requires a SOAP action or use of the
WS-Addressing standard you define your route as:
@@ -203,9 +193,7 @@ template.requestBodyAndHeader("direct:example",
SpringWebserviceConstants.SPRING_WS_SOAP_ACTION, "http://baz.com");
--------------------------------------------------------------------
-[[SpringWebServices-UsingSOAPheaders]]
-Using SOAP headers
-^^^^^^^^^^^^^^^^^^
+### Using SOAP headers
*Available as of Camel 2.11.1*
@@ -237,9 +225,7 @@ For an example see this
https://svn.apache.org/repos/asf/camel/trunk/components/camel-spring-ws/src/test/java/org/apache/camel/component/spring/ws/SoapHeaderTest.java[unit
test].
-[[SpringWebServices-Theheaderandattachmentpropagation]]
-The header and attachment propagation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### The header and attachment propagation
Spring WS Camel supports propagation of the headers and attachments into
Spring-WS WebServiceMessage response since version *2.10.3*.�The
@@ -258,9 +244,7 @@ Note: If the exchange header in the pipeline contains text, it generates
Qname(key)=value attribute in the soap header. Recommended is to create
a QName class directly and put into any key into header.
-[[SpringWebServices-HowtouseMTOMattachments]]
-How to use MTOM attachments
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### How to use MTOM attachments
The BasicMessageFilter provides all required information for Apache
Axiom in order to produce MTOM message. If you want to use Apache Camel
@@ -318,9 +302,7 @@ from("direct:send")
- Now, your producer will generate MTOM message with otpmized
attachments.
-[[SpringWebServices-Thecustomheaderandattachmentfiltering]]
-The custom header and attachment filtering
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### The custom header and attachment filtering
If you need to provide your custom processing of either headers or
attachments, extend existing BasicMessageFilter and override the
@@ -363,9 +345,7 @@ protected void doProcessSoapAttachements(Message inOrOut, SoapMessage response)
{ your code /*no need to call super*/ }
-------------------------------------------------------------------------------
-[[SpringWebServices-UsingacustomMessageSenderandMessageFactory]]
-Using a custom MessageSender and MessageFactory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Using a custom MessageSender and MessageFactory
A custom message sender or factory in the registry can be referenced
like this:
@@ -398,9 +378,7 @@ Spring configuration:
</bean>
---------------------------------------------------------------------------------------------------------------------
-[[SpringWebServices-Exposingwebservices]]
-Exposing web services
-~~~~~~~~~~~~~~~~~~~~~
+### Exposing web services
In order to expose a web service using this component you first need to
set-up a
@@ -459,9 +437,7 @@ comes in). Also don't forget to check out the
link:spring-ws-example.html[Spring Web Services Example] included in the
Camel distribution.
-[[SpringWebServices-Endpointmappinginroutes]]
-Endpoint mapping in routes
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Endpoint mapping in routes
With the XML configuration in-place you can now use Camel's DSL to
define what web service requests are handled by your endpoint:
@@ -503,9 +479,7 @@ from("spring-ws:xpathresult:abc?expression=//foobar&endpointMapping=#endpointMap
.convertBodyTo(String.class).to(mock:example)
--------------------------------------------------------------------------------------
-[[SpringWebServices-Alternativeconfiguration,usingexistingendpointmappings]]
-Alternative configuration, using existing endpoint mappings
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Alternative configuration, using existing endpoint mappings
For every endpoint with mapping-type `beanname` one bean of type
`CamelEndpointDispatcher` with a corresponding name is required in the
@@ -548,9 +522,7 @@ An example of a route using `beanname`:
<bean id="FutureEndpointDispatcher" class="org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher" />
------------------------------------------------------------------------------------------------------------------------
-[[SpringWebServices-POJO-unmarshalling]]
-POJO (un)marshalling
-~~~~~~~~~~~~~~~~~~~~
+### POJO (un)marshalling
Camel's link:data-format.html[pluggable data formats] offer support for
pojo/xml marshalling using libraries such as JAXB, XStream, JibX, Castor
@@ -577,12 +549,9 @@ from("spring-ws:rootqname:{http://example.com/}GetFoo?endpointMapping=#endpointM
.to("mock:example").marshal(jaxb);
--------------------------------------------------------------------------------------------------------
-[[SpringWebServices-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-spring/src/main/docs/spel-language.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/docs/spel-language.adoc b/components/camel-spring/src/main/docs/spel-language.adoc
index 8efff63..3020b22 100644
--- a/components/camel-spring/src/main/docs/spel-language.adoc
+++ b/components/camel-spring/src/main/docs/spel-language.adoc
@@ -1,4 +1,4 @@
-# SpEL Language
+## SpEL Language
*Available as of Camel 2.7*
@@ -8,9 +8,7 @@ to be used as an link:expression.html[Expression] or
link:predicate.html[Predicate] in the link:dsl.html[DSL] or
link:xml-configuration.html[Xml Configuration].
-[[SpEL-Variables]]
-Variables
-^^^^^^^^^
+### Variables
The following variables are available in expressions and predicates
written in SpEL:
@@ -42,9 +40,7 @@ written in SpEL:
|property(name, type) |Type |the property by the given name as the given type
|=======================================================================
-[[SpEL-Options]]
-Options
-^^^^^^^
+### Options
// language options: START
The SpEL language supports 1 options which are listed below.
@@ -60,13 +56,9 @@ The SpEL language supports 1 options which are listed below.
{% endraw %}
// language options: END
-[[SpEL-Samples]]
-Samples
-^^^^^^^
+### Samples
-[[SpEL-Expressiontemplating]]
-Expression templating
-+++++++++++++++++++++
+#### Expression templating
SpEL expressions need to be surrounded by `#{` `}` delimiters since
expression templating is enabled. This allows you to combine SpEL
@@ -106,9 +98,7 @@ template.sendBodyAndHeader("direct:example", "World", "dayOrNight", "day");
The output on `mock:result` will be _"Hello World! What a beautiful
day"_
-[[SpEL-Beanintegration]]
-Bean integration
-++++++++++++++++
+#### Bean integration
You can reference beans defined in the link:registry.html[Registry]
(most likely an `ApplicationContext`) in your SpEL expressions. For
@@ -120,9 +110,7 @@ can invoke the "bar" method on this bean like this:
#{@foo.bar == 'xyz'}
--------------------
-[[SpEL-SpELinenterpriseintegrationpatterns]]
-SpEL in enterprise integration patterns
-+++++++++++++++++++++++++++++++++++++++
+#### SpEL in enterprise integration patterns
You can use SpEL as an expression for link:recipient-list.html[Recipient
List] or as a predicate inside a link:message-filter.html[Message
@@ -146,9 +134,7 @@ And the equivalent in Java DSL:
from("direct:foo").filter().spel("#{request.headers['foo'] == 'bar'}").to("direct:bar");
-------------------------------------------------------------------------------------------
-[[SpEL-Loadingscriptfromexternalresource]]
-Loading script from external resource
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Loading script from external resource
*Available as of Camel 2.11*
@@ -162,9 +148,7 @@ eg to refer to a file on the classpath you can do:
.setHeader("myHeader").spel("resource:classpath:myspel.txt")
------------------------------------------------------------
-[[SpEL-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
You need Spring 3.0 or higher to use Spring Expression Language. If you
use Maven you could just add the following to your `pom.xml`:
@@ -177,4 +161,4 @@ use Maven you could just add the following to your `pom.xml`:
<version>xxx</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-spring/src/main/docs/spring-event-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc
index 1de4c1d..0a8c65a 100644
--- a/components/camel-spring/src/main/docs/spring-event-component.adoc
+++ b/components/camel-spring/src/main/docs/spring-event-component.adoc
@@ -1,4 +1,4 @@
-# Spring Event Component
+## Spring Event Component
The *spring-event:* component provides access to the Spring
`ApplicationEvent` objects. This allows you to publish
@@ -8,9 +8,7 @@ link:enterprise-integration-patterns.html[Enterprise Integration
Patterns] to process them such as link:message-filter.html[Message
Filter].
-[[SpringEvent-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------
@@ -20,9 +18,7 @@ spring-event://default[?options]
Note, at the moment there are no options for this component. That can
easily change in future releases, so please check back.
-[[Spring-Event-Options]]
-Spring Event Options
-^^^^^^^^^^^^^^^^^^^^
+### Spring Event Options
@@ -60,12 +56,9 @@ The Spring Event component supports 5 endpoint options which are listed below:
// endpoint options: END
-[[SpringEvent-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-sql/src/main/docs/sql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc
index ee3c325..6bef6d2 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -1,4 +1,4 @@
-# SQL Component
+## SQL Component
The *sql:* component allows you to work with databases using JDBC
queries. The difference between this component and link:jdbc.html[JDBC]
@@ -29,9 +29,7 @@ further below.
* a JDBC based repository for the link:aggregator2.html[Aggregator] EIP
pattern. See further below.
-[[SQLComponent-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
WARNING:From Camel 2.11 onwards this component can create both consumer (e.g.
`from()`) and producer endpoints (e.g. `to()`).
@@ -102,9 +100,7 @@ also use comments such as the�\u2013 dash line.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[SQLComponent-Options]]
-Options
-^^^^^^^
+### Options
@@ -184,9 +180,7 @@ The SQL component supports 46 endpoint options which are listed below:
// endpoint options: END
-[[SQLComponent-Treatmentofthemessagebody]]
-Treatment of the message body
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Treatment of the message body
The SQL component tries to convert the message body to an object of
`java.util.Iterator` type and then uses this iterator to fill the query
@@ -211,9 +205,7 @@ parameters must be provided in a header with the
key�SqlConstants.SQL_PARAMETERS. This allows the SQL component to work
more dynamic as the SQL query is from the message body.
-[[SQLComponent-Resultofthequery]]
-Result of the query
-^^^^^^^^^^^^^^^^^^^
+### Result of the query
For `select` operations, the result is an instance of
`List<Map<String, Object>>` type, as returned by the
@@ -235,9 +227,7 @@ from("jms:order.inbox")
.to("jms:order.booking");
-------------------------------------------------------------------------------------------
-[[SQLComponent-UsingStreamList]]
-Using StreamList
-^^^^^^^^^^^^^^^^
+### Using StreamList
From*Camel 2.18* onwards the producer supports outputType=StreamList
that uses an iterator to stream the output of the query. This allows to
@@ -258,9 +248,7 @@ from("direct:withSplitModel")
�
-[[SQLComponent-Headervalues]]
-Header values
-^^^^^^^^^^^^^
+### Header values
When performing `update` operations, the SQL Component stores the update
count in the following message headers:
@@ -295,9 +283,7 @@ message headers (*Available as of Camel 2.12.4, 2.13.1*):
|CamelSqlGeneratedKeyRows |Rows that contains the generated keys (a list of maps of keys).
|=======================================================================
-[[SQLComponent-Generatedkeys]]
-Generated keys
-^^^^^^^^^^^^^^
+### Generated keys
*Available as of Camel 2.12.4, 2.13.1 and 2.14 *
@@ -312,9 +298,7 @@ You can see more details in this
https://git-wip-us.apache.org/repos/asf?p=camel.git;a=blob_plain;f=components/camel-sql/src/test/java/org/apache/camel/component/sql/SqlGeneratedKeysTest.java;hb=3962b23f94bb4bc23011b931add08c3f6833c82e[unit
test].
-[[SQLComponent-Configuration]]
-Configuration
-^^^^^^^^^^^^^
+### Configuration
You can now set a reference to a `DataSource` in the URI directly:
@@ -323,9 +307,7 @@ You can now set a reference to a `DataSource` in the URI directly:
sql:select * from table where id=# order by name?dataSource=myDS
----------------------------------------------------------------
-[[SQLComponent-Sample]]
-Sample
-^^^^^^
+### Sample
In the sample below we execute a query and retrieve the result as a
`List` of rows, where each row is a `Map<String, Object` and the key is
@@ -354,9 +336,7 @@ We could configure the `DataSource` in Spring XML as follows:
<jee:jndi-lookup id="myDS" jndi-name="jdbc/myDataSource"/>
-----------------------------------------------------------
-[[SQLComponent-Usingnamedparameters]]
-Using named parameters
-++++++++++++++++++++++
+#### Using named parameters
*Available as of Camel 2.11*
@@ -385,9 +365,7 @@ parameters will be taken from the body.
.to("sql:select * from projects where license = :#lic and id > :#min order by id")
---------------------------------------------------------------------------------------
-[[SQLComponent-Usingexpressionparameters]]
-Using expression parameters
-+++++++++++++++++++++++++++
+#### Using expression parameters
*Available as of Camel 2.14*
@@ -403,9 +381,7 @@ from("direct:projects")
.to("sql:select * from projects where license = :#${body} and id > :#${property.min} order by id")
----------------------------------------------------------------------------------------------------
-[[SQLComponent-UsingINquerieswithdynamicvalues]]
-Using IN queries with dynamic values
-++++++++++++++++++++++++++++++++++++
+#### Using IN queries with dynamic values
*Available as of Camel 2.17*
@@ -474,9 +450,7 @@ from("direct:query")
�
-[[SQLComponent-UsingtheJDBCbasedidempotentrepository]]
-Using the JDBC based idempotent repository
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### Using the JDBC based idempotent repository
*Available as of Camel 2.7*: In this section we will use the JDBC based
idempotent repository.
@@ -751,9 +725,7 @@ class="org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExc
-------------------------------------------------------------------------------
�
-[[SQLComponent-SeeAlso]]
-See Also
-^^^^^^^^
+### See Also
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
@@ -762,4 +734,4 @@ See Also
link:sql-stored-procedure.html[SQL Stored Procedure]
-link:jdbc.html[JDBC]
+link:jdbc.html[JDBC]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-sql/src/main/docs/sql-stored-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc
index 2a2d174..6145378 100644
--- a/components/camel-sql/src/main/docs/sql-stored-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc
@@ -1,4 +1,4 @@
-# SQL StoredProcedure Component
+## SQL StoredProcedure Component
*Available as of Camel 2.17*
@@ -23,9 +23,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SQLStoredProcedure-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
The SQL component uses the following endpoint URI notation:
@@ -60,9 +58,7 @@ SUBNUMBERS(
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[SQLStoredProcedure-Options]]
-Options
-^^^^^^^
+### Options
@@ -102,9 +98,7 @@ The SQL StoredProcedure component supports 7 endpoint options which are listed b
// endpoint options: END
-[[SQLStoredProcedure-Declaringthestoredproceduretemplate]]
-Declaring the stored procedure template
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Declaring the stored procedure template
The template is declared using a syntax that would be similar to a Java
method signature. The name of the stored procedure, and then the
@@ -127,14 +121,11 @@ In SQL term the stored procedure could be declared as:
CREATE PROCEDURE SUBNUMBERS(VALUE1 INTEGER, VALUE2 INTEGER,OUT RESULT INTEGER)
------------------------------------------------------------------------------
-[[SQLStoredProcedure-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-component.html[SQL Component]
-
+* link:sql-component.html[SQL Component]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ssh/src/main/docs/ssh-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index 5eaaf98..542616e 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -1,4 +1,4 @@
-# SSH Component
+## SSH Component
*Available as of Camel 2.10*
@@ -18,18 +18,14 @@ for this component:
</dependency>
------------------------------------------------------------
-[[SSH-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-----------------------------------------------
ssh:[username[:password]@]host[:port][?options]
-----------------------------------------------
-[[SSH-Options]]
-Options
-^^^^^^^
+### Options
@@ -100,9 +96,7 @@ The SSH component supports 28 endpoint options which are listed below:
// endpoint options: END
-[[SSH-UsageasaProducerendpoint]]
-Usage as a Producer endpoint
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Usage as a Producer endpoint
When the SSH Component is used as a Producer (`.to("ssh://...")`), it
will send the message body as the command to execute on the remote SSH
@@ -123,9 +117,7 @@ an XML encoded newline (` `).
</route>
----------------------------------------------
-[[SSH-Authentication]]
-Authentication
-^^^^^^^^^^^^^^
+### Authentication
The SSH Component can authenticate against the remote SSH server using
one of two mechanisms: Public Key certificate or username/password.
@@ -192,19 +184,14 @@ of Camel you are using.
</dependency>
-----------------------------------------
-[[SSH-Example]]
-Example
-^^^^^^^
+### Example
See the `examples/camel-example-ssh` and
`examples/camel-example-ssh-security` in the Camel distribution.
-[[SSH-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-stax/src/main/docs/stax-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc
index d56cc01..d4c5070 100644
--- a/components/camel-stax/src/main/docs/stax-component.adoc
+++ b/components/camel-stax/src/main/docs/stax-component.adoc
@@ -1,4 +1,4 @@
-# StAX Component
+## StAX Component
*Available as of Camel 2.9*
@@ -21,9 +21,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[StAX-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------
@@ -46,9 +44,7 @@ using the # syntax as shown:
stax:#myHandler
---------------
-[[Stax-Options]]
-Options
-~~~~~~~
+### Options
// component options: START
@@ -71,9 +67,7 @@ The StAX component supports 2 endpoint options which are listed below:
// endpoint options: END
-[[StAX-UsageofacontenthandlerasStAXparser]]
-Usage of a content handler as StAX parser
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Usage of a content handler as StAX parser
The message body after the handling is the handler itself.
@@ -93,9 +87,7 @@ from("file:target/in")
});
--------------------------------------------------------------------------------------------------------
-[[StAX-IterateoveracollectionusingJAXBandStAX]]
-Iterate over a collection using JAXB and StAX
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+### Iterate over a collection using JAXB and StAX
First we suppose you have JAXB objects.
@@ -199,18 +191,13 @@ from("file:target/in")
.to("mock:records");
-------------------------------------------------
-[[StAX-ThepreviousexamplewithXMLDSL]]
-The previous example with XML DSL
-+++++++++++++++++++++++++++++++++
+#### The previous example with XML DSL
The example above could be implemented as follows in XML DSL
-[[StAX-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-stomp/src/main/docs/stomp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc
index 41dc26d..3c9d48c 100644
--- a/components/camel-stomp/src/main/docs/stomp-component.adoc
+++ b/components/camel-stomp/src/main/docs/stomp-component.adoc
@@ -1,4 +1,4 @@
-# Stomp Component
+## Stomp Component
*Available as of Camel 2.12*
@@ -20,9 +20,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Stomp-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
---------------------------------
@@ -31,9 +29,7 @@ stomp:queue:destination[?options]
Where *destination* is the name of the queue.
-[[Stomp-Options]]
-Options
-^^^^^^^
+### Options
@@ -85,9 +81,7 @@ The Stomp component supports 10 endpoint options which are listed below:
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Stomp-Samples]]
-Samples
-^^^^^^^
+### Samples
Sending messages:
@@ -103,9 +97,7 @@ Consuming messages:
from("stomp:queue:test").transform(body().convertToString()).to("mock:result")
------------------------------------------------------------------------------
-[[Stomp-Endpoints]]
-Endpoints
-~~~~~~~~~
+### Endpoints
Camel supports the link:message-endpoint.html[Message Endpoint] pattern
using the
@@ -134,12 +126,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]
-[[Stomp-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-stream/src/main/docs/stream-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc
index 8655e51..cf8f3d5 100644
--- a/components/camel-stream/src/main/docs/stream-component.adoc
+++ b/components/camel-stream/src/main/docs/stream-component.adoc
@@ -1,4 +1,4 @@
-# Stream Component
+## Stream Component
The *stream:* component provides access to the `System.in`, `System.out`
and `System.err` streams as well as allowing streaming of file and URL.
@@ -16,9 +16,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Stream-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
-----------------------
@@ -43,9 +41,7 @@ producers (that is, it cannot appear in `from()`).
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Stream-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -85,9 +81,7 @@ The Stream component supports 19 endpoint options which are listed below:
// endpoint options: END
-[[Stream-Messagecontent]]
-Message content
-^^^^^^^^^^^^^^^
+### Message content
The *stream:* component supports either `String` or `byte[]` for writing
to streams. Just add either `String` or `byte[]` content to the
@@ -100,9 +94,7 @@ add a `java.io.OutputStream` object to `message.in.header` in the key
`header`. +
See samples for an example.
-[[Stream-Samples]]
-Samples
-^^^^^^^
+### Samples
In the following sample we route messages from the `direct:in` endpoint
to the `System.out` stream:
@@ -138,12 +130,9 @@ file will be re-opened and scanned with each iteration of
scanStreamDelay. Until NIO2 is available we cannot reliably detect when
a file is deleted/recreated.
-[[Stream-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-stringtemplate/src/main/docs/string-template-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
index 1c63368..8fe61b3 100644
--- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
+++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
@@ -1,4 +1,4 @@
-# String Template Component
+## String Template Component
The *string-template:* component allows you to process a message using a
http://www.stringtemplate.org/[String Template]. This can be ideal when
@@ -18,9 +18,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[StringTemplate-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
--------------------------------------
@@ -33,9 +31,7 @@ invoke; or the complete URL of the remote template.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[StringTemplate-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
@@ -61,26 +57,20 @@ The String Template component supports 5 endpoint options which are listed below
// endpoint options: END
-[[StringTemplate-Headers]]
-Headers
-^^^^^^^
+### Headers
Camel will store a reference to the resource in the message header with
key, `org.apache.camel.stringtemplate.resource`. The Resource is an
`org.springframework.core.io.Resource` object.
-[[StringTemplate-Hotreloading]]
-Hot reloading
-^^^^^^^^^^^^^
+### Hot reloading
The string template resource is by default hot-reloadable for both file
and classpath resources (expanded jar). If you set `contentCache=true`,
Camel loads the resource only once and hot-reloading is not possible.
This scenario can be used in production when the resource never changes.
-[[StringTemplate-StringTemplateAttributes]]
-StringTemplate Attributes
-^^^^^^^^^^^^^^^^^^^^^^^^^
+### StringTemplate Attributes
Since Camel 2.14, you can define the custom context map by setting the
message header "*CamelStringTemplateVariableMap*" just like the below
@@ -97,9 +87,7 @@ variableMap.put("exchange", exchange);
exchange.getIn().setHeader("CamelStringTemplateVariableMap", variableMap);
--------------------------------------------------------------------------
-[[StringTemplate-Samples]]
-Samples
-^^^^^^^
+### Samples
For example you could use a string template as follows in order to
formulate a response to a message:
@@ -110,9 +98,7 @@ from("activemq:My.Queue").
to("string-template:com/acme/MyResponse.tm");
-----------------------------------------------
-[[StringTemplate-TheEmailSample]]
-The Email Sample
-^^^^^^^^^^^^^^^^
+### The Email Sample
In this sample we want to use a string template to send an order
confirmation email. The email template is laid out in `StringTemplate`
@@ -131,12 +117,9 @@ Regards Camel Riders Bookstore
And the java code is as follows:
-[[StringTemplate-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-syslog/src/main/docs/syslog-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc
index 8c985d7..c09d2ff 100644
--- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc
+++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc
@@ -1,4 +1,4 @@
-# Syslog DataFormat
+## Syslog DataFormat
*Available as of Camel 2.6*
@@ -31,9 +31,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Syslog-RFC3164Syslogprotocol]]
-RFC3164 Syslog protocol
-^^^^^^^^^^^^^^^^^^^^^^^
+### RFC3164 Syslog protocol
Syslog uses the user datagram protocol (UDP)
https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=1&linkCreation=true&fromPageId=24185759[1]
@@ -46,9 +44,7 @@ where we just use the `Rfc3164SyslogDataFormat` to marshal and unmarshal
messages. Notice that from�*Camel 2.14* onwards the syslog dataformat is
renamed to `SyslogDataFormat`.
-[[Syslog-Dataformat-Options]]
-Options
-^^^^^^^
+### Options
// dataformat options: START
The Syslog dataformat supports 1 options which are listed below.
@@ -64,9 +60,7 @@ The Syslog dataformat supports 1 options which are listed below.
{% endraw %}
// dataformat options: END
-[[Syslog-RFC5424Syslogprotocol]]
-RFC5424 Syslog protocol
-^^^^^^^^^^^^^^^^^^^^^^^
+### RFC5424 Syslog protocol
*Available as of Camel 2.14*
@@ -75,9 +69,7 @@ existing�link:mina.html[camel-mina]�component
or�link:netty.html[camel-netty]�where we just use
the�`SyslogDataFormat`�to marshal and unmarshal messages
-[[Syslog-ExposingaSysloglistener]]
-Exposing a Syslog listener
-++++++++++++++++++++++++++
+#### Exposing a Syslog listener
In our Spring XML file, we configure an endpoint to listen for udp
messages on port 10514, note that in netty we disable the defaultCodec,
@@ -121,9 +113,7 @@ The same route using link:mina.html[camel-mina]
</camelContext>
-------------------------------------------------------------------------
-[[Syslog-Sendingsyslogmessagestoaremotedestination]]
-Sending syslog messages to a remote destination
-+++++++++++++++++++++++++++++++++++++++++++++++
+#### Sending syslog messages to a remote destination
[source,xml]
-------------------------------------------------------------------------
@@ -142,12 +132,9 @@ Sending syslog messages to a remote destination
</camelContext>
-------------------------------------------------------------------------
-[[Syslog-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-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc
index d9a0c3e..999e675 100644
--- a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc
+++ b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc
@@ -1,4 +1,4 @@
-# TidyMarkup DataFormat
+## TidyMarkup DataFormat
TidyMarkup is a link:data-format.html[Data Format] that uses the
http://www.ccil.org/~cowan/XML/tagsoup/[TagSoup] to tidy up HTML. It can
@@ -15,9 +15,7 @@ link:tidymarkup.html[TidyMarkup] only supports the *unmarshal* operation
as we really don't want to turn well formed HTML into ugly HTML
image:https://cwiki.apache.org/confluence/s/en_GB/5982/f2b47fb3d636c8bc9fd0b11c0ec6d0ae18646be7.1/_/images/icons/emoticons/smile.png[(smile)]
-[[TidyMarkup-Options]]
-TidyMarkup Options
-^^^^^^^^^^^^^^^
+### TidyMarkup Options
@@ -40,9 +38,7 @@ The TidyMarkup dataformat supports 3 options which are listed below.
-[[TidyMarkup-JavaDSLExample]]
-Java DSL Example
-^^^^^^^^^^^^^^^^
+### Java DSL Example
An example where the consumer provides some HTML
@@ -51,9 +47,7 @@ An example where the consumer provides some HTML
from("file://site/inbox").unmarshal().tidyMarkup().to("file://site/blogs");
---------------------------------------------------------------------------
-[[TidyMarkup-SpringXMLExample]]
-Spring XML Example
-^^^^^^^^^^^^^^^^^^
+### Spring XML Example
The following example shows how to use link:tidymarkup.html[TidyMarkup]
to unmarshal using Spring
@@ -71,9 +65,7 @@ to unmarshal using Spring
</camelContext>
-----------------------------------------------------------------------
-[[TidyMarkup-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use TidyMarkup in your camel routes you need to add the a dependency
on *camel-tagsoup* which implements this data format.
@@ -89,4 +81,4 @@ link:download.html[the download page for the latest versions]).
<artifactId>camel-tagsoup</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-tarfile/src/main/docs/tarfile-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc
index 0aa9699..92c1997 100644
--- a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc
+++ b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc
@@ -1,4 +1,4 @@
-# Tar File DataFormat
+## Tar File DataFormat
TIP:*Available since Camel 2.18.0*
@@ -10,9 +10,7 @@ entry can be unmarshalled (decompressed) to the original file contents.
There is also a aggregation strategy that can
aggregate multiple messages into a single Tar File.
-[[TarFile-Options]]
-TarFile Options
-^^^^^^^^^^^^^^^
+### TarFile Options
// dataformat options: START
@@ -31,9 +29,7 @@ The Tar File dataformat supports 2 options which are listed below.
// dataformat options: END
-[[TarFileDataFormat-Marshal]]
-Marshal
-^^^^^^^
+### Marshal
In this example we marshal a regular text/XML payload to a compressed
payload using Tar File compression, and send it to an ActiveMQ queue
@@ -74,9 +70,7 @@ from("direct:start").setHeader(Exchange.FILE_NAME, constant("report.txt")).marsh
This route would result in a Tar File named "report.txt.tar" in the
output directory, containing a single Tar entry named "report.txt".
-[[TarFileDataFormat-Unmarshal]]
-Unmarshal
-^^^^^^^^^
+### Unmarshal
In this example we unmarshal a Tar File payload from an ActiveMQ queue
called MY_QUEUE to its original format, and forward it for processing to
@@ -116,9 +110,7 @@ like this
----------------------------------------------------------------------------------------------------
-[[TarFileDataFormat-Aggregate]]
-Aggregate
-^^^^^^^^^
+### Aggregate
INFO:Please note that this aggregation strategy requires eager completion
check to work properly.
@@ -152,9 +144,7 @@ the�`CamelFileName`�header explicitly in your route:
.to("file:output/directory");
------------------------------------------------------------
-[[TarFileDataFormat-Dependencies]]
-Dependencies
-^^^^^^^^^^^^
+### Dependencies
To use Tar Files in your camel routes you need to add a dependency on
*camel-tarfile* which implements this data format.
@@ -171,4 +161,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-telegram/src/main/docs/telegram-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc
index 625c579..b9bbb42 100644
--- a/components/camel-telegram/src/main/docs/telegram-component.adoc
+++ b/components/camel-telegram/src/main/docs/telegram-component.adoc
@@ -1,4 +1,4 @@
-# Telegram Component
+## Telegram Component
*Available as of Camel 2.18*
@@ -30,9 +30,7 @@ for this component:
</dependency>
------------------------------------------------------------
-[[Telegram-URIformat]]
-URI format
-^^^^^^^^^^
+### URI format
[source,java]
----------------------------------------------------
@@ -42,9 +40,7 @@ telegram:type/authorizationToken[?options]
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-[[Telegram-Options]]
-Options
-^^^^^^^
+### Options
// component options: START
The Telegram component supports 1 options which are listed below.
@@ -100,9 +96,7 @@ The Telegram component supports 24 endpoint options which are listed below:
-[[Telegram-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
+### Message Headers
[width="100%",cols="20%,80%",options="header",]
|=======================================================================
@@ -122,16 +116,12 @@ for outgoing binary messages.
|=======================================================================
-[[Telegram-Usage]]
-Usage
-^^^^^
+### Usage
The Telegram component supports both consumer and producer endpoints.
It can also be used in *reactive chat-bot mode* (to consume, then produce messages).
-[[Telegram-ProducerExample]]
-Producer Example
-^^^^^^^^^^^^^^^^
+### Producer Example
The following is a basic example of how to send a message to a Telegram chat through the
Telegram Bot API.
@@ -172,9 +162,7 @@ The following message bodies are allowed for a producer endpoint (messages of ty
|===================================================
-[[Telegram-ConsumerExample]]
-Consumer Example
-^^^^^^^^^^^^^^^^
+### Consumer Example
The following is a basic example of how to receive all messages that telegram users are sending to the configured Bot.
In Java DSL
@@ -227,9 +215,7 @@ Supported types for incoming messages are
-[[Telegram-ReactiveChatBot]]
-Reactive Chat-Bot Example
-^^^^^^^^^^^^^^^^^^^^^^^^^
+### Reactive Chat-Bot Example
The reactive chat-bot mode is a simple way of using the Camel component to build a simple
chat bot that replies directly to chat messages received from the Telegram users.
@@ -278,9 +264,7 @@ public class ChatBotLogic {
Every non-null string returned by the `chatBotProcess` method is automatically routed to the
chat that originated the request (as the `CamelTelegramChatId` header is used to route the message).
-[[Telegram-GettingTheChatId]]
-Getting the Chat ID
-^^^^^^^^^^^^^^^^^^^
+### Getting the Chat ID
If you want to push messages to a specific Telegram chat when an event occurs, you need to
retrieve the corresponding chat ID. The chat ID is not currently shown in the telegram client,
@@ -306,4 +290,4 @@ from("timer:tick")
to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L?chatId=123456")
---------------------------------------------------------
-Note that the corresponding URI parameter is simply `chatId`.
+Note that the corresponding URI parameter is simply `chatId`.
\ No newline at end of file